DS Server

Javascript: InputFormat.setLeftFrameLine Method

Method|Introduced in 28.0

Description

Sets a value specifying whether there is a frame line at the left side of the text.

Syntax

<void> InputFormat.setLeftFrameLine(<Boolean> leftFrameLine, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
leftFrameLine

Specifies whether there is a frame line at the left side of the text.

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.setLeftFrameLine in a practical document-editing workflow. It sets a value specifying whether there is a frame line at the left side of the text.

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

TXTextControl.inputFormat.setLeftFrameLine(
    true,
    function() {
        console.log("set left frame line completed.");
    },
    onTxError
);