TX Text Control .NET Server

Javascript: TableColumn.getCellFormat Method

Method|Introduced in 28.0

Description

Gets the formatting attributes of a table column.

Syntax

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

Parameters

ParameterDescription
callback

Receives the formatting attributes of the column.

errorCallback

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

Examples

The following example demonstrates TableColumn.getCellFormat in a practical document-editing workflow. It gets the formatting attributes of a table column.

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

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