Description

Gets the background color of the text frame.

Syntax

<void> TextFrame.getBackColor(<RequestStringCallback> callback, [<ErrorCallback> errorCallback])

Parameters

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

Examples

The following example demonstrates TextFrame.getBackColor in a practical document-editing workflow. It gets the background color of the text frame.

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

function inspectBackColor(textFrame) {
    textFrame.getBackColor(
        function(result) {
            console.log("get back color result:", result);
        },
        onTxError
    );
}