DS Server

Javascript: TableCellFormat.getBackColor Method

Method|Introduced in 28.0

Description

Gets the table cell's background color.

Syntax

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

Parameters

ParameterDescription
callback

Receives the cell's background color.

errorCallback

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

Examples

The following example demonstrates TableCellFormat.getBackColor in a practical document-editing workflow. It gets the table cell's background color.

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

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