Javascript: PageNumberField.setShowNumberOfPages Method

Description

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

Syntax

<void> PageNumberField.setShowNumberOfPages(<boolean> value, [<EmptyRequestCallback> callback])

Parameters

Examples

The following example demonstrates PageNumberField.setShowNumberOfPages in a practical document-editing workflow. It sets 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.setShowNumberOfPages(
            true,
            function() {
                console.log("set show number of pages completed.");
            }
        );
    }, onTxError);
}, onTxError);