Signatures Class
Description
Controls the document-signing workflow.
Syntax
SignaturesExamples
The following example demonstrates Signatures in a practical Document Viewer workflow. This object provides functionalities for working with annotations.
TXDocumentViewer.signatures.setCustomSigning(true);
console.log("Custom signing enabled:", TXDocumentViewer.signatures.getCustomSigning());Members
Methods
| Method | Description |
|---|---|
| cancelSigningProcess | Cancels the active signing UI. |
| clearSignaturePad | Clears the signature currently shown in the signing dialog. |
| getCustomSigning | Reports whether custom signing is enabled. |
| retrieveSignature | Restores signature data from browser storage. |
| setBeforeSubmitCallback | Sets the callback invoked before submission. |
| setCustomSigning | Enables or disables the application's custom signing workflow. |
| setSubmitCallback | Registers a callback for the signing response. When a redirect URL is configured, request failures are passed to the callback as well. |
| startSigningProcess | Opens the signing dialog. Returns `false` when the document has no signature boxes. |
| storeSignature | Stores current signature data in browser storage. |
| submit | Validates the form fields through Forms.validate() and submits the signed document. Returns `false` when validation fails, or `undefined` when a request failure is handled by the viewer. |