Excel.QueryCollection class

包:
excel

表示工作簿中的查询集合。

扩展
OfficeExtension.ClientObject

注解

API 集：ExcelApi 1.14

使用方

属性

context

与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。
items

获取此集合中已加载的子项。

方法

getCount()

获取工作簿中的查询数。
getItem(key)

根据集合名称从集合中获取查询。
load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
refreshAll()

刷新所有查询。
toJSON()

覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.QueryCollection 对象是 API 对象，但该 toJSON 方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.QueryCollectionData) ，其中包含一个“items”数组，其中包含从集合的 items 中加载的任何属性的浅层副本。

属性详细信息

context

与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Excel.RequestContext

items

获取此集合中已加载的子项。

readonly items: Excel.Query[];

属性值

Excel.Query[]

示例

// This function retrieves the query collection in a workbook, 
// loads the query items in that collection, and then
// logs the name of each query to the console.
await Excel.run(async (context) => {
    const queries = context.workbook.queries; 
    queries.load("items"); 
    await context.sync(); 

    console.log("Name of each query: ")
    console.log("  " + queries.items.map((query) => query.name).join("\n  "));
});

方法详细信息

getCount()

获取工作簿中的查询数。

getCount(): OfficeExtension.ClientResult<number>;

返回

OfficeExtension.ClientResult<number>

注解

API 集：ExcelApi 1.14

示例

// This function retrieves the query collection in a workbook and then 
// logs the number of queries in the collection to the console.
await Excel.run(async (context) => { 
  const queries = context.workbook.queries; 
  const count = queries.getCount();
  await context.sync();

  console.log("Query count: " + count.value);
});

getItem(key)

根据集合名称从集合中获取查询。

getItem(key: string): Excel.Query;

参数

key

string

查询的名称，不区分大小写。

返回

Excel.Query

具有给定名称的查询。 如果没有该名称的查询，则会引发错误。

注解

API 集：ExcelApi 1.14

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: Excel.Interfaces.QueryCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.QueryCollection;

参数

options

Excel.Interfaces.QueryCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

为要加载的对象属性提供选项。

返回

Excel.QueryCollection

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNames?: string | string[]): Excel.QueryCollection;

参数

propertyNames

string | string[]

指定要加载的属性的逗号分隔的字符串或字符串数组。

返回

Excel.QueryCollection

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.QueryCollection;

参数

propertyNamesAndPaths
OfficeExtension.LoadOption

propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。

返回

Excel.QueryCollection

refreshAll()

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

刷新所有查询。

refreshAll(): void;

返回

void

注解

API 集：ExcelApi BETA (仅预览版)

toJSON()

覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.QueryCollection 对象是 API 对象，但该 toJSON 方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.QueryCollectionData) ，其中包含一个“items”数组，其中包含从集合的 items 中加载的任何属性的浅层副本。

toJSON(): Excel.Interfaces.QueryCollectionData;

返回

Excel.Interfaces.QueryCollectionData