# RulerBarViewGeneratorColors Object

> 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.

- **Product:** DS Server
- **Section:** Reference
- **Kind:** Object
- **Introduced:** 30.0
- **Path:** DS Server > Reference > JavaScript API > RulerBarViewGeneratorColors Object
- **1238 words**
- **Web URL:** https://docs.textcontrol.com/ds-server/reference/javascript/rulerbarviewgeneratorcolors/
- **LLMs URL:** https://docs.textcontrol.com/ds-server/reference/javascript/rulerbarviewgeneratorcolors/llms.txt
- **LLMs-Full URL:** https://docs.textcontrol.com/ds-server/reference/javascript/rulerbarviewgeneratorcolors/llms-full.txt

---

### 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

```javascript
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.

```javascript
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
    );
}
```

---

## In This Section

- [Javascript: RulerBarViewGeneratorColors.getBackColor Method](https://docs.textcontrol.com/ds-server/reference/javascript/rulerbarviewgeneratorcolors/getbackcolor-method/llms-full.txt): Gets the background color at the left or top edge of the ruler bar.
- [Javascript: RulerBarViewGeneratorColors.getForeColor Method](https://docs.textcontrol.com/ds-server/reference/javascript/rulerbarviewgeneratorcolors/getforecolor-method/llms-full.txt): Gets the color used for the numbers of the ruler.
- [Javascript: RulerBarViewGeneratorColors.getGradientBackColor Method](https://docs.textcontrol.com/ds-server/reference/javascript/rulerbarviewgeneratorcolors/getgradientbackcolor-method/llms-full.txt): Gets the background color at the right or bottom edge of the ruler bar.
- [Javascript: RulerBarViewGeneratorColors.getRulerColor Method](https://docs.textcontrol.com/ds-server/reference/javascript/rulerbarviewgeneratorcolors/getrulercolor-method/llms-full.txt): Gets the color of the ruler.
- [Javascript: RulerBarViewGeneratorColors.getSeparatorColorDark Method](https://docs.textcontrol.com/ds-server/reference/javascript/rulerbarviewgeneratorcolors/getseparatorcolordark-method/llms-full.txt): Gets the color of dark separators.
- [Javascript: RulerBarViewGeneratorColors.getSeparatorColorLight Method](https://docs.textcontrol.com/ds-server/reference/javascript/rulerbarviewgeneratorcolors/getseparatorcolorlight-method/llms-full.txt): Gets the color of light separators.
- [Javascript: RulerBarViewGeneratorColors.resetBackColor Method](https://docs.textcontrol.com/ds-server/reference/javascript/rulerbarviewgeneratorcolors/resetbackcolor-method/llms-full.txt): Resets the ruler bar's backColor to its system dependent default value.
- [Javascript: RulerBarViewGeneratorColors.resetForeColor Method](https://docs.textcontrol.com/ds-server/reference/javascript/rulerbarviewgeneratorcolors/resetforecolor-method/llms-full.txt): Resets the ruler bar's foreColor to its system dependent default value.
- [Javascript: RulerBarViewGeneratorColors.resetGradientBackColor Method](https://docs.textcontrol.com/ds-server/reference/javascript/rulerbarviewgeneratorcolors/resetgradientbackcolor-method/llms-full.txt): Resets the ruler bar's gradientBackColor to its system dependent default value.
- [Javascript: RulerBarViewGeneratorColors.resetRulerColor Method](https://docs.textcontrol.com/ds-server/reference/javascript/rulerbarviewgeneratorcolors/resetrulercolor-method/llms-full.txt): Resets the ruler bar's rulerColor to its system dependent default value.
- [Javascript: RulerBarViewGeneratorColors.resetSeparatorColorDark Method](https://docs.textcontrol.com/ds-server/reference/javascript/rulerbarviewgeneratorcolors/resetseparatorcolordark-method/llms-full.txt): Resets the ruler bar's separatorColorDark to its system dependent default value.
- [Javascript: RulerBarViewGeneratorColors.resetSeparatorColorLight Method](https://docs.textcontrol.com/ds-server/reference/javascript/rulerbarviewgeneratorcolors/resetseparatorcolorlight-method/llms-full.txt): Resets the ruler bar's separatorColorLight to its system dependent default value.
- [Javascript: RulerBarViewGeneratorColors.setBackColor Method](https://docs.textcontrol.com/ds-server/reference/javascript/rulerbarviewgeneratorcolors/setbackcolor-method/llms-full.txt): Sets the background color at the left or top edge of the ruler bar.
- [Javascript: RulerBarViewGeneratorColors.setForeColor Method](https://docs.textcontrol.com/ds-server/reference/javascript/rulerbarviewgeneratorcolors/setforecolor-method/llms-full.txt): Sets the color used for the numbers of the ruler.
- [Javascript: RulerBarViewGeneratorColors.setGradientBackColor Method](https://docs.textcontrol.com/ds-server/reference/javascript/rulerbarviewgeneratorcolors/setgradientbackcolor-method/llms-full.txt): Sets the background color at the right or bottom edge of the ruler bar.
- [Javascript: RulerBarViewGeneratorColors.setRulerColor Method](https://docs.textcontrol.com/ds-server/reference/javascript/rulerbarviewgeneratorcolors/setrulercolor-method/llms-full.txt): Sets the color of the ruler.
- [Javascript: RulerBarViewGeneratorColors.setSeparatorColorDark Method](https://docs.textcontrol.com/ds-server/reference/javascript/rulerbarviewgeneratorcolors/setseparatorcolordark-method/llms-full.txt): Sets the color of dark separators.
- [Javascript: RulerBarViewGeneratorColors.setSeparatorColorLight Method](https://docs.textcontrol.com/ds-server/reference/javascript/rulerbarviewgeneratorcolors/setseparatorcolorlight-method/llms-full.txt): Sets the color of light separators.

---

## Nearby

- **Previous:** [Javascript: RulerBarViewGenerator.setScaleUnit Method](https://docs.textcontrol.com/ds-server/reference/javascript/rulerbarviewgenerator/setscaleunit-method/llms-full.txt)
- **Next:** [Javascript: RulerBarViewGeneratorColors.getBackColor Method](https://docs.textcontrol.com/ds-server/reference/javascript/rulerbarviewgeneratorcolors/getbackcolor-method/llms-full.txt)