DS Server

Javascript: TXTextControl.setTextBackColor Method

Method|Introduced in 28.0

Description

Sets the background color for the text.

Syntax

<void> TXTextControl.setTextBackColor(<string> color, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

ParameterDescription
color

Name or hexadecimal value of the HTML Color.

callback

Optional. Is called when the operation completed.

errorCallback

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

Examples

The following example demonstrates TXTextControl.setTextBackColor in a practical document-editing workflow. It sets the background color for the text.

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

TXTextControl.setTextBackColor(
    "#ffd54f",
    function() {
        console.log("set text back color completed.");
    },
    onTxError
);