Edit

Share via

Excel.Interfaces.TableColumnCollectionLoadOptions interface

  • Reference
Package:
excel

Represents a collection of all the columns that are part of the table.

Remarks

[ API set: ExcelApi 1.1 ]

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).
filter

For EACH ITEM in the collection: Retrieves the filter applied to the column.
id

For EACH ITEM in the collection: Returns a unique key that identifies the column within the table.
index

For EACH ITEM in the collection: Returns the index number of the column within the columns collection of the table. Zero-indexed.
name

For EACH ITEM in the collection: Specifies the name of the table column.
values

For EACH ITEM in the collection: Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. If the returned value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula.

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

filter

For EACH ITEM in the collection: Retrieves the filter applied to the column.

filter?: Excel.Interfaces.FilterLoadOptions;

Property Value

Excel.Interfaces.FilterLoadOptions

Remarks

[ API set: ExcelApi 1.2 ]

id

For EACH ITEM in the collection: Returns a unique key that identifies the column within the table.

id?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

index

For EACH ITEM in the collection: Returns the index number of the column within the columns collection of the table. Zero-indexed.

index?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

name

For EACH ITEM in the collection: Specifies the name of the table column.

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 for getting the name; 1.4 for setting it. ]

values

For EACH ITEM in the collection: Represents the raw values of the specified range. The data returned could be a string, number, or boolean. Cells that contain an error will return the error string. If the returned value starts with a plus ("+"), minus ("-"), or equal sign ("="), Excel interprets this value as a formula.

values?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]