Class Signature

Inheritance

System.Object

Syncfusion.EJ2.EJTagHelper

Signature

Namespace: Syncfusion.EJ2.Inputs

Assembly: Syncfusion.EJ2.dll

Syntax

public class Signature : EJTagHelper

Constructors

Signature()

Declaration

public Signature()

Properties

BackgroundColor

Gets or sets the background color of the component. The background color of the component that accepts hex value, rgb and text (like 'red'). The default value is ''.

Declaration

public string BackgroundColor { get; set; }

Property Value

Type	Description
System.String	The default value is ""

BackgroundImage

Gets or sets the background image for the component. An image that used to fill the background of the component. The default value is ''.

Declaration

public string BackgroundImage { get; set; }

Property Value

Type	Description
System.String	The default value is ""

BeforeSave

Gets or sets an event callback that is raised while saving the signature. The file name and the file type can be changed using SignatureBeforeSaveEventArgs and SignatureFileType. The event callback is raised only for the keyboard action (Ctrl + S).

Declaration

public string BeforeSave { get; set; }

Property Value

Type	Description
System.String	The default value is null

Change

Gets or sets an event callback that is raised for the actions like undo, redo, clear and while user complete signing on signature component.

Declaration

public string Change { get; set; }

Property Value

Type	Description
System.String	The default value is null

Created

Triggers once the component rendering is completed.

Declaration

public string Created { get; set; }

Property Value

Type	Description
System.String	The default value is null

Disabled

Gets or sets whether to disable the signature component where the opacity is set to show disabled state. True, if the signature component is disabled for user interaction. The default value is false.

Declaration

public bool Disabled { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnablePersistence

Gets or sets whether to persist component's state between page reloads. True, if the component's state persistence is enabled. The default value is false. Component's property will be stored in browser local storage to persist component's state when page reloads.

Declaration

public bool EnablePersistence { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

HtmlAttributes

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration

public object HtmlAttributes { get; set; }

Property Value

Type
System.Object

IsReadOnly

Gets or sets whether to prevent the interaction in signature component. True, if the signature component is read only state where the user interaction is prevented. The default value is false.

Declaration

public bool IsReadOnly { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

MaxStrokeWidth

Gets or sets the maximum stroke width for signature. The signature component calculates stroke width based on Velocity, MinStrokeWidth and MaxStrokeWidth. The maximum width of stroke. The default value is 2.0.

Declaration

public double MaxStrokeWidth { get; set; }

Property Value

Type	Description
System.Double	The default value is 2

MinStrokeWidth

Gets or sets the minimum stroke width for signature. The signature component calculates stroke width based on Velocity, MinStrokeWidth and MaxStrokeWidth. The minimum width of stroke. The default value is 0.5.

Declaration

public double MinStrokeWidth { get; set; }

Property Value

Type	Description
System.Double	The default value is 0.5

SaveWithBackground

Gets or sets whether to save the signature along with Background Color and background Image while saving. True, if signature component to save with background. The default value is true.

Declaration

public bool SaveWithBackground { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

StrokeColor

Gets or sets the stroke color of the signature. The color of the signature stroke that accepts hex value, rgb and text (like 'red'). The default value is "#000000".

Declaration

public string StrokeColor { get; set; }

Property Value

Type	Description
System.String	The default value is "#000000"

Velocity

Gets or sets the velocity to calculate the stroke thickness based on the pressure of the contact on the digitizer surface. The Signature component calculates stroke thickness based on Velocity, MinStrokeWidth and MaxStrokeWidth. The default value is 0.7.

Declaration

public double Velocity { get; set; }

Property Value

Type	Description
System.Double	The default value is 0.7