Description

Gets the formatting character for a bulleted or numbered list.

Syntax

<void> ListFormat.getFormatCharacter(<RequestListFormatCharacterCallback> callback, [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
callback	Receives the formatting character for a bulleted or numbered list.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates ListFormat.getFormatCharacter in a practical document-editing workflow. It gets the formatting character for a bulleted or numbered list.

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

TXTextControl.listFormat.getFormatCharacter(
    function(result) {
        if (!result) {
            console.warn("No list format character was returned.");
            return;
        }
        
        console.log("get format character result:", result);
    },
    onTxError
);