DS Server

Javascript: StatusBarViewGeneratorColors.getBackColorTop Method

Method|Introduced in 30.0

Description

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

Syntax

<void> StatusBarViewGeneratorColors.getBackColorTop(<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.getBackColorTop in a practical document-editing workflow. It gets the background color at the top of the status bar.

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

function inspectBackColorTop(statusBarViewGeneratorColors) {
    statusBarViewGeneratorColors.getBackColorTop(
        function(result) {
            console.log("get back color top result:", result);
        },
        onTxError
    );
}