DS Server

Javascript: InputFormat.setStructuredList Method

Method|Introduced in 28.0

Description

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

Syntax

<void> InputFormat.setStructuredList(<Boolean> isStructuredList, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
isStructuredList

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

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

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