Javascript: TextFrame.setBackColor Method

Description

Sets the background color for the text frame.

Syntax

<void> TextFrame.setBackColor(<string> value, [<EmptyRequestCallback> callback], [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
value	The color as a CSS color string.
callback	Optional. Is called when the operation completed.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates TextFrame.setBackColor in a practical document-editing workflow. It sets the background color for the text frame.

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

function configureBackColor(textFrame) {
    textFrame.setBackColor(
        "#ffffff",
        function() {
            console.log("set back color completed.");
        },
        onTxError
    );
}