Excel.Workbook class
Workbook 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 Trabajo con libros mediante la API de JavaScript de Excel.
- Extends
Comentarios
[ Conjunto de API: ExcelApi 1.1 ]
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 | Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office. |
| custom |
Representa la colección de elementos XML personalizados contenidos en este libro. |
| data |
Representa todas las conexiones de datos del libro. |
| functions | Representa una colección de funciones de hoja de cálculo que se pueden usar para el cálculo. |
| name | Obtiene el nombre del libro. |
| names | Representa una colección de elementos con nombre con ámbito de libro (intervalos y constantes con nombre). |
| pivot |
Representa una colección de tablas dinámicas asociadas con el libro. |
| properties | Obtiene las propiedades del libro. |
| protection | Devuelve el objeto de protección de un libro. |
| read |
Devuelve |
| settings | Representa una colección de valores asociados al libro. |
| styles | Representa una colección de estilos asociada con el 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 la celda activa del libro. |
| get |
Obtiene el intervalo único seleccionado actualmente del libro. Si hay varios intervalos 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 de API del mismo tipo. |
| set(properties) | Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente. |
| toJSON() | Invalida 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
Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
context: RequestContext;Valor de propiedad
customXmlParts
Representa la colección de elementos XML personalizados contenidos en este libro.
readonly customXmlParts: Excel.CustomXmlPartCollection;Valor de propiedad
Comentarios
dataConnections
Representa todas las conexiones de datos del libro.
readonly dataConnections: Excel.DataConnectionCollection;Valor de propiedad
Comentarios
functions
Representa una colección de funciones de hoja de cálculo que se pueden usar para el cálculo.
readonly functions: Excel.Functions;Valor de propiedad
Comentarios
name
Obtiene el nombre del libro.
readonly name: string;Valor de propiedad
string
Comentarios
names
Representa una colección de elementos con nombre con ámbito de libro (intervalos y constantes con nombre).
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
[ Conjunto de API: ExcelApi 1.3 ]
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}`);
});
});
properties
Obtiene las propiedades del libro.
readonly properties: Excel.DocumentProperties;Valor de propiedad
Comentarios
[ Conjunto de API: ExcelApi 1.7 ]
Ejemplos
// 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
Devuelve el objeto de protección de un libro.
readonly protection: Excel.WorkbookProtection;Valor de propiedad
Comentarios
readOnly
Devuelve true si el libro está abierto en modo de solo lectura.
readonly readOnly: boolean;Valor de propiedad
boolean
Comentarios
settings
Representa una colección de valores asociados al libro.
readonly settings: Excel.SettingCollection;Valor de propiedad
Comentarios
styles
Representa una colección de estilos asociada con el libro.
readonly styles: Excel.StyleCollection;Valor de propiedad
Comentarios
[ Conjunto de API: ExcelApi 1.7 ]
Ejemplos
// 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 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
Detalles del método
getActiveCell()
Obtiene la celda activa del libro.
getActiveCell(): Excel.Range;Devoluciones
Comentarios
[ Conjunto de API: ExcelApi 1.7 ]
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);
});
getSelectedRange()
Obtiene el intervalo único seleccionado actualmente del libro. Si hay varios intervalos seleccionados, este método producirá un error.
getSelectedRange(): Excel.Range;Devoluciones
Comentarios
[ Conjunto de API: ExcelApi 1.1 ]
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 de API del mismo tipo.
set(properties: Interfaces.WorkbookUpdateData, options?: OfficeExtension.UpdateOptions): void;Parámetros
- properties
- Excel.Interfaces.WorkbookUpdateData
Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al 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, en función de un objeto cargado existente.
set(properties: Excel.Workbook): void;Parámetros
- properties
- Excel.Workbook
Devoluciones
void
toJSON()
Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.Workbook es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.WorkbookData) que contiene copias superficiales de las propiedades secundarias cargadas 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>;