RulerBarViewGenerator Object
Description
Provides functions and properties for requesting properties and executing server side methods for a ruler bar.
Syntax
RulerBarViewGeneratorExamples
The following example demonstrates RulerBarViewGenerator in a practical document-editing workflow. It provides functions and properties for requesting properties and executing server side methods for a ruler bar.
function onTxError(error) {
console.error("TX Text Control error:", error.msg);
error.handled = true;
}
TXTextControl.rulerBar.getBorderStyle(
function(borderStyle) {
if (!borderStyle) {
console.warn("No ruler bar border style was returned.");
return;
}
console.log("get border style result:", borderStyle);
},
onTxError
);Members
Properties
| Property | Description |
|---|---|
| displayColors | The displayed colors of the ruler bar. |
Methods
| Method | Description |
|---|---|
| getBorderStyle | Gets the border style of the ruler bar. |
| getEnablePageMargins | Gets whether page margins can be set via the ruler bar. |
| getFormulaMode | Gets the formula mode of the ruler bar. |
| getReadOnly | Gets a value determining the ruler bar's read only mode. When the ruler bar is set to read only, it still shows all formatting attributes of the connected TextControl, but formatting attributes cannot be changed. |
| getScaleUnit | Gets the scale unit of the ruler bar. |
| resetDisplayColors | Resets all display colors of a ruler bar to their system dependent default values. |
| setBorderStyle | Sets the border style of the ruler bar. |
| setEnablePageMargins | Sets whether page margins can be set via the ruler bar. |
| setFormulaMode | Sets the formula mode of the ruler bar. |
| setReadOnly | Sets a value determining the ruler bar's read only mode. When the ruler bar is set to read only, it still shows all formatting attributes of the connected TextControl, but formatting attributes cannot be changed. |
| setScaleUnit | Sets the scale unit of the ruler bar. |