Class
TelerikSignature

Telerik UI Signature component.

Definition

Namespace:Telerik.Blazor.Components

Assembly:Telerik.Blazor.dll

Syntax:

cs-api-definition

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

Inheritance: objectComponentBaseBaseComponentDataVizComponentTelerikSignature

Implements: IComponentIDisposableIHandleAfterRenderIHandleEvent

Inherited Members BaseComponent.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.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.OnInitialized()ComponentBase.OnParametersSetAsync()ComponentBase.OnAfterRender(bool)ComponentBase.InvokeAsync(Action)ComponentBase.InvokeAsync(Func<Task>)

Constructors

TelerikSignature()

Declaration

cs-api-definition

public TelerikSignature()

Properties

AriaDescribedBy

Defines the aria-describedby attribute for the component.

Declaration

cs-api-definition

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

Property Value

string

AriaLabel

Defines the aria-label attribute of the component.

Declaration

cs-api-definition

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

Property Value

string

AriaLabelledBy

Describe the aria-labelledby attribute for the component.

Declaration

cs-api-definition

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

Property Value

string

BackgroundColor

Gets or sets the background color of the signature.

Declaration

cs-api-definition

[Parameter]
public string BackgroundColor { get; set; }

Property Value

string

CascadedEditContext

Declaration

cs-api-definition

[CascadingParameter]
public EditContext CascadedEditContext { get; set; }

Property Value

EditContext

Color

The stroke color of the signature.

Declaration

cs-api-definition

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

Property Value

string

DebounceDelay

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

Declaration

cs-api-definition

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

Property Value

int

Enabled

Specifies if the component is enabled.

Declaration

cs-api-definition

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

Property Value

bool

ExportScale

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.

Declaration

cs-api-definition

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

Property Value

double?

FillMode

Specifies the fill mode.

Declaration

cs-api-definition

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

Property Value

string

HideLine

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

Declaration

cs-api-definition

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

Property Value

bool?

Maximizable

A value indicating whether the component can be maximized.

Declaration

cs-api-definition

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

Property Value

bool?

OnBlur

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

Declaration

cs-api-definition

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

Property Value

EventCallback

OnChange

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

Declaration

cs-api-definition

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

Property Value

EventCallback<string>

PopupScale

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

Declaration

cs-api-definition

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

Property Value

double?

ReadOnly

Specifies if the component is read-only.

Declaration

cs-api-definition

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

Property Value

bool

Rounded

Specifies the roundness.

Declaration

cs-api-definition

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

Property Value

string

Size

Specifies the size.

Declaration

cs-api-definition

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

Property Value

string

Smooth

A value indicating whether to smoothen out the signature lines.

Declaration

cs-api-definition

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

Property Value

bool?

StrokeWidth

Defines how wide will the stroke be.

Declaration

cs-api-definition

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

Property Value

double?

TabIndex

The TabIndex of the component.

Declaration

cs-api-definition

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

Property Value

int?

ValidateOn

Defines the event which specifies when validation is triggered.

Declaration

cs-api-definition

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

Property Value

ValidationEvent

Value

A string value representing a Base64-encoded PNG image.

Declaration

cs-api-definition

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

Property Value

string

ValueChanged

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

Declaration

cs-api-definition

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

Property Value

EventCallback<string>

ValueExpression

Specifies the expression that identifies the bound value.

Declaration

cs-api-definition

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

Property Value

Expression<Func<string>>

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

cs-api-definition

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

__builder

RenderTreeBuilder

Overrides ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose()

Declaration

cs-api-definition

public override void Dispose()

Overrides DataVizComponent.Dispose()

FocusAsync()

Moves focus to the component.

Declaration

cs-api-definition

public Task FocusAsync()

Returns

Task

OnParametersSet()

Declaration

cs-api-definition

protected override void OnParametersSet()

Overrides DataVizComponent.OnParametersSet()

Refresh()

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

Declaration

cs-api-definition

public override void Refresh()

Overrides DataVizComponent.Refresh()

SetParametersAsync(ParameterView)

Declaration

cs-api-definition

public override Task SetParametersAsync(ParameterView parameters)

Parameters

parameters

ParameterView

Returns

Task

Overrides ComponentBase.SetParametersAsync(ParameterView)

ClassTelerikSignature

Class
TelerikSignature