Excel.Query class

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Recebe a mensagem de erro de quando a consulta foi atualizada pela última vez.

readonly error: Excel.QueryError | "Unknown" | "None" | "FailedLoadToWorksheet" | "FailedLoadToDataModel" | "FailedDownload" | "FailedToCompleteDownload";

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.14

Faz com que a consulta seja carregada no tipo de objeto.

readonly loadedTo: Excel.LoadToType | "ConnectionOnly" | "Table" | "PivotTable" | "PivotChart";

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.14

Especifica se a consulta foi carregada no modelo de dados.

readonly loadedToDataModel: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.14

Obtém o nome da consulta. Os nomes de consulta não podem conter pontos ou aspas.

readonly name: string;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.14

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 a data e a hora em que a consulta foi atualizada pela última vez.

readonly refreshDate: Date;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.14

Exemplos

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

    console.log("Last refresh date of each query: ")
    console.log("  " + queries.items.map((query) => query.refreshDate).join("\n  "));
});       

Obtém o número de linhas que foram carregadas quando a consulta foi atualizada pela última vez. Se a última atualização tiver erros, o valor será -1.

readonly rowsLoadedCount: number;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.14

Exemplos

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

    console.log("Rows loaded from each query: ")
    console.log("  " + queries.items.map((query) => query.rowsLoadedCount).join("\n  "));
});

Exclui a consulta e a conexão associada. As tabelas associadas à consulta não serão mais conectadas.

delete(): void;

Retornos

Comentários

Conjunto de APIs: ExcelApi BETA (SOMENTE VISUALIZAÇÃO)

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.QueryLoadOptions): Excel.Query;

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.Query;

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?: {
            select?: string;
            expand?: string;
        }): Excel.Query;

Parâmetros

Retornos

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Excel.Query é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.QueryData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.QueryData;

Retornos