ExcelScript.TableColumn interface

Represents a column in a table.

Methods

delete()

Deletes the column from the table.

getFilter()

Retrieves the filter applied to the column.

getHeaderRowRange()

Gets the range object associated with the header row of the column.

getId()

Returns a unique key that identifies the column within the table.

getIndex()

Returns the index number of the column within the columns collection of the table. Zero-indexed.

getName()

Specifies the name of the table column.

getRange()

Gets the range object associated with the entire column.

getRangeBetweenHeaderAndTotal()

Gets the range object associated with the data body of the column.

getTotalRowRange()

Gets the range object associated with the totals row of the column.

setName(name)

Specifies the name of the table column.

Method Details

delete()

Deletes the column from the table.

delete(): void;

Returns

void

getFilter()

Retrieves the filter applied to the column.

getFilter(): Filter;

Returns

getHeaderRowRange()

Gets the range object associated with the header row of the column.

getHeaderRowRange(): Range;

Returns

getId()

Returns a unique key that identifies the column within the table.

getId(): number;

Returns

number

getIndex()

Returns the index number of the column within the columns collection of the table. Zero-indexed.

getIndex(): number;

Returns

number

getName()

Specifies the name of the table column.

getName(): string;

Returns

string

getRange()

Gets the range object associated with the entire column.

getRange(): Range;

Returns

getRangeBetweenHeaderAndTotal()

Gets the range object associated with the data body of the column.

getRangeBetweenHeaderAndTotal(): Range;

Returns

getTotalRowRange()

Gets the range object associated with the totals row of the column.

getTotalRowRange(): Range;

Returns

setName(name)

Specifies the name of the table column.

setName(name: string): void;

Parameters

name

string

Returns

void