DS Server

Javascript: PageNumberField.getStartNumber Method

Method|Introduced in 30.0

Description

Gets the page number for the first page.

Syntax

<void> PageNumberField.getStartNumber(<RequestNumberCallback> callback, [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
callback

Receives the property value.

errorCallback

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

Examples

The following example demonstrates PageNumberField.getStartNumber in a practical document-editing workflow. It gets the page number for the first page.

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

TXTextControl.textParts.getMainText(function(mainText) {
    const pageNumberFields = mainText.pageNumberFields;
    pageNumberFields.getItem(function(pageNumberField) {
        if (!pageNumberField) {
            console.warn("No page number field is available at the current input position.");
            return;
        }
    
        pageNumberField.getStartNumber(
            function(result) {
                console.log("get start number result:", result);
            },
            onTxError
        );
    }, onTxError);
}, onTxError);