Skip to main content

ApiSignatureField

Class representing a signature field.

ApiSignatureField is a subclass of ApiButtonField.

Methods​

The following table lists the available methods.

MethodReturnsDescription
AddWidgetApiWidget | null | undefinedAdds new widget - visual representation for field
DeletebooleanRemoves field from document.
GetAllWidgetsApiWidget[]Gets array with widgets of the current field.
GetClassType"signatureField"Returns a type of the ApiSignatureField class.
GetFullNamestringGets field full name.
GetInternalIdstringReturns an internal ID of the current field.
GetPartialNamestringGets field partial name.
GetTooltipbooleanGets field tooltip
GetValuestringGets image of the button field
IsReadOnlybooleanChecks if field is read only
IsRequiredbooleanChecks if field is required
SetFullNamebooleanSets new field name if possible.
SetPartialNamebooleanSets new field partial name.
SetReadOnlybooleanSets field read only
SetRequiredbooleanSets field required
SetTooltipbooleanSets field tooltip
SetValuebooleanSets image for all button field widgets