DS Server

Javascript: RulerBarViewGeneratorColors.resetGradientBackColor Method

Method|Introduced in 30.0

Description

Resets the ruler bar's gradientBackColor to its system dependent default value.

Syntax

<void> RulerBarViewGeneratorColors.resetGradientBackColor([<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
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.resetGradientBackColor in a practical document-editing workflow. Resets the ruler bar's gradientBackColor to its system dependent default value.

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

function resetGradientBackColor(rulerBarViewGeneratorColors) {
    rulerBarViewGeneratorColors.resetGradientBackColor(
        function() {
            console.log("reset gradient back color completed.");
        },
        onTxError
    );
}