Edit

Share via

Excel.Interfaces.QueryCollectionLoadOptions interface

Package:
excel

Represents the collection of queries in the workbook.

Remarks

[ API set: ExcelApi 1.14 ]

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

For EACH ITEM in the collection: Gets the query error message from when the query was last refreshed.
loadedTo

For EACH ITEM in the collection: Gets the query loaded to object type.
loadedToDataModel

For EACH ITEM in the collection: Specifies if the query loaded to the data model.
name

For EACH ITEM in the collection: Gets the name of the query. Query names cannot contain periods or quotation marks.
refreshDate

For EACH ITEM in the collection: Gets the date and time when the query was last refreshed.
rowsLoadedCount

For EACH ITEM in the collection: Gets the number of rows that were loaded when the query was last refreshed. If last refresh has errors the value will be -1.

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

error

For EACH ITEM in the collection: Gets the query error message from when the query was last refreshed.

error?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.14 ]

loadedTo

For EACH ITEM in the collection: Gets the query loaded to object type.

loadedTo?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.14 ]

loadedToDataModel

For EACH ITEM in the collection: Specifies if the query loaded to the data model.

loadedToDataModel?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.14 ]

name

For EACH ITEM in the collection: Gets the name of the query. Query names cannot contain periods or quotation marks.

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.14 ]

refreshDate

For EACH ITEM in the collection: Gets the date and time when the query was last refreshed.

refreshDate?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.14 ]

rowsLoadedCount

For EACH ITEM in the collection: Gets the number of rows that were loaded when the query was last refreshed. If last refresh has errors the value will be -1.

rowsLoadedCount?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.14 ]