DS Server

SignatureField Object

Object|Introduced in 31.0

Description

The SignatureField object represents a rectangle that can be filled with text by an end-user and can be edited like the main text.

Syntax

SignatureField

Examples

The following example demonstrates SignatureField in a practical document-editing workflow. The SignatureField object represents a rectangle that can be filled with text by an end-user and can be edited like the main text.

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

function inspectSignatureField(signatureField) {
    signatureField.getSignerData(
        function(signerData) {
            if (!signerData) {
                console.warn("No signer data was returned.");
                return;
            }
            
            console.log("get signer data result:", signerData);
        },
        onTxError
    );
}

Members

Properties

PropertyDescription
imageThe signature field's image.

Methods

MethodDescription
changeZOrderChanges the frame's z-order. (Inherited from FrameBase.)
getAlignmentGets the frame's horizontal alignment when it is anchored to a paragraph. (Inherited from FrameBase.)
getBoundsGets the frame's bounding rectangle relative to the upper left corner of the document. (Inherited from FrameBase.)
getDescriptiveTextGets the descriptive text for the frame. An empty string indicates that the frame has no such text. (Inherited from FrameBase.)
getIDGets an identifier for the frame. A value of zero indicates that the image, text frame, chart, barcode or drawing has no identifier. (Inherited from FrameBase.)
getInsertionModeGets a value determining whether the frame is treated as a single character or the document's text either flows around or overwrites the frame. If the document's text flows around or overwrites the frame, this property also determines whether the image, text frame, chart, barcode or drawing is moved with the text or fixed positioned on a page. (Inherited from FrameBase.)
getLocationGets, in twips, the frame's current location. If the image, text frame, chart, barcode or drawing is anchored to a paragraph, the location is relative to the paragraph. Otherwise, it is relative to the document. If the frame has a horizontal alignment or if it is inserted inline, this property returns zero. This property cannot be set for images, text frames, charts, barcodes or drawings which are inserted inline. (Inherited from FrameBase.)
getMoveableGets whether a frame can be moved in the document at run time with the built-in mouse interface. (Inherited from FrameBase.)
getNameGets the name for the frame. An empty string indicates that the frame has no name. (Inherited from FrameBase.)
getSignerDataGets the signer data of the signature field.
getSizeGets the frame's size in twips. (Inherited from FrameBase.)
getSizeableGets whether the frame can be resized at run time with the built-in mouse interface. (Inherited from FrameBase.)
getTextDistancesGets the distances, in twips, between the frame and the document's text. (Inherited from FrameBase.)
getTextPositionGets the frame's character position in the document's text (one-based). (Inherited from FrameBase.)
setAlignmentSets the frame's horizontal alignment when it is anchored to a paragraph. (Inherited from FrameBase.)
setDescriptiveTextSets a descriptive text for the frame. An empty string or null can be used to delete a previously set text. (Inherited from FrameBase.)
setIDSets an identifier for the frame. It must be a one-based value. A value of zero indicates that the image, text frame, chart, barcode or drawing has no identifier. Zero can also be used to delete a previously set identifier. (Inherited from FrameBase.)
setImageSets the signature field's image.
setInsertionModeSets a value determining whether the frame is treated as a single character or the document's text either flows around or overwrites the frame. If the document's text flows around or overwrites the frame, this property also determines whether the image, text frame, chart, barcode or drawing is moved with the text or fixed positioned on a page. (Inherited from FrameBase.)
setLocationSets, in twips, the frame's current location. If the image, text frame, chart, barcode or drawing is anchored to a paragraph, the location is relative to the paragraph. Otherwise, it is relative to the document. If the frame has a horizontal alignment or if it is inserted inline, this property returns zero. This property cannot be set for images, text frames, charts, barcodes or drawings which are inserted inline. (Inherited from FrameBase.)
setMoveableSets whether a frame can be moved in the document at run time with the built-in mouse interface. (Inherited from FrameBase.)
setNameSets a name for the frame. An empty string indicates that the frame has no name. An empty string can also be used to delete a previously set name. (Inherited from FrameBase.)
setSignerDataSets the signer data of the signature field.
setSizeSets the frame's size in twips. For images this property is read only. To change the size of an image in a document, use the setHorizontalScaling and setVerticalScaling methods. (Inherited from FrameBase.)
setSizeableSets whether the frame can be resized at run time with the built-in mouse interface. (Inherited from FrameBase.)
setTextDistancesSets the distances, in twips, between the frame and the document's text. If a value is set to -1, it is not changed. (Inherited from FrameBase.)