TX Text Control .NET Server

Javascript: InputFormat.setStructuredListFormat Method

Method|Introduced in 28.0

Description

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

Syntax

<void> InputFormat.setStructuredListFormat(<NumberFormat> structuredListFormat, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
structuredListFormat

The number format for a structured 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.setStructuredListFormat in a practical document-editing workflow. It sets the number format for a structured list at the current input position.

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

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