Edit

Share via

Excel.Interfaces.TableColumnLoadOptions interface

  • Reference
Package:
excel

Represents a column in a 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

Retrieves the filter applied to the column.
id

Returns a unique key that identifies the column within the table.
index

Returns the index number of the column within the columns collection of the table. Zero-indexed.
name

Specifies the name of the table column.
values

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

Retrieves the filter applied to the column.

filter?: Excel.Interfaces.FilterLoadOptions;

Property Value

Excel.Interfaces.FilterLoadOptions

Remarks

[ API set: ExcelApi 1.2 ]

id

Returns a unique key that identifies the column within the table.

id?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

index

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

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

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 ]