DS Server

Javascript: StatusBarViewGenerator.setLineText Method

Method|Introduced in 30.0

Description

Sets the text in the 'Line' area of the status bar.

Syntax

<void> StatusBarViewGenerator.setLineText(<string> 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.setLineText in a practical document-editing workflow. It sets the text in the 'Line' area of the status bar.

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

TXTextControl.statusBar.setLineText(
    "Quarterly report",
    function() {
        console.log("set line text completed.");
    },
    onTxError
);