ApiSignatureForm

Class representing a document picture form.

ApiSignatureForm is a subclass of ApiFormBase.

Properties

Name	Type	Description
Value	string	Returns or sets the current image of the signature form as a base64 encoded string.

Methods

The following table lists the available methods.

Method	Returns	Description
Clear	boolean	Clears the current form.
Copy	ApiForm | null | undefined	Copies the current form (copies with the shape if it exists).
Delete	boolean	Removes a form and its content.
GetBackgroundColor	ApiColor | null | undefined	Returns the background color of the current form.
GetBorderColor	ApiColor | null | undefined	Returns the border color of the current form.
GetClassType	"signatureForm"	Returns a type of the ApiSignatureForm class.
GetFormKey	string	Returns the current form key.
GetFormType	FormType	Returns a type of the current form.
GetImage	Base64Img	Returns an image in the base64 format from the current signature form.
GetInternalId	string	Returns an internal id of the current form.
GetLock	boolean	Returns the lock state of the current form.
GetParent	ParagraphLikeContainer | null | undefined	Returns the parent element (a paragraph or an inline content control) that directly contains the current form.
GetPlaceholderText	string	Returns the placeholder text from the current form.
GetPosInParent	Number	Returns the position (index) of the current form within its parent element.
GetRole	string	Returns the role of the current form.
GetTag	string	Returns the tag attribute for the current form.
GetText	string	Returns the text from the current form.
GetTextPr	ApiTextPr	Returns the text properties from the current form.
GetTipText	string	Returns the tip text of the current form.
GetValue	string	Returns the current image of the signature form as a base64 encoded string.
GetWrapperShape	ApiShape | null | undefined	Returns a shape in which the form is placed to control the position and size of the fixed size form frame.
IsFilled	boolean	Checks if the current form is filled.
IsFixed	boolean	Checks if the current form is fixed size.
IsRequired	boolean	Checks if the current form is required.
MoveCursorOutside	boolean	Places a cursor before/after the current form.
SetBackgroundColor	boolean	Sets the background color to the current form.
SetBorderColor	boolean	Sets the border color to the current form.
SetFormKey	boolean	Sets a key to the current form.
SetImage	boolean	Sets an image to the current picture form.
SetLock	boolean	Sets the lock state of the current form.
SetPlaceholderText	boolean	Sets the placeholder text to the current form.
SetRequired	boolean	Specifies if the current form should be required.
SetRole	boolean	Sets the role to the current form.
SetTag	boolean	Sets the tag attribute to the current form.
SetTextPr	boolean	Sets the text properties to the current form.
SetTipText	boolean	Sets the tip text to the current form.
SetValue	boolean	Sets an image to the signature form.
ToFixed	boolean	Converts the current form to a fixed size form.
ToInline	boolean	Converts the current form to an inline form.