TX Text Control .NET Server

Javascript: StatusBarViewGeneratorColors.getGradientBackColor 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 horizontal gradients anymore. Gets the background color at the right edge of the status bar.

Syntax

<void> StatusBarViewGeneratorColors.getGradientBackColor(<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.getGradientBackColor 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 horizontal gradients anymore. Gets the background color at the right edge of the status bar.

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

function inspectGradientBackColor(statusBarViewGeneratorColors) {
    statusBarViewGeneratorColors.getGradientBackColor(
        function(result) {
            console.log("get gradient back color result:", result);
        },
        onTxError
    );
}