DS Server

Javascript: InputFormat.setBulletedList Method

Method|Introduced in 28.0

Description

Sets a value specifying whether there is a bulleted list at the current input position.

Syntax

<void> InputFormat.setBulletedList(<Boolean> bulletedList, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
bulletedList

Specifies whether there is a bulleted 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.setBulletedList in a practical document-editing workflow. It sets a value specifying whether there is a bulleted list at the current input position.

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

TXTextControl.inputFormat.setBulletedList(
    true,
    function() {
        console.log("set bulleted list completed.");
    },
    onTxError
);