Excel.Workbook class

Pacote:

excel

O livro é o objeto de nível superior que contém objetos relacionados do livro, como folhas de cálculo, tabelas e intervalos. Para saber mais sobre o modelo de objeto do livro, leia Trabalhar com livros com a API javaScript do Excel.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Propriedades

application	Representa a instância da aplicação Excel que contém este livro.
bindings	Representa uma coleção de ligações que fazem parte da pasta de trabalho.
context	O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.
functions	Representa uma coleção de funções de folha de cálculo que podem ser utilizadas para computação.
names	Representa uma coleção de itens nomeados com âmbito de livro (intervalos com nome e constantes).
tables	Representa uma coleção de tabelas associadas à pasta de trabalho.
worksheets	Representa uma coleção de planilhas associadas à pasta de trabalho.

Métodos

getSelectedRange()	Obtém o intervalo único selecionado atualmente a partir do livro. Se existirem vários intervalos selecionados, este método gerará um erro.
load(options)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.
set(properties, options)	Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
toJSON()	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.Workbook é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.WorkbookData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

Eventos

onSelectionChanged

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

Detalhes da propriedade

application

Representa a instância da aplicação Excel que contém este livro.

readonly application: Excel.Application;

Valor da propriedade

Excel.Application

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

bindings

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

readonly bindings: Excel.BindingCollection;

Valor da propriedade

Excel.BindingCollection

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

context

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

Excel.RequestContext

functions

Representa uma coleção de funções de folha de cálculo que podem ser utilizadas para computação.

readonly functions: Excel.Functions;

Valor da propriedade

Excel.Functions

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

names

Representa uma coleção de itens nomeados com âmbito de livro (intervalos com nome e constantes).

readonly names: Excel.NamedItemCollection;

Valor da propriedade

Excel.NamedItemCollection

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

tables

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

readonly tables: Excel.TableCollection;

Valor da propriedade

Excel.TableCollection

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

worksheets

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

readonly worksheets: Excel.WorksheetCollection;

Valor da propriedade

Excel.WorksheetCollection

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Detalhes do método

getSelectedRange()

Obtém o intervalo único selecionado atualmente a partir do livro. Se existirem vários intervalos selecionados, este método gerará um erro.

getSelectedRange(): Excel.Range;

Retornos

Excel.Range

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

Exemplos

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

load(options)

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

options

Excel.Interfaces.WorkbookLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Excel.Workbook

load(propertyNames)

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

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Excel.Workbook

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.

Retornos

Excel.Workbook

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

properties

Excel.Interfaces.WorkbookUpdateData

Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options

OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

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

set(properties: Excel.Workbook): void;

Parâmetros

properties

Excel.Workbook

Retornos

void

toJSON()

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.Workbook é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.WorkbookData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.WorkbookData;

Retornos

Excel.Interfaces.WorkbookData

Detalhes do evento

onSelectionChanged

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

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

Tipo de evento

OfficeExtension.EventHandlers<Excel.SelectionChangedEventArgs>

Comentários

[ Conjunto de API: ExcelApi 1.2 ]