DS Server

Javascript: TXTextControl.setEditableRegionHighlightMode Method

Method|Introduced in 30.0

Description

Sets the global editable region highlight mode.

Syntax

<void> TXTextControl.setEditableRegionHighlightMode(<HighlightMode> value, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
value

The property value.

callback

Optional. Is called when the operation completed.

errorCallback

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

Examples

The following example demonstrates TXTextControl.setEditableRegionHighlightMode in a practical document-editing workflow. It sets the global editable region highlight mode.

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

TXTextControl.setEditableRegionHighlightMode(
    TXTextControl.HighlightMode.Always,
    function() {
        console.log("set editable region highlight mode completed.");
    },
    onTxError
);