DS Server

Javascript: StatusBarViewGeneratorColors.getFrameColor Method

MethodDeprecated|Introduced in 30.0

Description

Obsolete. This method will be removed in one of the next versions. Since version 33.0 the status bar doesn't support frames anymore. Gets the color of the status bar's frames.

Syntax

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

Parameters

ParameterDescription
callback

Receives the color value. Is always called with an empty string.

errorCallback

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

Examples

The following example demonstrates StatusBarViewGeneratorColors.getFrameColor in a practical document-editing workflow. Obsolete. This method will be removed in one of the next versions. Since version 33.0 the status bar doesn't support frames anymore. Gets the color of the status bar's frames.

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

function inspectFrameColor(statusBarViewGeneratorColors) {
    statusBarViewGeneratorColors.getFrameColor(
        function(result) {
            console.log("get frame color result:", result);
        },
        onTxError
    );
}