DS Server

Javascript: StatusBarViewGeneratorColors.setBackColorTop Method

Method|Introduced in 30.0

Description

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

Syntax

<void> StatusBarViewGeneratorColors.setBackColorTop(<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 StatusBarViewGeneratorColors.setBackColorTop in a practical document-editing workflow. It sets 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 configureBackColorTop(statusBarViewGeneratorColors) {
    statusBarViewGeneratorColors.setBackColorTop(
        "#ffffff",
        function() {
            console.log("set back color top completed.");
        },
        onTxError
    );
}