Excel.Interfaces.TableCollectionLoadOptions interface
Represents a collection of all the tables that are part of the workbook or worksheet, depending on how it was reached.
Remarks
Properties
$all | Specifying |
auto |
For EACH ITEM in the collection: Represents the |
columns | For EACH ITEM in the collection: Represents a collection of all the columns in the table. |
highlight |
For EACH ITEM in the collection: Specifies if the first column contains special formatting. |
highlight |
For EACH ITEM in the collection: Specifies if the last column contains special formatting. |
id | For EACH ITEM in the collection: 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. |
legacy |
For EACH ITEM in the collection: Returns a numeric ID. |
name | For EACH ITEM in the collection: Name of the table. The set name of the table must follow the guidelines specified in the Rename an Excel table article. |
rows | For EACH ITEM in the collection: Represents a collection of all the rows in the table. |
show |
For EACH ITEM in the collection: Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier. |
show |
For EACH ITEM in the collection: Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier. |
show |
For EACH ITEM in the collection: Specifies if the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row. |
show |
For EACH ITEM in the collection: Specifies if the header row is visible. This value can be set to show or remove the header row. |
show |
For EACH ITEM in the collection: Specifies if the total row is visible. This value can be set to show or remove the total row. |
sort | For EACH ITEM in the collection: Represents the sorting for the table. |
style | For EACH ITEM in the collection: Constant value that represents the table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through "TableStyleDark11". A custom user-defined style present in the workbook can also be specified. |
worksheet | For EACH ITEM in the collection: The worksheet containing the current table. |
Property Details
$all
Specifying $all
for the load options loads all the scalar properties (such as Range.address
) but not the navigational properties (such as Range.format.fill.color
).
$all?: boolean;
Property Value
boolean
autoFilter
For EACH ITEM in the collection: Represents the AutoFilter
object of the table.
autoFilter?: Excel.Interfaces.AutoFilterLoadOptions;
Property Value
Remarks
columns
For EACH ITEM in the collection: Represents a collection of all the columns in the table.
columns?: Excel.Interfaces.TableColumnCollectionLoadOptions;
Property Value
Remarks
highlightFirstColumn
For EACH ITEM in the collection: Specifies if the first column contains special formatting.
highlightFirstColumn?: boolean;
Property Value
boolean
Remarks
highlightLastColumn
For EACH ITEM in the collection: Specifies if the last column contains special formatting.
highlightLastColumn?: boolean;
Property Value
boolean
Remarks
id
For EACH ITEM in the collection: 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.
id?: boolean;
Property Value
boolean
Remarks
legacyId
For EACH ITEM in the collection: Returns a numeric ID.
legacyId?: boolean;
Property Value
boolean
Remarks
name
For EACH ITEM in the collection: Name of the table.
The set name of the table must follow the guidelines specified in the Rename an Excel table article.
name?: boolean;
Property Value
boolean
Remarks
rows
For EACH ITEM in the collection: Represents a collection of all the rows in the table.
rows?: Excel.Interfaces.TableRowCollectionLoadOptions;
Property Value
Remarks
showBandedColumns
For EACH ITEM in the collection: Specifies if the columns show banded formatting in which odd columns are highlighted differently from even ones, to make reading the table easier.
showBandedColumns?: boolean;
Property Value
boolean
Remarks
showBandedRows
For EACH ITEM in the collection: Specifies if the rows show banded formatting in which odd rows are highlighted differently from even ones, to make reading the table easier.
showBandedRows?: boolean;
Property Value
boolean
Remarks
showFilterButton
For EACH ITEM in the collection: Specifies if the filter buttons are visible at the top of each column header. Setting this is only allowed if the table contains a header row.
showFilterButton?: boolean;
Property Value
boolean
Remarks
showHeaders
For EACH ITEM in the collection: Specifies if the header row is visible. This value can be set to show or remove the header row.
showHeaders?: boolean;
Property Value
boolean
Remarks
showTotals
For EACH ITEM in the collection: Specifies if the total row is visible. This value can be set to show or remove the total row.
showTotals?: boolean;
Property Value
boolean
Remarks
sort
For EACH ITEM in the collection: Represents the sorting for the table.
sort?: Excel.Interfaces.TableSortLoadOptions;
Property Value
Remarks
style
For EACH ITEM in the collection: Constant value that represents the table style. Possible values are: "TableStyleLight1" through "TableStyleLight21", "TableStyleMedium1" through "TableStyleMedium28", "TableStyleDark1" through "TableStyleDark11". A custom user-defined style present in the workbook can also be specified.
style?: boolean;
Property Value
boolean
Remarks
worksheet
For EACH ITEM in the collection: The worksheet containing the current table.
worksheet?: Excel.Interfaces.WorksheetLoadOptions;
Property Value
Remarks
Office Add-ins