Description

Gets a value indicating whether the field shows the page number or the total number of pages.

Syntax

<void> PageNumberField.getShowNumberOfPages(<RequestBooleanCallback> callback, [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
callback	Receives the property value.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates PageNumberField.getShowNumberOfPages in a practical document-editing workflow. It gets a value indicating whether the field shows the page number or the total number of pages.

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.getShowNumberOfPages(
            function(result) {
                if (result) {
                    console.log("get show number of pages is available.");
                } else {
                    console.warn("get show number of pages is not available in the current document state.");
                }
            },
            onTxError
        );
    }, onTxError);
}, onTxError);