Excel.Workbook class

Representa la instancia de la aplicación de Excel que contiene este libro.

readonly application: Excel.Application;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.1]

Especifica si el libro está en modo Autoguardado.

readonly autoSave: boolean;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.9]

Representa una colección de enlaces que forman parte del libro.

readonly bindings: Excel.BindingCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.1]

Devuelve un número acerca de la versión del motor de cálculo de Excel.

readonly calculationEngineVersion: number;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.9]

True si todos los gráficos en el libro están siguiendo los puntos de datos reales a los que están conectados. Falso si los gráficos realizan un seguimiento del índice de los puntos de datos.

chartDataPointTrack: boolean;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.9]

Representa un conjunto de comentarios asociados al libro.

readonly comments: Excel.CommentCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.10]

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

Representa la colección de elementos XML personalizados que contiene este libro.

readonly customXmlParts: Excel.CustomXmlPartCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.5]

Representa todas las conexiones de datos del libro.

readonly dataConnections: Excel.DataConnectionCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.7]

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

[Conjunto de API: ExcelApi 1.2]

Especifica si se han realizado cambios desde la última vez que se guardó el libro. Puede establecer esta propiedad en true si desea cerrar un libro modificado sin guardarlo o sin que se le pida que lo guarde.

isDirty: boolean;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.9]

Devuelve una colección de dominios de datos de entidades vinculadas que están disponibles en el libro.

readonly linkedEntityDataDomains: Excel.LinkedEntityDataDomainCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.19]

Obtiene el nombre del libro.

readonly name: string;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.7]

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

[Conjunto de API: ExcelApi 1.1]

Devuelve una colección de todos los objetos de notas del libro.

readonly notes: Excel.NoteCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.18]

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]

Representa una colección de PivotTableStyles asociados con el libro.

readonly pivotTableStyles: Excel.PivotTableStyleCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.10]

Especifica si el libro se ha guardado alguna vez de forma local o en línea.

readonly previouslySaved: boolean;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.9]

Obtiene las propiedades del libro.

readonly properties: Excel.DocumentProperties;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.7]

Devuelve el objeto de protección de un libro.

readonly protection: Excel.WorkbookProtection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.7]

Devuelve una colección de consultas de Power Query que forman parte del libro.

readonly queries: Excel.QueryCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.14]

Devuelve true si el libro está abierto en modo de solo lectura.

readonly readOnly: boolean;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.8]

Representa un conjunto de opciones de configuración asociadas al libro.

readonly settings: Excel.SettingCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.4]

Representa una colección de segmentaciones asociada al libro.

readonly slicers: Excel.SlicerCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.10]

Representa una colección de SlicerStyles asociados con el libro.

readonly slicerStyles: Excel.SlicerStyleCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.10]

Representa una colección de estilos asociada con el libro.

readonly styles: Excel.StyleCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.7]

Representa una colección de tablas asociadas con el libro.

readonly tables: Excel.TableCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.1]

Representa una colección de TableStyles asociados con el libro.

readonly tableStyles: Excel.TableStyleCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.10]

Representa una colección de TimelineStyles asociados con el libro.

readonly timelineStyles: Excel.TimelineStyleCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.10]

True si los cálculos de este libro se llevan a cabo con la misma precisión con que se muestran los números. Los datos perderán permanentemente la precisión al cambiar esta propiedad de false a true.

usePrecisionAsDisplayed: boolean;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.9]

Representa una colección de hojas de cálculo asociadas con el libro.

readonly worksheets: Excel.WorksheetCollection;

Valor de propiedad

Comentarios

[Conjunto de API: ExcelApi 1.1]

Cierra el libro actual.

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

Parámetros

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.11]

Cierra el libro actual.

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

Parámetros

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.11]

Obtiene la celda activa del libro.

getActiveCell(): Excel.Range;

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.7]

Obtiene el gráfico activo del libro. Si no hay ningún gráfico activo, se produce una ItemNotFound excepción.

getActiveChart(): Excel.Chart;

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.9]

Obtiene el gráfico activo del libro. Si no hay ningún gráfico activo, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.

getActiveChartOrNullObject(): Excel.Chart;

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.9]

Obtiene la forma activa en el libro. Genera un ItemNotFound error si no hay ninguna forma activa.

getActiveShape(): Excel.Shape;

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.19]

Obtiene la forma activa en el libro. Si no hay ninguna forma activa, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea las propiedades y métodos *OrNullObject.

getActiveShapeOrNullObject(): Excel.Shape;

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.19]

Obtiene la segmentación activa del libro. Si no hay ninguna segmentación activa, se produce una ItemNotFound excepción.

getActiveSlicer(): Excel.Slicer;

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.10]

Obtiene la segmentación activa del libro. Si no hay ninguna segmentación activa, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea los métodos y propiedades *OrNullObject.

getActiveSlicerOrNullObject(): Excel.Slicer;

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.10]

Devuelve true si el libro de trabajo está siendo editado por varios usuarios (a través de la coautoría). Tenga en cuenta que puede haber algún retraso entre el momento en que cambia el estado del libro y el momento en que los cambios se reflejan en el resultado del método.

getIsActiveCollabSession(): OfficeExtension.ClientResult<boolean>;

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.9]

Devuelve un LinkedEntityCellValue en función del archivo LinkedEntityId.

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

Parámetros

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.16]

Obtiene del libro el rango único seleccionado actualmente. Si hay varios rangos seleccionados, este método producirá un error.

getSelectedRange(): Excel.Range;

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.1]

Obtiene los intervalos seleccionados actualmente en el libro. A diferencia de getSelectedRange(), este método devuelve un RangeAreas objeto que representa todos los rangos seleccionados.

getSelectedRanges(): Excel.RangeAreas;

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.9]

Inserta las hojas de cálculo especificadas de un libro de origen en el libro actual.

La extensionHardening clave del Registro de Windows afecta a esta API. La extensión de archivo definida por el base64File parámetro debe coincidir con el tipo de archivo real del archivo insertado. Si extensionHardening se establece en Denegar discrepancias y la extensión de archivo no coincide con el tipo de archivo real, esta API genera el siguiente error: "Esta operación no se permite debido a la directiva de protección de extensión".

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

Parámetros

Devoluciones

Una matriz de identificadores correspondiente a cada hoja de cálculo recién insertada.

Comentarios

[Conjunto de API: ExcelApi 1.13]

Actualmente, esta API solo se admite para Office en Windows, Mac y la Web. En Excel en la Web, esta API no admite la inserción de gráficos, comentarios, tablas dinámicas ni segmentaciones.

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

Devoluciones

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

Devoluciones

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

Devoluciones

Guarda el libro actual.

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

Parámetros

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.11]

Guarda el libro actual.

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

Parámetros

Devoluciones

Comentarios

[Conjunto de API: ExcelApi 1.11]

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

Devoluciones

Establece varias propiedades en el objeto al mismo tiempo, basadas en un objeto cargado existente.

set(properties: Excel.Workbook): void;

Parámetros

Devoluciones

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

Ocurre cuando se activa el libro. Nota: Este evento no se activará cuando se abra el libro.

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

Tipo de evento

Comentarios

[Conjunto de API: ExcelApi 1.13]

Se produce cuando se cambia la configuración de Autoguardado en el libro.

readonly onAutoSaveSettingChanged: OfficeExtension.EventHandlers<Excel.WorkbookAutoSaveSettingChangedEventArgs>;

Tipo de evento

Comentarios

[Conjunto de API: ExcelApi 1.9]

Se genera al cambiar la selección en el documento.

readonly onSelectionChanged: OfficeExtension.EventHandlers<Excel.SelectionChangedEventArgs>;

Tipo de evento

Comentarios

[Conjunto de API: ExcelApi 1.2]