New to Telerik UI for BlazorStart a free 30-day trial

A component that lets users draw a signature and capture it as a Base64 PNG string. Supports two-way binding via Value/ValueChanged with ValueExpression for validation, debounce with DebounceDelay, clear/maximize dialog, read-only/disabled states, ARIA labeling, and change/blur events through OnChange and OnBlur.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

C#
public class TelerikSignature : DataVizComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Inheritance: objectComponentBaseBaseComponentDataVizComponentTelerikSignature

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members DataVizComponent.OnInitialized()DataVizComponent.OnAfterRender(bool)DataVizComponent.ChildContentDataVizComponent.WidthDataVizComponent.HeightBaseComponent.ShouldRender()BaseComponent.OnInitializedAsync()BaseComponent.OnAfterRenderAsync(bool)BaseComponent.InitLocalizer()BaseComponent.ThrowIfParameterIsNull(object, string)BaseComponent.HaveOptionsChanged(IDictionary<string, object>, IDictionary<string, object>)BaseComponent.GetClassString(params string[])BaseComponent.InvokeAsync<T>(string, params object[])BaseComponent.InvokeAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidAsync(string, params object[])BaseComponent.InvokeVoidAsyncWithoutAwait(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, params object[])BaseComponent.InvokeComponentMethodAsync<T>(string, CancellationToken, params object[])BaseComponent.InvokeVoidComponentMethodAsync(string, params object[])BaseComponent.InvokeComponentVoidMethodAsync(string, object)BaseComponent.InvokeDisposeAsync()BaseComponent.StateHasChanged()BaseComponent.RootComponentBaseComponent.ClassComponentBase.OnParametersSetAsync()ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)ComponentBase.DispatchExceptionAsync(Exception)...

Constructors

C#
public TelerikSignature()

Methods

C#
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters:__builderRenderTreeBuilder

Overrides: ComponentBase.BuildRenderTree(RenderTreeBuilder)

C#
public override void Dispose()

Overrides: DataVizComponent.Dispose()

Moves focus to the component.

C#
public Task FocusAsync()
Returns:

Task

C#
protected override void OnParametersSet()

Overrides: DataVizComponent.OnParametersSet()

Re-renders the component with latest changes (if any).

C#
public override void Refresh()

Overrides: DataVizComponent.Refresh()

C#
public override Task SetParametersAsync(ParameterView parameters)
Parameters:parametersParameterViewReturns:

Task

Overrides: ComponentBase.SetParametersAsync(ParameterView)

Properties

[Accessibility] Defines the aria-describedby attribute for the component.

C#
[Parameter]
public string AriaDescribedBy { get; set; }

[Accessibility] Defines the aria-label attribute of the component.

C#
[Parameter]
public string AriaLabel { get; set; }

[Accessibility] Describe the aria-labelledby attribute for the component.

C#
[Parameter]
public string AriaLabelledBy { get; set; }

Gets or sets the background color of the signature.

C#
[Parameter]
public string BackgroundColor { get; set; }
C#
[CascadingParameter]
public EditContext CascadedEditContext { get; set; }

The stroke color of the signature.

C#
[Parameter]
public string Color { get; set; }

Time in ms between the last drawn symbol and the triggering of the ValueChanged event.

C#
[Parameter]
public int DebounceDelay { get; set; }

[Accessibility] Specifies if the component is enabled.

C#
[Parameter]
public bool Enabled { get; set; }

The scale factor for the exported image. The Signature width and height will be multiplied by the scale when converting the signature to an image.

C#
[Parameter]
public double? ExportScale { get; set; }

Specifies the fill mode.

C#
[Parameter]
public string FillMode { get; set; }

A value indicating whether the dotted line should be displayed in the background.

C#
[Parameter]
public bool? HideLine { get; set; }

A value indicating whether the component can be maximized.

C#
[Parameter]
public bool? Maximizable { get; set; }

Specifies the callback that's called when the Component loses focus.

C#
[Parameter]
public EventCallback OnBlur { get; set; }

Specifies the callback that's called when the Enter key is pressed.

C#
[Parameter]
public EventCallback<string> OnChange { get; set; }

Defines a value indicating the scaling size of the popup signature pad.

C#
[Parameter]
public double? PopupScale { get; set; }

[Accessibility] Specifies if the component is read-only.

C#
[Parameter]
public bool ReadOnly { get; set; }

Specifies the roundness.

C#
[Parameter]
public string Rounded { get; set; }

Specifies the size.

C#
[Parameter]
public string Size { get; set; }

A value indicating whether to smoothen out the signature lines.

C#
[Parameter]
public bool? Smooth { get; set; }

Defines how wide will the stroke be.

C#
[Parameter]
public double? StrokeWidth { get; set; }

[Accessibility] The TabIndex of the component.

C#
[Parameter]
public int? TabIndex { get; set; }

Defines the event which specifies when validation is triggered.

C#
[Parameter]
public ValidationEvent ValidateOn { get; set; }

A string value representing a Base64-encoded PNG image.

C#
[Parameter]
public string Value { get; set; }

Specifies the handler of the event when the value is changed.

C#
[Parameter]
public EventCallback<string> ValueChanged { get; set; }

Specifies the expression that identifies the bound value.

C#
[Parameter]
public Expression<Func<string>> ValueExpression { get; set; }