DS Server

Javascript: InputFormat.getFrameLineColor Method

Method|Introduced in 28.0

Description

Gets the color used to display the color of frame lines at the current text input position.

Syntax

<void> InputFormat.getFrameLineColor(<RequestColorStringCallback> callback, [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
callback

Receives the color used to display the color of frame lines at the current text input position.

errorCallback

Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates InputFormat.getFrameLineColor in a practical document-editing workflow. It gets the color used to display the color of frame lines at the current text input position.

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

TXTextControl.inputFormat.getFrameLineColor(
    function(color) {
        console.log("get frame line color result:", color);
    },
    onTxError
);