Description

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

Syntax

<void> InputFormat.getStructuredListFormat(<RequestNumberFormatCallback> callback, [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
callback	Receives the number format for a structured list at the current input position.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates InputFormat.getStructuredListFormat in a practical document-editing workflow. It gets 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.getStructuredListFormat(
    function(result) {
        if (!result) {
            console.warn("No number format was returned.");
            return;
        }
        
        console.log("get structured list format result:", result);
    },
    onTxError
);