DS Server

SignatureFieldCollection Object

Object|Introduced in 31.0

Description

Contains all signature fields of a Text Control document or part of the document.

Syntax

SignatureFieldCollection

Examples

The following example demonstrates SignatureFieldCollection in a practical document-editing workflow. It contains all signature fields of a Text Control document or part of the document.

function onTxError(error) {
    console.error("TX Text Control error:", error.msg);
    error.handled = true;
}

TXTextControl.signatureFields.getItem(
    function(signatureField) {
        if (!signatureField) {
            console.warn("No signature field was returned.");
            return;
        }
        
        console.log("get item result:", signatureField);
    },
    onTxError,
    25
);

Members

Methods

Method	Description
addAnchored	Creates and inserts a new signature field which is anchored to the specified text position. It has the specified horizontal alignment and a textflow which is given through the insertionMode parameter. Anchored text frames are moved with the text.
addAnchoredAtLocation	Inserts a new signature field which is anchored to the specified text position. It has the specified location relative to the paragraph it is anchored to and a textflow which is given through the insertionMode parameter. Anchored signature fields are moved with the text.
addAtFixedPositionInDocument	Creates and inserts a new signature field which has a fixed geometrical position in the document. This position is specified through a location relative to the top left corner of the complete document. All gaps between the pages must be included.
addAtFixedPositionOnPage	Inserts a new image which has a fixed geometrical position in the document. This position is specified through a page number and a location on this page.
addInline	Inserts a signature field inline, which means that it is treated in the text like a single character. The signature field is inserted at the specified text input position.
addWithMouse	Inserts a signature field with the built-in mouse interface. The signature field's size is determined through the end-user. A cross cursor indicates where the signature field can be inserted. Changing the document aborts the insertion process.
clear	Removes all objects from the collection and from the document. (Inherited from FrameBaseCollection.)
getItem	Gets the signature field selected by the user or the signature field with the specified identifier.
getItemByName	Gets the signature field with the specified name.
remove	Removes a signature field from a Text Control document.