Excel.Workbook class

Representa a instância do aplicativo Excel que contém esta pasta de trabalho.

readonly application: Excel.Application;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

Representa uma coleção de ligações que fazem parte da pasta de trabalho.

readonly bindings: Excel.BindingCollection;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

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

Representa um conjunto de funções de planilha que podem ser usadas para computação.

readonly functions: Excel.Functions;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.2

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-built-in-functions.yaml

await Excel.run(async (context) => {
  // This function uses VLOOKUP to find data in the "Wrench" row
  // on the worksheet, and then it uses SUM to combine the values.
  let range = context.workbook.worksheets.getItem("Sample").getRange("A1:D4");

  // Get the values in the second, third, and fourth columns in the "Wrench" row,
  // and combine those values with SUM.
  let sumOfTwoLookups = context.workbook.functions.sum(
    context.workbook.functions.vlookup("Wrench", range, 2, false),
    context.workbook.functions.vlookup("Wrench", range, 3, false),
    context.workbook.functions.vlookup("Wrench", range, 4, false)
  );
  sumOfTwoLookups.load("value");

  await context.sync();
  console.log(" Number of wrenches sold in November, December, and January = " + sumOfTwoLookups.value);
});

Representa uma coleção de itens nomeados no escopo da pasta de trabalho (intervalos nomeados e constantes).

readonly names: Excel.NamedItemCollection;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

Representa uma coleção de tabelas associadas à pasta de trabalho.

readonly tables: Excel.TableCollection;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

Representa uma coleção de planilhas associadas à pasta de trabalho.

readonly worksheets: Excel.WorksheetCollection;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/list-worksheets.yaml

await Excel.run(async (context) => {
    const sheets: Excel.WorksheetCollection = context.workbook.worksheets;
    sheets.load("items/name");
    
    await context.sync();

    if (sheets.items.length > 1) {
        console.log(`There are ${sheets.items.length} worksheets in the workbook:`);
    } else {
        console.log(`There is one worksheet in the workbook:`);
    }
    for (let i in sheets.items) {
        console.log(sheets.items[i].name);
    } 
});

Obtém o intervalo único selecionado no momento da pasta de trabalho. Se houver vários intervalos selecionados, esse método gerará um erro.

getSelectedRange(): Excel.Range;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.1

Exemplos

await Excel.run(async (context) => { 
    const selectedRange = context.workbook.getSelectedRange();
    selectedRange.load('address');
    await context.sync();
    console.log(selectedRange.address);
});

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.WorkbookLoadOptions): Excel.Workbook;

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

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

Parâmetros

Retornos

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.WorkbookUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

Retornos

Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.

set(properties: Excel.Workbook): void;

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.Workbook é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.WorkbookData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.WorkbookData;

Retornos

Ocorre quando a seleção no documento é alterada.

readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.SelectionChangedEventArgs>;

Tipo de evento

Comentários

Conjunto de APIs: ExcelApi 1.2