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]

Representa uma coleção de comentários associados à pasta de trabalho.

readonly comments: Excel.CommentCollection;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.10]

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]

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]

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]

Retorna uma coleção de domínios de dados de entidades vinculadas que estão disponíveis na pasta de trabalho.

readonly linkedEntityDataDomains: Excel.LinkedEntityDataDomainCollection;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.19]

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]

Retorna uma coleção de todos os objetos de anotações na pasta de trabalho.

readonly notes: Excel.NoteCollection;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.18]

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]

Representa uma coleção de Tabelas Dinâmicas associadas à pasta de trabalho.

readonly pivotTableStyles: Excel.PivotTableStyleCollection;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.10]

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]

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]

Retorna uma coleção de consultas do Power Query que fazem parte da pasta de trabalho.

readonly queries: Excel.QueryCollection;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.14]

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]

Representa uma coleção de segmentações de dados associada à pasta de trabalho.

readonly slicers: Excel.SlicerCollection;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.10]

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

readonly slicerStyles: Excel.SlicerStyleCollection;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.10]

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]

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 TableStyles associadas à pasta de trabalho.

readonly tableStyles: Excel.TableStyleCollection;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.10]

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

readonly timelineStyles: Excel.TimelineStyleCollection;

Valor da propriedade

Comentários

[Conjunto de apis: ExcelApi 1.10]

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]

Fechar a pasta de trabalho atual.

close(closeBehavior?: Excel.CloseBehavior): void;

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.11]

Fechar a pasta de trabalho atual.

close(closeBehavior?: "Save" | "SkipSave"): void;

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.11]

Obtém a célula ativa no momento da pasta de trabalho.

getActiveCell(): Excel.Range;

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.7]

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]

Obtém a forma ativa na pasta de trabalho. Lançará um ItemNotFound erro se não houver nenhuma forma ativa.

getActiveShape(): Excel.Shape;

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.19]

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

getActiveShapeOrNullObject(): Excel.Shape;

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.19]

Obtém a segmentação de dados ativa no momento na pasta de trabalho. Se não houver nenhuma segmentação ativa, uma ItemNotFound exceção será lançada.

getActiveSlicer(): Excel.Slicer;

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.10]

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

getActiveSlicerOrNullObject(): Excel.Slicer;

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.10]

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]

Retorna um LinkedEntityCellValue com base no .LinkedEntityId

getLinkedEntityCellValue(linkedEntityCellValueId: LinkedEntityId): OfficeExtension.ClientResult<LinkedEntityCellValue>;

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.16]

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]

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]

Insere as planilhas especificadas de uma pasta de trabalho de origem na pasta de trabalho atual.

A extensionHardening chave do Registro do Windows afeta essa API. A extensão de arquivo definida pelo base64File parâmetro deve corresponder ao tipo de arquivo real do arquivo inserido. Se extensionHardening estiver definido para negar incompatibilidades e a extensão do arquivo não corresponder ao tipo de arquivo real, essa API gerará o seguinte erro: "Esta operação não é permitida devido à política de proteção de extensão."

insertWorksheetsFromBase64(base64File: string, options?: Excel.InsertWorksheetOptions): OfficeExtension.ClientResult<string[]>;

Parâmetros

Retornos

Uma matriz de IDs correspondente a cada planilha recém-inserida.

Comentários

[Conjunto de apis: ExcelApi 1.13]

Atualmente, essa API só tem suporte para o Office no Windows, Mac e na Web. No Excel na Web, essa API não dá suporte à inserção de gráficos, comentários, Tabelas Dinâmicas ou segmentaçã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.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

Salvar a pasta de trabalho atual.

save(saveBehavior?: Excel.SaveBehavior): void;

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.11]

Salvar a pasta de trabalho atual.

save(saveBehavior?: "Save" | "Prompt"): void;

Parâmetros

Retornos

Comentários

[Conjunto de apis: ExcelApi 1.11]

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 pasta de trabalho é ativada. Observação: esse evento não será acionado quando a pasta de trabalho for aberta.

readonly onActivated: OfficeExtension.EventHandlers<Excel.WorkbookActivatedEventArgs>;

Tipo de Evento

Comentários

[Conjunto de apis: ExcelApi 1.13]

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]