Description

Sets the formatting character for a bulleted or numbered list.

Syntax

<void> ListFormat.setFormatCharacter(<ListFormatCharacter> value, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

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

Examples

The following example demonstrates ListFormat.setFormatCharacter in a practical document-editing workflow. It sets 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.setFormatCharacter(
    TXTextControl.ListFormatCharacter.Tab,
    function() {
        console.log("set format character completed.");
    },
    onTxError
);