Description

Sets the color of the ruler.

Syntax

<void> RulerBarViewGeneratorColors.setRulerColor(<string> value, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
value	The property value.
callback	Optional. Is called when the operation completed.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates RulerBarViewGeneratorColors.setRulerColor in a practical document-editing workflow. It sets the color of the ruler.

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

function configureRulerColor(rulerBarViewGeneratorColors) {
    rulerBarViewGeneratorColors.setRulerColor(
        "Quarterly report",
        function() {
            console.log("set ruler color completed.");
        },
        onTxError
    );
}