Description

Represents a single column of a table in a Text Control document.

Syntax

TableColumn

Examples

The following example demonstrates TableColumn in a practical document-editing workflow. It represents a single column of a table in a Text Control document.

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

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

Members

Methods

Method	Description
getCellFormat	Gets the formatting attributes of a table column.
getColumn	Gets the number of the table column represented through this table column object.
getPosition	Gets, in twips, the horizontal position of the column.
getWidth	Gets, in twips, the width of the column.
select	Selects the table column.
setPosition	Sets, in twips, the horizontal position of the column.
setWidth	Sets, in twips, the width of the column.