TX Text Control .NET Server

StatusBarViewGeneratorColors Object

Object|Introduced in 30.0

Description

The StatusBarViewGeneratorColors object provides methods for getting, setting or resetting the display colors of a status bar. By default the display colors depend on sytem colors on the server. With this object all colors can be individually designed.

Syntax

StatusBarViewGeneratorColors

Examples

The following example demonstrates StatusBarViewGeneratorColors in a practical document-editing workflow. The StatusBarViewGeneratorColors object provides methods for getting, setting or resetting the display colors of a status bar. By default the display colors depend on sytem colors on the server. With this object all colors can be individually designed.

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

function inspectStatusBarViewGeneratorColors(statusBarViewGeneratorColors) {
    statusBarViewGeneratorColors.getBackColor(
        function(result) {
            console.log("get back color result:", result);
        },
        onTxError
    );
}

Members

Methods

MethodDescription
getBackColorGets the background color at the left edge of the status bar.
getBackColorBottomGets the background color at the bottom of the status bar.
getBackColorMiddleGets the background color in the middle of the status bar.
getBackColorTopGets the background color at the top of the status bar.
getForeColorGets the color used for text and numbers.
getFrameColorObsolete. 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.
getGradientBackColorObsolete. 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.
getSeparatorColorDarkObsolete. This method will be removed in one of the next versions. Since version 33.0 the status bar doesn't support gradients in separators anymore. Gets the color of the dark part of a separator.
getSeparatorColorLightObsolete. This method will be removed in one of the next versions. Since version 33.0 the status bar doesn't support gradients in separators anymore. Gets the color of the light part of a separator.
resetResets all colors to their system dependent default values.
resetBackColorResets the ruler bar's backColor to its system dependent default value.
resetBackColorBottomResets the status bar's backColorBottom to its system dependent default value.
resetBackColorMiddleResets the status bar's backColorMiddle to its system dependent default value.
resetBackColorTopResets the status bar's backColorTop to its system dependent default value.
resetForeColorResets the status bar's foreColor to its system dependent default value.
resetFrameColorObsolete. This method will be removed in one of the next versions. Since version 33.0 the status bar doesn't support frames anymore. Resets the status bar's frameColor to its system dependent default value.
resetGradientBackColorObsolete. This method will be removed in one of the next versions. Since version 33.0 the status bar doesn't support horizontal gradients anymore. Resets the status bar's gradientBackColor to its system dependent default value.
resetSeparatorColorResets the separator color to its default value.
resetSeparatorColorDarkObsolete. This method will be removed in one of the next versions. Since version 33.0 the status bar doesn't support gradients in separators anymore. Resets the status bar's separatorColorDark to its system dependent default value.
resetSeparatorColorLightObsolete. This method will be removed in one of the next versions. Since version 33.0 the status bar doesn't support gradients in separators anymore. Resets the status bar's separatorColorLight to its system dependent default value.
setBackColorSets the background color at the left edge of the ruler bar.
setBackColorBottomSets the background color at the bottom of the status bar.
setBackColorMiddleSets the background color in the middle of the status bar.
setBackColorTopSets the background color at the top of the status bar.
setForeColorSets the color used for text and numbers.
setFrameColorObsolete. This method will be removed in one of the next versions. Since version 33.0 the status bar doesn't support frames anymore. Sets the color of the status bar's frames.
setGradientBackColorObsolete. This method will be removed in one of the next versions. Since version 33.0 the status bar doesn't support horizontal gradients anymore. Sets the background color at the right edge of the status bar.
setSeparatorColorSets the separator color.
setSeparatorColorDarkObsolete. This method will be removed in one of the next versions. Since version 33.0 the status bar doesn't support gradients in separators anymore. Sets the color of the dark part of a separator.
setSeparatorColorLightObsolete. This method will be removed in one of the next versions. Since version 33.0 the status bar doesn't support gradients in separators anymore. Sets the color of the light part of a separator.