Excel.Interfaces.TableScopedCollectionLoadOptions interface

Package:

excel

Represents a scoped collection of tables. For each table its top-left corner is considered its anchor location, and the tables are sorted top-to-bottom and then left-to-right.

Remarks

[ API set: ExcelApi 1.9 ]

Properties

$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).
autoFilter	For EACH ITEM in the collection: Represents the AutoFilter object of the table.
columns	For EACH ITEM in the collection: Represents a collection of all the columns in the table.
highlightFirstColumn	For EACH ITEM in the collection: Specifies if the first column contains special formatting.
highlightLastColumn	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.
legacyId	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.
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.
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.
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.
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.
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.
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.
tableStyle	For EACH ITEM in the collection: The style applied to the table.
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

Excel.Interfaces.AutoFilterLoadOptions

Remarks

[ API set: ExcelApi 1.9 ]

columns

For EACH ITEM in the collection: Represents a collection of all the columns in the table.

columns?: Excel.Interfaces.TableColumnCollectionLoadOptions;

Property Value

Excel.Interfaces.TableColumnCollectionLoadOptions

Remarks

[ API set: ExcelApi 1.9 ]

highlightFirstColumn

For EACH ITEM in the collection: Specifies if the first column contains special formatting.

highlightFirstColumn?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.3 ]

highlightLastColumn

For EACH ITEM in the collection: Specifies if the last column contains special formatting.

highlightLastColumn?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.3 ]

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

[ API set: ExcelApi 1.1 ]

legacyId

For EACH ITEM in the collection: Returns a numeric ID.

legacyId?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

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

[ API set: ExcelApi 1.1 ]

rows

For EACH ITEM in the collection: Represents a collection of all the rows in the table.

rows?: Excel.Interfaces.TableRowCollectionLoadOptions;

Property Value

Excel.Interfaces.TableRowCollectionLoadOptions

Remarks

[ API set: ExcelApi 1.9 ]

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

[ API set: ExcelApi 1.3 ]

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

[ API set: ExcelApi 1.3 ]

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

[ API set: ExcelApi 1.3 ]

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

[ API set: ExcelApi 1.1 ]

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

[ API set: ExcelApi 1.1 ]

sort

For EACH ITEM in the collection: Represents the sorting for the table.

sort?: Excel.Interfaces.TableSortLoadOptions;

Property Value

Excel.Interfaces.TableSortLoadOptions

Remarks

[ API set: ExcelApi 1.9 ]

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

[ API set: ExcelApi 1.1 ]

tableStyle

Note

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

For EACH ITEM in the collection: The style applied to the table.

tableStyle?: Excel.Interfaces.TableStyleLoadOptions;

Property Value

Excel.Interfaces.TableStyleLoadOptions

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

worksheet

For EACH ITEM in the collection: The worksheet containing the current table.

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Property Value

Excel.Interfaces.WorksheetLoadOptions

Remarks

[ API set: ExcelApi 1.9 ]