Description

Gets the formatting attributes of a table cell. The property's value is an object of type TableCellFormat.

Syntax

<void> TableCell.getCellFormat(<RequestCellFormatCallback> callback, [<ErrorCallback> errorCallback])

Parameters

Parameter	Description
callback	Receives the cell's format.
errorCallback	Optional. Is called when the operation failed with an error.

Examples

The following example demonstrates TableCell.getCellFormat in a practical document-editing workflow. It gets the formatting attributes of a table cell. The property's value is an object of type TableCellFormat.

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

function inspectCellFormat(tableCell) {
    tableCell.getCellFormat(
        function(format) {
            if (!format) {
                console.warn("No table cell format was returned.");
                return;
            }
            
            console.log("get cell format result:", format);
        },
        onTxError
    );
}