Class SignaturePropertiesBuilder
Represents a class for SignaturePropertiesBuilder which includes stroke width, stroke color, background color, background image, height, and width.
Inheritance
Inherited Members
Namespace: Syncfusion.JavaScript
Assembly: Syncfusion.EJ.dll
Syntax
public class SignaturePropertiesBuilder : IPropertiesBuilder, IHtmlString
Constructors
SignaturePropertiesBuilder()
Initializes a new instance of the SignaturePropertiesBuilder class.
Declaration
public SignaturePropertiesBuilder()
SignaturePropertiesBuilder(Signature)
Declaration
public SignaturePropertiesBuilder(Signature signature)
Parameters
Type | Name | Description |
---|---|---|
Signature | signature |
Fields
signature
Declaration
public Signature signature
Field Value
Type | Description |
---|---|
Signature |
Methods
BackgroundColor(String)
Specify the backgroundcolor of the canvas.
Declaration
public SignaturePropertiesBuilder BackgroundColor(string backgroundcolor)
Parameters
Type | Name | Description |
---|---|---|
System.String | backgroundcolor | backgroundcolor |
Returns
Type | Description |
---|---|
SignaturePropertiesBuilder | This method returns string value |
BackgroundImage(String)
Specify the backgroundimage of the canvas.
Declaration
public SignaturePropertiesBuilder BackgroundImage(string backgroundimage)
Parameters
Type | Name | Description |
---|---|---|
System.String | backgroundimage | backgroundimage |
Returns
Type | Description |
---|---|
SignaturePropertiesBuilder | This method returns string value |
ClientSideEvents(Action<SignatureClientSideEventsBuilder>)
SignaturePropertiesBuilder ClientSide Events
Declaration
public SignaturePropertiesBuilder ClientSideEvents(Action<SignatureClientSideEventsBuilder> clientSideEvents)
Parameters
Type | Name | Description |
---|---|---|
System.Action<SignatureClientSideEventsBuilder> | clientSideEvents | clientSideEvents |
Returns
Type | Description |
---|---|
SignaturePropertiesBuilder | This method returns signature properties builder value |
enabled(Boolean)
Specifies the signature be enabled.
Declaration
public SignaturePropertiesBuilder enabled(bool isenabled)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | isenabled |
Returns
Type | Description |
---|---|
SignaturePropertiesBuilder | This method returns boolean value |
Height(String)
Specifies the height of the signature control wrapper.
Declaration
public SignaturePropertiesBuilder Height(string height)
Parameters
Type | Name | Description |
---|---|---|
System.String | height | height |
Returns
Type | Description |
---|---|
SignaturePropertiesBuilder | This method returns string value |
IsResponsive(Boolean)
Enables the signature control with responsive.
Declaration
public SignaturePropertiesBuilder IsResponsive(bool isresponsive)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | isresponsive |
Returns
Type | Description |
---|---|
SignaturePropertiesBuilder | This method returns boolean value |
Render()
Renders this instance.
Declaration
public void Render()
SaveImageFormat(SaveImageFormat)
Specifies the saving image format of signature control.
Declaration
public SignaturePropertiesBuilder SaveImageFormat(SaveImageFormat saveimageformat)
Parameters
Type | Name | Description |
---|---|---|
SaveImageFormat | saveimageformat | saveimageformat |
Returns
Type | Description |
---|---|
SignaturePropertiesBuilder | This method returns enum value |
saveWithBackground(Boolean)
Specifies the signature to save with background.
Declaration
public SignaturePropertiesBuilder saveWithBackground(bool savewithbackground)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | savewithbackground |
Returns
Type | Description |
---|---|
SignaturePropertiesBuilder | This method returns boolean value |
ShowRoundedCorner(Boolean)
Enables the siganture control with RoundedCorner.It can be used to show the rounded corner for the control.
Declaration
public SignaturePropertiesBuilder ShowRoundedCorner(bool showroundedcorner)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | showroundedcorner |
Returns
Type | Description |
---|---|
SignaturePropertiesBuilder | This method returns boolean value |
StrokeColor(String)
Specify the stroke color to achieve the color.
Declaration
public SignaturePropertiesBuilder StrokeColor(string strokecolor)
Parameters
Type | Name | Description |
---|---|---|
System.String | strokecolor | strokecolor |
Returns
Type | Description |
---|---|
SignaturePropertiesBuilder | This method returns string value |
StrokeWidth(Double)
Allow to render the strokewidth of signature.
Declaration
public SignaturePropertiesBuilder StrokeWidth(double strokeWidth)
Parameters
Type | Name | Description |
---|---|---|
System.Double | strokeWidth |
Returns
Type | Description |
---|---|
SignaturePropertiesBuilder | This method returns number value |
ToHtmlString()
Returns an HTML-encoded string.
Declaration
public string ToHtmlString()
Returns
Type | Description |
---|---|
System.String |
Width(String)
Specifies the width of the signature control wrapper.
Declaration
public SignaturePropertiesBuilder Width(string width)
Parameters
Type | Name | Description |
---|---|---|
System.String | width | width |
Returns
Type | Description |
---|---|
SignaturePropertiesBuilder | This method returns string value |