TX Text Control .NET Server

Javascript: TextViewGeneratorColors.setDesktopColor Method

Method|Introduced in 28.0

Description

Sets the display color for the area around the pages.

Syntax

<void> TextViewGeneratorColors.setDesktopColor(<string> color, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
color

The display color for the area.

callback

Optional. Is called when the operation completed.

errorCallback

Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates TextViewGeneratorColors.setDesktopColor in a practical document-editing workflow. It sets the display color for the area around the pages.

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

TXTextControl.displayColors.setDesktopColor(
    "#ffd54f",
    function() {
        console.log("set desktop color completed.");
    },
    onTxError
);