DS Server

Javascript: PageNumberField.setNumberFormat Method

Method|Introduced in 30.0

Description

Sets the number format.

Syntax

<void> PageNumberField.setNumberFormat(<NumberFormat> value, [<EmptyRequestCallback> callback])

Parameters

ParameterDescription
value

The property value.

callback

Optional. Is called when the operation completed.

Examples

The following example demonstrates PageNumberField.setNumberFormat in a practical document-editing workflow. It sets the number format.

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.setNumberFormat(
            TXTextControl.NumberFormat.ArabicNumbers,
            function() {
                console.log("set number format completed.");
            }
        );
    }, onTxError);
}, onTxError);