Excel.Workbook class

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

readonly application: Excel.Application;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Représente une collection de liaisons appartenant au classeur.

readonly bindings: Excel.BindingCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Représente l’ensemble des parties XML personnalisées contenues dans ce classeur.

readonly customXmlParts: Excel.CustomXmlPartCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.5

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/18-custom-xml-parts/test-xml-for-unique-namespace.yaml

await Excel.run(async (context) => {
    document.getElementById("display-xml").textContent = "";
    const customXmlParts = context.workbook.customXmlParts;
    customXmlParts.load("items");

    await context.sync();

    for (let i = 0; i < customXmlParts.items.length; i++) {
        customXmlParts.items[i].delete();
    }

    await context.sync();
});

Représente toutes les connexions de données dans le classeur.

readonly dataConnections: Excel.DataConnectionCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Représente un ensemble de fonctions de feuille de calcul pouvant être utilisées pour le calcul.

readonly functions: Excel.Functions;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.2

Exemples

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

Obtient le nom du classeur.

readonly name: string;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

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

readonly names: Excel.NamedItemCollection;

Valeur de propriété

Remarques

Jeu 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

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

Obtient les propriétés du classeur.

readonly properties: Excel.DocumentProperties;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

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

Renvoie l’objet de protection pour un classeur.

readonly protection: Excel.WorkbookProtection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

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

await Excel.run(async (context) => {
    const workbook: Excel.Workbook = context.workbook;
    workbook.protection.unprotect();
});

Représente un ensemble de paramètres associés au classeur.

readonly settings: Excel.SettingCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.4

Exemples

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

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

readonly styles: Excel.StyleCollection;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

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

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

readonly tables: Excel.TableCollection;

Valeur de propriété

Remarques

Jeu 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

Jeu d’API : ExcelApi 1.1

Exemples

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

Obtient la cellule active du classeur.

getActiveCell(): Excel.Range;

Retours

Remarques

Jeu d’API : ExcelApi 1.7

Exemples

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

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

getSelectedRange(): Excel.Range;

Retours

Remarques

Jeu 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 transmettre soit un objet ordinaire avec les propriétés appropriées, soit 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.stringify, à son tour, appelle 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 simple (typé ) Excel.Interfaces.WorkbookDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir 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

Jeu d’API : ExcelApi 1.2