Excel.Workbook class

Représente l’application Excel instance qui contient ce classeur.

readonly application: Excel.Application;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Représente une collection de liaisons appartenant au classeur.

readonly bindings: Excel.BindingCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Représente une collection de fonctions de feuille de calcul qui peuvent être utilisées pour le calcul.

readonly functions: Excel.Functions;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

Représente une collection d’éléments nommés de portée classeur (plages et constantes nommées).

readonly names: Excel.NamedItemCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Représente une collection de tableaux croisés dynamiques associés au classeur.

readonly pivotTables: Excel.PivotTableCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.3 ]

Exemples

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

Représente une collection de tableaux associés au classeur.

readonly tables: Excel.TableCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Représente une collection de feuilles de calcul associées au classeur.

readonly worksheets: Excel.WorksheetCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Obtient la plage unique actuellement sélectionnée à partir du classeur. Si plusieurs plages sont sélectionnées, cette méthode génère une erreur.

getSelectedRange(): Excel.Range;

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Exemples

await Excel.run(async (context) => { 
    const selectedRange = context.workbook.getSelectedRange();
    selectedRange.load('address');
    await context.sync();
    console.log(selectedRange.address);
});

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.WorkbookLoadOptions): Excel.Workbook;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.Workbook;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Workbook;

Paramètres

Retours

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

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

Paramètres

Retours

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.Workbook): void;

Paramètres

Retours

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.Workbook est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.WorkbookDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): Excel.Interfaces.WorkbookData;

Retours

Se produit quand la sélection change dans le document.

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

Type d'événement

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]