Table resource type

Represents an Excel table.

Methods

Method	Return Type	Description
Get Table	Table	Read properties and relationships of table object.
Create TableColumn	TableColumn	Create a new TableColumn by posting to the columns collection.
List columns	TableColumn collection	Get a TableColumn object collection.
Create TableRow	TableRow	Create a new TableRow by posting to the rows collection.
List rows	TableRow collection	Get a TableRow object collection.
Update	Table	Update Table object.
Databodyrange	Range	Gets the range object associated with the data body of the table.
Headerrowrange	Range	Gets the range object associated with header row of the table.
Range	Range	Gets the range object associated with the entire table.
Totalrowrange	Range	Gets the range object associated with totals row of the table.
Clearfilters	None	Clears all the filters currently applied on the table.
Converttorange	Range	Converts the table into a normal range of cells. All data is preserved.
Delete	None	Deletes the table.
Reapplyfilters	None	Reapplies all the filters currently on the table.
List	Table collection	Get table object collection.
Add	Table	Create a new table. The range source address determines the worksheet under which the table will be added. If the table cannot be added (e.g., because the address is invalid, or the table would overlap with another table), an error will be thrown.

Properties

Property	Type	Description
id	int	Returns a value that uniquely identifies the table in a given workbook. The value of the identifier remains the same even when the table is renamed. Read-only.
name	string	Name of the table.
showHeaders	boolean	Indicates whether the header row is visible or not. This value can be set to show or remove the header row.
showTotals	boolean	Indicates whether the total row is visible or not. This value can be set to show or remove the total row.
style	string	Constant value that represents the Table style. Possible values are: TableStyleLight1 thru TableStyleLight21, TableStyleMedium1 thru TableStyleMedium28, TableStyleStyleDark1 thru TableStyleStyleDark11. A custom user-defined style present in the workbook can also be specified.
highlightFirstColumn	Boolean	Indicates whether the first column contains special formatting.
highlightLastColumn	Boolean	Indicates whether the last column contains special formatting.
showBandedColumns	Boolean	Indicates whether the columns show banded formatting in which odd columns are highlighted differently from even ones to make reading the table easier.
showBandedRows	Boolean	Indicates whether the rows show banded formatting in which odd rows are highlighted differently from even ones to make reading the table easier.
showFilterButton	Boolean	Indicates whether the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row.

Relationships

Relationship	Type	Description
columns	TableColumn collection	Represents a collection of all the columns in the table. Read-only.
rows	TableRow collection	Represents a collection of all the rows in the table. Read-only.
sort	TableSort	Represents the sorting for the table. Read-only.
worksheet	Worksheet	The worksheet containing the current table. Read-only.

JSON representation

Here is a JSON representation of the resource.

{
  "highlightFirstColumn": true,
  "highlightLastColumn": true,
  "id": "String (identifier)",
  "name": "String",
  "showBandedColumns": true,
  "showBandedRows": true,
  "showFilterButton": true,
  "showHeaders": true,
  "showTotals": true,
  "style": "String"
}