TX Text Control .NET Server

Javascript: SignatureFieldCollection.addAtFixedPositionOnPage Method

Method|Introduced in 31.0

Description

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.

Syntax

<void> SignatureFieldCollection.addAtFixedPositionOnPage(<Size> size, <number> pageNumber, <Point> location, <FrameInsertionMode> insertionMode, [<RequestSignatureFieldCallback> callback], [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
size

The signature field's size in twips.

pageNumber

Specifies the number of a page beginning with 1 where the signature field is located.

location

Specifies the location, in twips, at which the signature field is to be inserted. This is a location relative to the top left corner either of a page or of a paragraph.

insertionMode

Specifies how the text flow is handled.

callback

Optional. The newly created signature field object is returned via this callback function.

errorCallback

Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates SignatureFieldCollection.addAtFixedPositionOnPage in a practical document-editing workflow. It 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.

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

TXTextControl.signatureFields.addAtFixedPositionOnPage(
    { width: 2880, height: 1440 },
    1,
    { x: 1440, y: 720 },
    TXTextControl.FrameInsertionMode.AsCharacter,
    function(signatureField) {
        if (!signatureField) {
            console.warn("No signature field was returned.");
            return;
        }
        
        console.log("add at fixed position on page result:", signatureField);
    },
    onTxError
);