DS Server

Javascript: StatusBarViewGeneratorColors.getBackColorBottom Method

Method|Introduced in 30.0

Description

Gets the background color at the bottom of the status bar.

Syntax

<void> StatusBarViewGeneratorColors.getBackColorBottom(<RequestStringCallback> callback, [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
callback

Receives the color value.

errorCallback

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

Examples

The following example demonstrates StatusBarViewGeneratorColors.getBackColorBottom in a practical document-editing workflow. It gets the background color at the bottom of the status bar.

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

function inspectBackColorBottom(statusBarViewGeneratorColors) {
    statusBarViewGeneratorColors.getBackColorBottom(
        function(result) {
            console.log("get back color bottom result:", result);
        },
        onTxError
    );
}