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

Especifica se a pasta de trabalho está no modo de Salvamento Automático.

readonly autoSave: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

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

Retorna um número sobre a versão do Mecanismo de Cálculo do Excel.

readonly calculationEngineVersion: number;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

True se todos os gráficos na pasta de trabalho estiverem rastreando os pontos de dados reais aos quais eles estão anexados. Falso se os gráficos acompanharem o índice dos pontos de dados.

chartDataPointTrack: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

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 a coleção de partes XML personalizadas contidas nessa pasta de trabalho.

readonly customXmlParts: Excel.CustomXmlPartCollection;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.5

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/18-custom-xml-parts/test-xml-for-unique-namespace.yaml

await Excel.run(async (context) => {
    document.getElementById("display-xml").textContent = "";
    const customXmlParts = context.workbook.customXmlParts;
    customXmlParts.load("items");

    await context.sync();

    for (let i = 0; i < customXmlParts.items.length; i++) {
        customXmlParts.items[i].delete();
    }

    await context.sync();
});

Representa todas as conexões de dados na pasta de trabalho.

readonly dataConnections: Excel.DataConnectionCollection;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

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

Especifica se as alterações foram feitas desde que a pasta de trabalho foi salva pela última vez. Você pode definir essa propriedade true como se quiser fechar uma pasta de trabalho modificada sem salvá-la ou ser solicitado a salvá-la.

isDirty: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Obtém o nome da pasta de trabalho.

readonly name: string;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

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 Dinâmicas associadas à pasta de trabalho.

readonly pivotTables: Excel.PivotTableCollection;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.3

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-get-pivottables.yaml

await Excel.run(async (context) => {
  // Get the names of all the PivotTables in the workbook.
  const pivotTables = context.workbook.pivotTables;
  pivotTables.load("name");
  await context.sync();

  // Display the names in the console.
  console.log("PivotTables in the workbook:")
  pivotTables.items.forEach((pivotTable) => {
    console.log(`\t${pivotTable.name}`);
  });
});

Especifica se a pasta de trabalho já foi salva localmente ou online.

readonly previouslySaved: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

Obtém as propriedades da pasta de trabalho.

readonly properties: Excel.DocumentProperties;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/properties.yaml

await Excel.run(async (context) => {
    let titleValue = "Excel document properties API";
    let subjectValue = "Set and get document properties";
    let keywordsValue = "Set and get operations";
    let commentsValue = "This is an Excel document properties API code sample";
    let categoryValue = "Office Add-ins";
    let managerValue = "John";
    let companyValue = "Microsoft";

    let docProperties = context.workbook.properties;

    // Set the writeable document properties.
    docProperties.title = titleValue;
    docProperties.subject = subjectValue;
    docProperties.keywords = keywordsValue;
    docProperties.comments = commentsValue;
    docProperties.category = categoryValue;
    docProperties.manager = managerValue;
    docProperties.company = companyValue;

    await context.sync();

    console.log("Set the following document properties: title, subject, keywords, comments, category, manager, company.");
});

Retorna o objeto de proteção para uma pasta de trabalho.

readonly protection: Excel.WorkbookProtection;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

Exemplos

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

await Excel.run(async (context) => {
    const workbook: Excel.Workbook = context.workbook;
    workbook.protection.unprotect();
});

Retorna true se a pasta de trabalho estiver aberta no modo somente leitura.

readonly readOnly: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.8

Representa um conjunto de configurações associadas à pasta de trabalho.

readonly settings: Excel.SettingCollection;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.4

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml

await Excel.run(async (context) => {
    const settings: Excel.SettingCollection = context.workbook.settings;
    settings.onSettingsChanged.add(onChangedSetting);

    await context.sync();
    console.log("Settings changed handler registered.");
});

Representa uma coleção de estilos associados à pasta de trabalho.

readonly styles: Excel.StyleCollection;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.7

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/style.yaml

await Excel.run(async (context) => {
    let styles = context.workbook.styles;

    // Add a new style to the style collection.
    // Styles is in the Home tab ribbon.
    styles.add("Diagonal Orientation Style");
          
    let newStyle = styles.getItem("Diagonal Orientation Style");
    
    // The "Diagonal Orientation Style" properties.
    newStyle.textOrientation = 38;
    newStyle.autoIndent = true;
    newStyle.includeProtection = true;
    newStyle.shrinkToFit = true;
    newStyle.locked = false;
    
    await context.sync();

    console.log("Successfully added a new style with diagonal orientation to the Home tab ribbon.");
});

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

True se os cálculos dessa pasta de trabalho forem efetuados usando apenas a precisão dos números conforme forem exibidos. Os dados perderão permanentemente a precisão ao alternar essa propriedade de false para true.

usePrecisionAsDisplayed: boolean;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.9

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 a célula ativa no momento da pasta de trabalho.

getActiveCell(): Excel.Range;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.7

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-get-active-cell.yaml

await Excel.run(async (context) => {

    let myWorkbook = context.workbook;
    let activeCell = myWorkbook.getActiveCell();
    activeCell.load("address");

    await context.sync();
    
    console.log("The active cell is " + activeCell.address);
});

Obtém o gráfico ativo no momento na pasta de trabalho. Se não houver nenhum gráfico ativo, uma ItemNotFound exceção será lançada.

getActiveChart(): Excel.Chart;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.9

Obtém o gráfico ativo no momento na pasta de trabalho. Se não houver um gráfico ativo, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte métodos e propriedades *OrNullObject.

getActiveChartOrNullObject(): Excel.Chart;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.9

Retorna true se a pasta de trabalho está sendo editada por vários usuários (por meio de coautoria). Esteja ciente de que pode haver algum atraso entre o momento em que o status da pasta de trabalho é alterado e quando as alterações são refletidas no resultado do método.

getIsActiveCollabSession(): OfficeExtension.ClientResult<boolean>;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.9

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

Obtém um ou mais intervalos atualmente selecionados da pasta de trabalho. Ao contrário de getSelectedRange(), esse método retorna um RangeAreas objeto que representa todos os intervalos selecionados.

getSelectedRanges(): Excel.RangeAreas;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.9

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-areas.yaml

await Excel.run(async (context) => {

    const selectedRanges = context.workbook.getSelectedRanges();
    selectedRanges.format.fill.color = "lightblue";

    await context.sync();
})

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 configuração de Salvamento Automático é alterada na pasta de trabalho.

readonly onAutoSaveSettingChanged: OfficeExtension.EventHandlers<Excel.WorkbookAutoSaveSettingChangedEventArgs>;

Tipo de Evento

Comentários

Conjunto de APIs: ExcelApi 1.9

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