ExcelScript.TableColumn interface
Represents a column in a table.
Methods
| delete() | Deletes the column from the table. |
| get |
Retrieves the filter applied to the column. |
| get |
Gets the range object associated with the header row of the column. |
| get |
Returns a unique key that identifies the column within the table. |
| get |
Returns the index number of the column within the columns collection of the table. Zero-indexed. |
| get |
Specifies the name of the table column. |
| get |
Gets the range object associated with the entire column. |
| get |
Gets the range object associated with the data body of the column. |
| get |
Gets the range object associated with the totals row of the column. |
| set |
Specifies the name of the table column. |
Method Details
delete()
Deletes the column from the table.
delete(): void;
Returns
void
getFilter()
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
Feedback
Submit and view feedback for