TX Text Control .NET Server

Javascript: RulerBarViewGeneratorColors.getRulerColor Method

Method|Introduced in 30.0

Description

Gets the color of the ruler.

Syntax

<void> RulerBarViewGeneratorColors.getRulerColor(<RequestStringCallback> callback, [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
callback

Receives the color value.

errorCallback

Optional. Is called when the operation failed with an error.

Examples

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

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

function inspectRulerColor(rulerBarViewGeneratorColors) {
    rulerBarViewGeneratorColors.getRulerColor(
        function(result) {
            console.log("get ruler color result:", result);
        },
        onTxError
    );
}