TX Text Control .NET Server

Javascript: StatusBarViewGeneratorColors.setFrameColor 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. Sets the color of the status bar's frames.

Syntax

<void> StatusBarViewGeneratorColors.setFrameColor(<string> value, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
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 StatusBarViewGeneratorColors.setFrameColor 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. Sets the color of the status bar's frames.

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

function configureFrameColor(statusBarViewGeneratorColors) {
    statusBarViewGeneratorColors.setFrameColor(
        "Quarterly report",
        function() {
            console.log("set frame color completed.");
        },
        onTxError
    );
}