DS Server

Javascript: StatusBarViewGeneratorColors.resetFrameColor Method

MethodDeprecated|Introduced in 30.0

Description

Obsolete. This method will be removed in one of the next versions. Since version 33.0 the status bar doesn't support frames anymore. Resets the status bar's frameColor to its system dependent default value.

Syntax

<void> StatusBarViewGeneratorColors.resetFrameColor([<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 StatusBarViewGeneratorColors.resetFrameColor in a practical document-editing workflow. Obsolete. This method will be removed in one of the next versions. Since version 33.0 the status bar doesn't support frames anymore. Resets the status bar's frameColor to its system dependent default value.

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

function resetFrameColor(statusBarViewGeneratorColors) {
    statusBarViewGeneratorColors.resetFrameColor(
        function() {
            console.log("reset frame color completed.");
        },
        onTxError
    );
}