Excel.Workbook class
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
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. |
| custom |
Representa a coleção de peças XML personalizadas contidas neste livro. |
| data |
Representa todas as ligações de dados no livro. |
| functions | Representa uma coleção de funções de folha de cálculo que podem ser utilizadas para computação. |
| name | Obtém o nome da pasta de trabalho. |
| names | Representa uma coleção de itens nomeados com âmbito de livro (intervalos com nome e constantes). |
| pivot |
Representa uma coleção de Tabelas Dinâmicas associadas à pasta de trabalho. |
| properties | Obtém as propriedades da pasta de trabalho. |
| protection | Devolve o objeto de proteção de um livro. |
| read |
Devolve |
| settings | Representa uma coleção de definições associadas ao livro. |
| styles | Representa uma coleção de estilos associados à pasta de trabalho. |
| tables | Representa uma coleção de tabelas associadas à pasta de trabalho. |
| 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 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 |
| 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. 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 |
Eventos
| on |
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
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
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
customXmlParts
Representa a coleção de peças XML personalizadas contidas neste livro.
readonly customXmlParts: Excel.CustomXmlPartCollection;Valor da propriedade
Comentários
dataConnections
Representa todas as ligações de dados no livro.
readonly dataConnections: Excel.DataConnectionCollection;Valor da propriedade
Comentários
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
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 âmbito de livro (intervalos com nome e constantes).
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}`);
});
});
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
Devolve o objeto de proteção de um livro.
readonly protection: Excel.WorkbookProtection;Valor da propriedade
Comentários
readOnly
Devolve true se o livro estiver aberto no modo só de leitura.
readonly readOnly: boolean;Valor da propriedade
boolean
Comentários
settings
Representa uma coleção de definições associadas ao livro.
readonly settings: Excel.SettingCollection;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
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);
});
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
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
Fornece opções para as propriedades do objeto a 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 delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
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 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
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
Detalhes do evento
onSelectionChanged
Ocorre quando a seleção no documento é alterada.
readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.SelectionChangedEventArgs>;