Excel.QueryCollection class

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Obtém os itens filhos carregados nesta coleção.

readonly items: Excel.Query[];

Valor da propriedade

Exemplos

// 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  "));
});

Obtém o número de consultas no livro.

getCount(): OfficeExtension.ClientResult<number>;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.14 ]

Exemplos

// 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);
});

Obtém uma consulta da coleção com base no respetivo nome.

getItem(key: string): Excel.Query;

Parâmetros

Retornos

A consulta com o nome especificado. Se não existir nenhuma consulta com esse nome, é gerado um erro.

Comentários

[ Conjunto de API: ExcelApi 1.14 ]

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

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

Parâmetros

Retornos

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Excel.QueryCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.QueryCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

toJSON(): Excel.Interfaces.QueryCollectionData;

Retornos