Class SignatureBuilder

Inheritance

System.Object

ControlBuilder

SignatureBuilder

Inherited Members

ControlBuilder.Context

Namespace: Syncfusion.EJ2.Inputs

Assembly: Syncfusion.EJ2.dll

Syntax

public class SignatureBuilder : ControlBuilder

Constructors

SignatureBuilder()

Declaration

public SignatureBuilder()

SignatureBuilder(Signature)

Declaration

public SignatureBuilder(Signature model)

Parameters

Type	Name	Description
Signature	model

Fields

model

Declaration

public Signature model

Field Value

Type	Description
Signature

Properties

HtmlAttr

Declaration

public IDictionary<string, object> HtmlAttr { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>

ID

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String

Output

Declaration

public override TextWriter Output { get; set; }

Property Value

Type	Description
System.IO.TextWriter

Overrides

ControlBuilder.Output

Methods

BackgroundColor(String)

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 SignatureBuilder BackgroundColor(string backgroundColor)

Parameters

Type	Name	Description
System.String	backgroundColor

Returns

Type	Description
SignatureBuilder

BackgroundImage(String)

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 SignatureBuilder BackgroundImage(string backgroundImage)

Parameters

Type	Name	Description
System.String	backgroundImage

Returns

Type	Description
SignatureBuilder

BeforeSave(String)

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 SignatureBuilder BeforeSave(string beforeSave)

Parameters

Type	Name	Description
System.String	beforeSave

Returns

Type	Description
SignatureBuilder

Change(String)

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 SignatureBuilder Change(string change)

Parameters

Type	Name	Description
System.String	change

Returns

Type	Description
SignatureBuilder

Created(String)

Triggers once the component rendering is completed.

Declaration

public SignatureBuilder Created(string created)

Parameters

Type	Name	Description
System.String	created

Returns

Type	Description
SignatureBuilder

Disabled(Boolean)

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 SignatureBuilder Disabled(bool disabled = true)

Parameters

Type	Name	Description
System.Boolean	disabled

Returns

Type	Description
SignatureBuilder

EnablePersistence(Boolean)

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 SignatureBuilder EnablePersistence(bool enablePersistence = true)

Parameters

Type	Name	Description
System.Boolean	enablePersistence

Returns

Type	Description
SignatureBuilder

HtmlAttributes(Object)

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

Declaration

public SignatureBuilder HtmlAttributes(object htmlAttributes)

Parameters

Type	Name	Description
System.Object	htmlAttributes

Returns

Type	Description
SignatureBuilder

IsReadOnly(Boolean)

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 SignatureBuilder IsReadOnly(bool isReadOnly = true)

Parameters

Type	Name	Description
System.Boolean	isReadOnly

Returns

Type	Description
SignatureBuilder

MaxStrokeWidth(Double)

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 SignatureBuilder MaxStrokeWidth(double maxStrokeWidth)

Parameters

Type	Name	Description
System.Double	maxStrokeWidth

Returns

Type	Description
SignatureBuilder

MinStrokeWidth(Double)

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 SignatureBuilder MinStrokeWidth(double minStrokeWidth)

Parameters

Type	Name	Description
System.Double	minStrokeWidth

Returns

Type	Description
SignatureBuilder

Render()

Declaration

public HtmlString Render()

Returns

Type	Description
Microsoft.AspNetCore.Html.HtmlString

SaveWithBackground(Boolean)

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 SignatureBuilder SaveWithBackground(bool saveWithBackground = true)

Parameters

Type	Name	Description
System.Boolean	saveWithBackground

Returns

Type	Description
SignatureBuilder

StrokeColor(String)

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 SignatureBuilder StrokeColor(string strokeColor)

Parameters

Type	Name	Description
System.String	strokeColor

Returns

Type	Description
SignatureBuilder

Velocity(Double)

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 SignatureBuilder Velocity(double velocity)

Parameters

Type	Name	Description
System.Double	velocity

Returns

Type	Description
SignatureBuilder