Excel.Workbook class
A pasta de trabalho é o objeto de nível superior que contém objetos de pasta de trabalho relacionados, como planilhas, tabelas e intervalos. Para saber mais sobre o modelo de objeto de pasta de trabalho, leia Trabalhar com pastas de trabalho usando a API JavaScript do Excel.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.1 ]
Propriedades
| application | Representa a instância de aplicativo do Excel que contém essa pasta de trabalho. |
| auto |
Especifica se a pasta de trabalho está no modo AutoSave. |
| bindings | Representa uma coleção de ligações que fazem parte da pasta de trabalho. |
| calculation |
Retorna um número sobre a versão do Mecanismo de Cálculo do Excel. |
| chart |
True se todos os gráficos na pasta de trabalho estiverem rastreando os pontos de dados reais aos quais eles estão anexados. False se os gráficos acompanharem o índice dos pontos de dados. |
| comments | Representa uma coleção de comentários associados à pasta de trabalho. |
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| custom |
Representa a coleção de partes XML personalizadas contidas por esta pasta de trabalho. |
| data |
Representa todas as conexões de dados na pasta de trabalho. |
| functions | Representa uma coleção de funções de planilha que podem ser usadas para computação. |
| is |
Especifica se foram feitas alterações desde que a pasta de trabalho foi salva pela última vez. Você pode definir essa propriedade como |
| name | Obtém o nome da pasta de trabalho. |
| names | Representa uma coleção de itens nomeados com escopo de pasta de trabalho (intervalos e constantes nomeados). |
| pivot |
Representa uma coleção de Tabelas Dinâmicas associadas à pasta de trabalho. |
| pivot |
Representa uma coleção de Tabelas Dinâmicas associadas à pasta de trabalho. |
| previously |
Especifica se a pasta de trabalho já foi salva localmente ou online. |
| properties | Obtém as propriedades da pasta de trabalho. |
| protection | Retorna o objeto de proteção para uma pasta de trabalho. |
| read |
Retornará |
| settings | Representa uma coleção de configurações associadas à pasta de trabalho. |
| slicers | Representa uma coleção de segmentações associadas à pasta de trabalho. |
| slicer |
Representa uma coleção de SlicerStyles associados à pasta de trabalho. |
| styles | Representa uma coleção de estilos associados à pasta de trabalho. |
| tables | Representa uma coleção de tabelas associadas à pasta de trabalho. |
| table |
Representa uma coleção de TableStyles associadas à pasta de trabalho. |
| timeline |
Representa uma coleção de TimelineStyles associados à pasta de trabalho. |
| use |
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 |
| worksheets | Representa uma coleção de planilhas associadas à pasta de trabalho. |
Métodos
| get |
Obtém a célula ativa no momento da pasta de trabalho. |
| get |
Obtém o gráfico ativo no momento na pasta de trabalho. Se não houver um gráfico ativo, uma exceção |
| get |
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 |
| get |
Obtém a segmentação de dados ativa no momento na pasta de trabalho. Se não houver uma segmentação ativa, uma exceção |
| get |
Obtém a segmentação de dados ativa no momento na pasta de trabalho. Se não houver uma segmentação ativa, esse método retornará um objeto com sua |
| get |
Retornará |
| get |
Obtém o intervalo único selecionado atualmente na pasta de trabalho. Se houver vários intervalos selecionados, esse método gerará um erro. |
| get |
Obtém um ou mais intervalos atualmente selecionados da pasta de trabalho. Ao contrário |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| set(properties, options) | 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) | Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente. |
| toJSON() | Substitui o método JavaScript |
Eventos
| on |
Ocorre quando a configuração AutoSave é alterada na pasta de trabalho. |
| on |
Ocorre quando a seleção no documento é alterada. |
Detalhes da propriedade
application
Representa a instância de aplicativo do Excel que contém essa pasta de trabalho.
readonly application: Excel.Application;Valor da propriedade
Comentários
autoSave
Especifica se a pasta de trabalho está no modo AutoSave.
readonly autoSave: boolean;Valor da propriedade
boolean
Comentários
bindings
Representa uma coleção de ligações que fazem parte da pasta de trabalho.
readonly bindings: Excel.BindingCollection;Valor da propriedade
Comentários
calculationEngineVersion
Retorna um número sobre a versão do Mecanismo de Cálculo do Excel.
readonly calculationEngineVersion: number;Valor da propriedade
number
Comentários
chartDataPointTrack
True se todos os gráficos na pasta de trabalho estiverem rastreando os pontos de dados reais aos quais eles estão anexados. False se os gráficos acompanharem o índice dos pontos de dados.
chartDataPointTrack: boolean;Valor da propriedade
boolean
Comentários
comments
Representa uma coleção de comentários associados à pasta de trabalho.
readonly comments: Excel.CommentCollection;Valor da propriedade
Comentários
context
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
customXmlParts
Representa a coleção de partes XML personalizadas contidas por esta pasta de trabalho.
readonly customXmlParts: Excel.CustomXmlPartCollection;Valor da propriedade
Comentários
dataConnections
Representa todas as conexões de dados na pasta de trabalho.
readonly dataConnections: Excel.DataConnectionCollection;Valor da propriedade
Comentários
functions
Representa uma coleção de funções de planilha que podem ser usadas para computação.
readonly functions: Excel.Functions;Valor da propriedade
Comentários
isDirty
Especifica se foram feitas alterações desde que a pasta de trabalho foi salva pela última vez. Você pode definir essa propriedade como true se quiser fechar uma pasta de trabalho modificada sem salvá-la ou ser solicitada a salvá-la.
isDirty: boolean;Valor da propriedade
boolean
Comentários
name
Obtém o nome da pasta de trabalho.
readonly name: string;Valor da propriedade
string
Comentários
names
Representa uma coleção de itens nomeados com escopo de pasta de trabalho (intervalos e constantes nomeados).
readonly names: Excel.NamedItemCollection;Valor da propriedade
Comentários
pivotTables
Representa uma coleção de Tabelas Dinâmicas associadas à pasta de trabalho.
readonly pivotTables: Excel.PivotTableCollection;Valor da propriedade
Comentários
[ Conjunto de API: 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}`);
});
});
pivotTableStyles
Representa uma coleção de Tabelas Dinâmicas associadas à pasta de trabalho.
readonly pivotTableStyles: Excel.PivotTableStyleCollection;Valor da propriedade
Comentários
previouslySaved
Especifica se a pasta de trabalho já foi salva localmente ou online.
readonly previouslySaved: boolean;Valor da propriedade
boolean
Comentários
properties
Obtém as propriedades da pasta de trabalho.
readonly properties: Excel.DocumentProperties;Valor da propriedade
Comentários
[ Conjunto de API: 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.");
});
protection
Retorna o objeto de proteção para uma pasta de trabalho.
readonly protection: Excel.WorkbookProtection;Valor da propriedade
Comentários
readOnly
Retornará true se a pasta de trabalho estiver aberta no modo somente leitura.
readonly readOnly: boolean;Valor da propriedade
boolean
Comentários
settings
Representa uma coleção de configurações associadas à pasta de trabalho.
readonly settings: Excel.SettingCollection;Valor da propriedade
Comentários
slicers
Representa uma coleção de segmentações associadas à pasta de trabalho.
readonly slicers: Excel.SlicerCollection;Valor da propriedade
Comentários
slicerStyles
Representa uma coleção de SlicerStyles associados à pasta de trabalho.
readonly slicerStyles: Excel.SlicerStyleCollection;Valor da propriedade
Comentários
styles
Representa uma coleção de estilos associados à pasta de trabalho.
readonly styles: Excel.StyleCollection;Valor da propriedade
Comentários
[ Conjunto de API: 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.");
});
tables
Representa uma coleção de tabelas associadas à pasta de trabalho.
readonly tables: Excel.TableCollection;Valor da propriedade
Comentários
tableStyles
Representa uma coleção de TableStyles associadas à pasta de trabalho.
readonly tableStyles: Excel.TableStyleCollection;Valor da propriedade
Comentários
timelineStyles
Representa uma coleção de TimelineStyles associados à pasta de trabalho.
readonly timelineStyles: Excel.TimelineStyleCollection;Valor da propriedade
Comentários
usePrecisionAsDisplayed
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
boolean
Comentários
worksheets
Representa uma coleção de planilhas associadas à pasta de trabalho.
readonly worksheets: Excel.WorksheetCollection;Valor da propriedade
Comentários
Detalhes do método
getActiveCell()
Obtém a célula ativa no momento da pasta de trabalho.
getActiveCell(): Excel.Range;Retornos
Comentários
[ Conjunto de API: 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);
});
getActiveChart()
Obtém o gráfico ativo no momento na pasta de trabalho. Se não houver um gráfico ativo, uma exceção ItemNotFound será gerada.
getActiveChart(): Excel.Chart;Retornos
Comentários
getActiveChartOrNullObject()
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
getActiveSlicer()
Obtém a segmentação de dados ativa no momento na pasta de trabalho. Se não houver uma segmentação ativa, uma exceção ItemNotFound será gerada.
getActiveSlicer(): Excel.Slicer;Retornos
Comentários
getActiveSlicerOrNullObject()
Obtém a segmentação de dados ativa no momento na pasta de trabalho. Se não houver uma 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
getIsActiveCollabSession()
Retornará true se a pasta de trabalho estiver sendo editada por vários usuários (por meio da coautoria). Lembre-se de que pode haver algum atraso entre quando a pasta de trabalho status alterações e quando as alterações forem refletidas sobre o resultado do método.
getIsActiveCollabSession(): OfficeExtension.ClientResult<boolean>;Retornos
OfficeExtension.ClientResult<boolean>
Comentários
getSelectedRange()
Obtém o intervalo único selecionado atualmente na pasta de trabalho. Se houver vários intervalos selecionados, esse método gerará um erro.
getSelectedRange(): Excel.Range;Retornos
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);
});
getSelectedRanges()
Obtém um ou mais intervalos atualmente selecionados da pasta de trabalho. Ao contrário getSelectedRange()de , esse método retorna um RangeAreas objeto que representa todos os intervalos selecionados.
getSelectedRanges(): Excel.RangeAreas;Retornos
Comentários
[ Conjunto de API: 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();
})
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
Fornece opções para quais propriedades do objeto carregar.
Retornos
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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.
Retornos
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 de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.
Retornos
set(properties, options)
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
- properties
- Excel.Interfaces.WorkbookUpdateData
Um objeto JavaScript com propriedades estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base em um 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 é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.Workbook original é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.WorkbookData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.WorkbookData;Retornos
Detalhes do evento
onAutoSaveSettingChanged
Ocorre quando a configuração AutoSave é alterada na pasta de trabalho.
readonly onAutoSaveSettingChanged: OfficeExtension.EventHandlers<Excel.WorkbookAutoSaveSettingChangedEventArgs>;Tipo de evento
Comentários
onSelectionChanged
Ocorre quando a seleção no documento é alterada.
readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.SelectionChangedEventArgs>;Tipo de evento
Comentários
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de