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. False 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 una colección de comentarios asociados al libro.

readonly comments: Excel.CommentCollection;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

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

Representa la colección de elementos XML personalizados contenidos en 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 se pueden usar 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 true en si desea cerrar un libro modificado sin guardarlo o se le pide que lo guarde.

isDirty: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

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 con ámbito de libro (intervalos y constantes con nombre).

readonly names: Excel.NamedItemCollection;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.1 ]

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}`);
  });
});

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 localmente 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 ]

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.");
});

Devuelve el objeto de protección de un libro.

readonly protection: Excel.WorkbookProtection;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.7 ]

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 una colección de valores asociados al libro.

readonly settings: Excel.SettingCollection;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.4 ]

Representa una colección de segmentaciones de datos asociadas 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 ]

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.");
});

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 precisión de forma permanente 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 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-save-and-close.yaml

await Excel.run(async (context) => {
    context.workbook.close(Excel.CloseBehavior.save);
});

Cierra el libro actual.

close(closeBehaviorString?: "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 ]

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);
});

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 *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getActiveChartOrNullObject(): Excel.Chart;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

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 de datos activa, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getActiveSlicerOrNullObject(): Excel.Slicer;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.10 ]

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

getIsActiveCollabSession(): OfficeExtension.ClientResult<boolean>;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

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);
});

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

getSelectedRanges(): Excel.RangeAreas;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Ejemplos

// 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();
})

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 ]

Ejemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/workbook-save-and-close.yaml

await Excel.run(async (context) => {
    context.workbook.save(Excel.SaveBehavior.save);
});

Guarda el libro actual.

save(saveBehaviorString?: "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 de API del mismo tipo.

set(properties: Interfaces.WorkbookUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

Devoluciones

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: Excel.Workbook): void;

Parámetros

Devoluciones

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 Excel.Workbook original 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

Se produce cuando se cambia la configuración Autoguardar 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 ]