TX Text Control .NET Server

Javascript: StatusBarViewGenerator.setShowKeyStates Method

Method|Introduced in 34.0

Description

Specifies whether the status bar shows the key state of the current insertion mode, insert or overwrite.

Syntax

<void> StatusBarViewGenerator.setShowKeyStates(<boolean> 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 StatusBarViewGenerator.setShowKeyStates in a practical document-editing workflow. It specifies whether the status bar shows the key state of the current insertion mode, insert or overwrite.

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

TXTextControl.statusBar.setShowKeyStates(
    true,
    function() {
        console.log("set show key states completed.");
    },
    onTxError
);