Javascript: RulerBarViewGeneratorColors.setGradientBackColor Method

Description

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

Syntax

<void> RulerBarViewGeneratorColors.setGradientBackColor(<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.setGradientBackColor in a practical document-editing workflow. It sets 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 configureGradientBackColor(rulerBarViewGeneratorColors) {
    rulerBarViewGeneratorColors.setGradientBackColor(
        "#ffffff",
        function() {
            console.log("set gradient back color completed.");
        },
        onTxError
    );
}