DS Server

Javascript: BarcodeCollection.addAtFixedPositionOnPage Method

Method|Introduced in 28.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> BarcodeCollection.addAtFixedPositionOnPage(<RequestBarcodeFrameCallback> callback, [<ErrorCallback> errorCallback], <BarcodeType> barcodeType, <string> text, <number> pageNumber, <Point> location, <FrameInsertionMode> insertionMode)

Parameters

ParameterDescription
callback

The newly created barcode object is returned via this callback function.

errorCallback

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

barcodeType

The barcode type.

text

The text the barcode should encrypt.

pageNumber

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

location

Specifies the location, in twips, at which the barcode 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.

Examples

The following example demonstrates BarcodeCollection.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;
}

function addAtFixedPositionOnPage(barcodeType) {
    TXTextControl.barcodes.addAtFixedPositionOnPage(
        function(barcodeFrame) {
            if (!barcodeFrame) {
                console.warn("No barcode frame was returned.");
                return;
            }
            
            console.log("add at fixed position on page result:", barcodeFrame);
        },
        onTxError,
        barcodeType,
        "Quarterly report",
        1,
        { x: 1440, y: 720 },
        TXTextControl.FrameInsertionMode.AsCharacter
    );
}