Excel.Workbook class
Libro es el objeto de nivel superior que contiene objetos de libro relacionados, como hojas de cálculo, tablas y rangos. Para obtener más información sobre el modelo de objetos de libro, lea Trabajar con libros mediante la API de JavaScript de Excel.
- Extends
Comentarios
Usada por
Ejemplos
// 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);
});
Propiedades
| application | Representa la instancia de la aplicación de Excel que contiene este libro. |
| bindings | Representa una colección de enlaces que forman parte del libro. |
| context | El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office. |
| functions | Representa una colección de funciones de hoja de cálculo que pueden usarse para el cálculo. |
| names | Representa una colección de elementos con nombre (rangos con nombre y constantes) en el ámbito de un libro. |
| pivot |
Representa una colección de tablas dinámicas asociadas con el libro. |
| settings | Representa un conjunto de opciones de configuración asociadas al libro. |
| tables | Representa una colección de tablas asociadas con el libro. |
| worksheets | Representa una colección de hojas de cálculo asociadas con el libro. |
Métodos
| get |
Obtiene del libro el rango único seleccionado actualmente. Si hay varios rangos seleccionados, este método producirá un error. |
| load(options) | Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| load(property |
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a |
| set(properties, options) | Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo. |
| set(properties) | Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente. |
| toJSON() | Reemplaza el método JavaScript |
Eventos
| on |
Se genera al cambiar la selección en el documento. |
Detalles de las propiedades
application
Representa la instancia de la aplicación de Excel que contiene este libro.
readonly application: Excel.Application;Valor de propiedad
Comentarios
bindings
Representa una colección de enlaces que forman parte del libro.
readonly bindings: Excel.BindingCollection;Valor de propiedad
Comentarios
context
El contexto de solicitud asociado al objeto. De esta forma, se conecta el proceso del complemento con el proceso de la aplicación host de Office.
context: RequestContext;Valor de propiedad
functions
Representa una colección de funciones de hoja de cálculo que pueden usarse para el cálculo.
readonly functions: Excel.Functions;Valor de propiedad
Comentarios
Ejemplos
// 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);
});
names
Representa una colección de elementos con nombre (rangos con nombre y constantes) en el ámbito de un libro.
readonly names: Excel.NamedItemCollection;Valor de propiedad
Comentarios
pivotTables
Representa una colección de tablas dinámicas asociadas con el libro.
readonly pivotTables: Excel.PivotTableCollection;Valor de propiedad
Comentarios
Ejemplos
// 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}`);
});
});
settings
Representa un conjunto de opciones de configuración asociadas al libro.
readonly settings: Excel.SettingCollection;Valor de propiedad
Comentarios
Ejemplos
// 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.");
});
tables
Representa una colección de tablas asociadas con el libro.
readonly tables: Excel.TableCollection;Valor de propiedad
Comentarios
worksheets
Representa una colección de hojas de cálculo asociadas con el libro.
readonly worksheets: Excel.WorksheetCollection;Valor de propiedad
Comentarios
Ejemplos
// 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);
}
});
Detalles del método
getSelectedRange()
Obtiene del libro el rango único seleccionado actualmente. Si hay varios rangos seleccionados, este método producirá un error.
getSelectedRange(): Excel.Range;Devoluciones
Comentarios
Ejemplos
await Excel.run(async (context) => {
const selectedRange = context.workbook.getSelectedRange();
selectedRange.load('address');
await context.sync();
console.log(selectedRange.address);
});
load(options)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(options?: Excel.Interfaces.WorkbookLoadOptions): Excel.Workbook;Parámetros
Proporciona opciones para las propiedades del objeto que se van a cargar.
Devoluciones
load(propertyNames)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames?: string | string[]): Excel.Workbook;Parámetros
- propertyNames
-
string | string[]
Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.
Devoluciones
load(propertyNamesAndPaths)
Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.Workbook;Parámetros
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.
Devoluciones
set(properties, options)
Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto API del mismo tipo.
set(properties: Interfaces.WorkbookUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.WorkbookUpdateData
Un objeto JavaScript con propiedades que están estructuradas isomorfamente a las propiedades del objeto en el que se llama al método.
- options
- OfficeExtension.UpdateOptions
Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.
Devoluciones
void
set(properties)
Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente.
set(properties: Excel.Workbook): void;Parámetros
- properties
- Excel.Workbook
Devoluciones
void
toJSON()
Reemplaza el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto API a JSON.stringify(). (JSON.stringify, a su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.Workbook es un objeto API, el toJSON método devuelve un objeto JavaScript simple (escrito como Excel.Interfaces.WorkbookData) que contiene copias superficiales de cualquier propiedad secundaria cargada del objeto original.
toJSON(): Excel.Interfaces.WorkbookData;Devoluciones
Detalles del evento
onSelectionChanged
Se genera al cambiar la selección en el documento.
readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.SelectionChangedEventArgs>;