SignatureLine
SignatureLine class
Represent the signature line.
class SignatureLine;
Constructors
| Constructor | Description |
|---|---|
| constructor() | Default Constructor. |
Properties
| Property | Type | Description |
|---|---|---|
| signer | string | Gets or sets the signer. |
| title | string | Gets or sets the title of singer. |
| string | Gets or sets the email of singer. | |
| isLine | boolean | Indicates whether it is a signature line. |
| allowComments | boolean | Indicates whether comments could be attached. |
| showSignedDate | boolean | Indicates whether show signed date. |
| instructions | string | Gets or sets the text shown to user at signing time. |
| signatureLineType | SignatureType | Gets or sets the signature type. Default - When the default value is set, the corresponding ProviderId value is fixed to {0000000000-0000-0000-0000-0000000000}. Stamp - When the value is Stamp, the corresponding ProviderId value is usually {000CD6A4-0000-0000-C000-000000000046}. Custom - When the value is Custom, the corresponding ProviderId value usually needs to be set by the user. it should be obtained from the documentation shipped with the provider. |
Methods
| Method | Description |
|---|---|
| getSigner() | @deprecated. Please use the ‘signer’ property instead. Gets or sets the signer. |
| setSigner(string) | @deprecated. Please use the ‘signer’ property instead. Gets or sets the signer. |
| getTitle() | @deprecated. Please use the ’title’ property instead. Gets or sets the title of singer. |
| setTitle(string) | @deprecated. Please use the ’title’ property instead. Gets or sets the title of singer. |
| getEmail() | @deprecated. Please use the ’email’ property instead. Gets or sets the email of singer. |
| setEmail(string) | @deprecated. Please use the ’email’ property instead. Gets or sets the email of singer. |
| isLine() | @deprecated. Please use the ‘isLine’ property instead. Indicates whether it is a signature line. |
| setIsLine(boolean) | @deprecated. Please use the ‘isLine’ property instead. Indicates whether it is a signature line. |
| getAllowComments() | @deprecated. Please use the ‘allowComments’ property instead. Indicates whether comments could be attached. |
| setAllowComments(boolean) | @deprecated. Please use the ‘allowComments’ property instead. Indicates whether comments could be attached. |
| getShowSignedDate() | @deprecated. Please use the ‘showSignedDate’ property instead. Indicates whether show signed date. |
| setShowSignedDate(boolean) | @deprecated. Please use the ‘showSignedDate’ property instead. Indicates whether show signed date. |
| getInstructions() | @deprecated. Please use the ‘instructions’ property instead. Gets or sets the text shown to user at signing time. |
| setInstructions(string) | @deprecated. Please use the ‘instructions’ property instead. Gets or sets the text shown to user at signing time. |
| getSignatureLineType() | @deprecated. Please use the ‘signatureLineType’ property instead. Gets or sets the signature type. Default - When the default value is set, the corresponding ProviderId value is fixed to {0000000000-0000-0000-0000-0000000000}. Stamp - When the value is Stamp, the corresponding ProviderId value is usually {000CD6A4-0000-0000-C000-000000000046}. Custom - When the value is Custom, the corresponding ProviderId value usually needs to be set by the user. it should be obtained from the documentation shipped with the provider. |
| setSignatureLineType(SignatureType) | @deprecated. Please use the ‘signatureLineType’ property instead. Gets or sets the signature type. Default - When the default value is set, the corresponding ProviderId value is fixed to {0000000000-0000-0000-0000-0000000000}. Stamp - When the value is Stamp, the corresponding ProviderId value is usually {000CD6A4-0000-0000-C000-000000000046}. Custom - When the value is Custom, the corresponding ProviderId value usually needs to be set by the user. it should be obtained from the documentation shipped with the provider. |
| isNull() | Checks whether the implementation object is null. |
constructor()
Default Constructor.
constructor();
signer
Gets or sets the signer.
signer : string;
title
Gets or sets the title of singer.
title : string;
Gets or sets the email of singer.
email : string;
isLine
Indicates whether it is a signature line.
isLine : boolean;
allowComments
Indicates whether comments could be attached.
allowComments : boolean;
showSignedDate
Indicates whether show signed date.
showSignedDate : boolean;
instructions
Gets or sets the text shown to user at signing time.
instructions : string;
signatureLineType
Gets or sets the signature type. Default - When the default value is set, the corresponding ProviderId value is fixed to {0000000000-0000-0000-0000-0000000000}. Stamp - When the value is Stamp, the corresponding ProviderId value is usually {000CD6A4-0000-0000-C000-000000000046}. Custom - When the value is Custom, the corresponding ProviderId value usually needs to be set by the user. it should be obtained from the documentation shipped with the provider.
signatureLineType : SignatureType;
getSigner()
@deprecated. Please use the ‘signer’ property instead. Gets or sets the signer.
getSigner() : string;
setSigner(string)
@deprecated. Please use the ‘signer’ property instead. Gets or sets the signer.
setSigner(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getTitle()
@deprecated. Please use the ’title’ property instead. Gets or sets the title of singer.
getTitle() : string;
setTitle(string)
@deprecated. Please use the ’title’ property instead. Gets or sets the title of singer.
setTitle(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getEmail()
@deprecated. Please use the ’email’ property instead. Gets or sets the email of singer.
getEmail() : string;
setEmail(string)
@deprecated. Please use the ’email’ property instead. Gets or sets the email of singer.
setEmail(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
isLine()
@deprecated. Please use the ‘isLine’ property instead. Indicates whether it is a signature line.
isLine() : boolean;
setIsLine(boolean)
@deprecated. Please use the ‘isLine’ property instead. Indicates whether it is a signature line.
setIsLine(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getAllowComments()
@deprecated. Please use the ‘allowComments’ property instead. Indicates whether comments could be attached.
getAllowComments() : boolean;
setAllowComments(boolean)
@deprecated. Please use the ‘allowComments’ property instead. Indicates whether comments could be attached.
setAllowComments(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getShowSignedDate()
@deprecated. Please use the ‘showSignedDate’ property instead. Indicates whether show signed date.
getShowSignedDate() : boolean;
setShowSignedDate(boolean)
@deprecated. Please use the ‘showSignedDate’ property instead. Indicates whether show signed date.
setShowSignedDate(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getInstructions()
@deprecated. Please use the ‘instructions’ property instead. Gets or sets the text shown to user at signing time.
getInstructions() : string;
setInstructions(string)
@deprecated. Please use the ‘instructions’ property instead. Gets or sets the text shown to user at signing time.
setInstructions(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getSignatureLineType()
@deprecated. Please use the ‘signatureLineType’ property instead. Gets or sets the signature type. Default - When the default value is set, the corresponding ProviderId value is fixed to {0000000000-0000-0000-0000-0000000000}. Stamp - When the value is Stamp, the corresponding ProviderId value is usually {000CD6A4-0000-0000-C000-000000000046}. Custom - When the value is Custom, the corresponding ProviderId value usually needs to be set by the user. it should be obtained from the documentation shipped with the provider.
getSignatureLineType() : SignatureType;
Returns
setSignatureLineType(SignatureType)
@deprecated. Please use the ‘signatureLineType’ property instead. Gets or sets the signature type. Default - When the default value is set, the corresponding ProviderId value is fixed to {0000000000-0000-0000-0000-0000000000}. Stamp - When the value is Stamp, the corresponding ProviderId value is usually {000CD6A4-0000-0000-C000-000000000046}. Custom - When the value is Custom, the corresponding ProviderId value usually needs to be set by the user. it should be obtained from the documentation shipped with the provider.
setSignatureLineType(value: SignatureType) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | SignatureType | The value to set. |
isNull()
Checks whether the implementation object is null.
isNull() : boolean;