Javascript: RulerBarViewGeneratorColors.getGradientBackColor Method

Description

Gets the background color at the right or bottom edge of the ruler bar.

Syntax

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

Parameters

Parameter	Description
callback	Receives the color value.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates RulerBarViewGeneratorColors.getGradientBackColor in a practical document-editing workflow. It gets the background color at the right or bottom edge of the ruler bar.

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

function inspectGradientBackColor(rulerBarViewGeneratorColors) {
    rulerBarViewGeneratorColors.getGradientBackColor(
        function(result) {
            console.log("get gradient back color result:", result);
        },
        onTxError
    );
}