DS Server

RulerBarViewGeneratorColors Object

Object|Introduced in 30.0

Description

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

Syntax

RulerBarViewGeneratorColors

Examples

The following example demonstrates RulerBarViewGeneratorColors in a practical document-editing workflow. The RulerBarViewGeneratorColors object provides methods for getting, setting or resetting the display colors of a ruler 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 inspectRulerBarViewGeneratorColors(rulerBarViewGeneratorColors) {
    rulerBarViewGeneratorColors.getBackColor(
        function(result) {
            console.log("get back color result:", result);
        },
        onTxError
    );
}

Members

Methods

MethodDescription
getBackColorGets the background color at the left or top edge of the ruler bar.
getForeColorGets the color used for the numbers of the ruler.
getGradientBackColorGets the background color at the right or bottom edge of the ruler bar.
getRulerColorGets the color of the ruler.
getSeparatorColorDarkGets the color of dark separators.
getSeparatorColorLightGets the color of light separators.
resetBackColorResets the ruler bar's backColor to its system dependent default value.
resetForeColorResets the ruler bar's foreColor to its system dependent default value.
resetGradientBackColorResets the ruler bar's gradientBackColor to its system dependent default value.
resetRulerColorResets the ruler bar's rulerColor to its system dependent default value.
resetSeparatorColorDarkResets the ruler bar's separatorColorDark to its system dependent default value.
resetSeparatorColorLightResets the ruler bar's separatorColorLight to its system dependent default value.
setBackColorSets the background color at the left or top edge of the ruler bar.
setForeColorSets the color used for the numbers of the ruler.
setGradientBackColorSets the background color at the right or bottom edge of the ruler bar.
setRulerColorSets the color of the ruler.
setSeparatorColorDarkSets the color of dark separators.
setSeparatorColorLightSets the color of light separators.