DS Server

Javascript: InputFormat.setNumberedListFormat Method

Method|Introduced in 28.0

Description

Sets the number format for a numbered list at the current input position.

Syntax

<void> InputFormat.setNumberedListFormat(<NumberFormat> numberedListFormat, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
numberedListFormat

The number format for a numbered list at the current input position.

callback

Optional. Is called when the operation completed.

errorCallback

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

Examples

The following example demonstrates InputFormat.setNumberedListFormat in a practical document-editing workflow. It sets the number format for a numbered list at the current input position.

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

TXTextControl.inputFormat.setNumberedListFormat(
    TXTextControl.NumberFormat.ArabicNumbers,
    function() {
        console.log("set numbered list format completed.");
    },
    onTxError
);