ExcelScript.Workbook interface

Ajoute une nouvelle liaison à une plage spécifique.

addBinding(
            range: Range | string,
            bindingType: BindingType,
            id: string
        ): Binding;

Paramètres

Retours

Ajoute une nouvelle liaison basée sur un élément nommé dans le classeur. Si l’élément nommé fait référence à plusieurs zones, l’erreur InvalidReference est retournée.

addBindingFromNamedItem(
            name: string,
            bindingType: BindingType,
            id: string
        ): Binding;

Paramètres

Retours

Ajoute une nouvelle liaison basée sur la sélection en cours. Si la sélection comporte plusieurs zones, l’erreur InvalidReference est retournée.

addBindingFromSelection(bindingType: BindingType, id: string): Binding;

Paramètres

Retours

Crée un nouveau commentaire avec le contenu donné sur la cellule donnée. Une InvalidArgument erreur est générée si la plage fournie est supérieure à une cellule.

addComment(
            cellAddress: Range | string,
            content: CommentRichContent | string,
            contentType?: ContentType
        ): Comment;

Paramètres

Retours

Ajoute une nouvelle partie XML personnalisée au classeur.

addCustomXmlPart(xml: string): CustomXmlPart;

Paramètres

Retours

Ajoute un nouveau nom à la collection de l’étendue donnée.

addNamedItem(
            name: string,
            reference: Range | string,
            comment?: string
        ): NamedItem;

Paramètres

Retours

Exemples

/**
 * This script creates a named formula and uses it in another part of the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a named item for a formula.
  // This formula is the sum of the cells F2:F21 on Sheet1.
  const namedItem: ExcelScript.NamedItem = workbook.addNamedItem(
    "GrandTotal", 
    "=SUM(Sheet1!$F$2:$F$21)", 
    "The sum of table sums."
  );

  // Add this named formula to a new sheet in the workbook.
  const otherSheet = workbook.addWorksheet();
  otherSheet.getRange("A1").setFormula(namedItem.getFormula());

  // Switch to the new worksheet.
  otherSheet.activate();
}

Ajoute un nouveau nom à la collection de l’étendue donnée à l’aide des paramètres régionaux de l’utilisateur pour la formule.

addNamedItemFormulaLocal(
            name: string,
            formula: string,
            comment?: string
        ): NamedItem;

Paramètres

Retours

Ajoutez un tableau croisé dynamique basé sur les données sources spécifiées et insérez-le dans la cellule supérieure gauche de la plage de destination.

addPivotTable(
            name: string,
            source: Range | string | Table,
            destination: Range | string
        ): PivotTable;

Paramètres

Retours

Exemples

/**
 * This script creates a PivotTable from an existing table and adds it to an existing worksheet.
 * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
 * It also assumes there is a worksheet named "PivotSheet".
 */
function main(workbook: ExcelScript.Workbook) {
  // Create a PivotTable based on a table in the current worksheet.
  let sheet = workbook.getActiveWorksheet();
  let table = sheet.getTables()[0];
  let pivotTable = workbook.addPivotTable("My Pivot", table, "PivotSheet!A1");

  // Add fields to the PivotTable to show "Sales" per "Type".
  pivotTable.addRowHierarchy(pivotTable.getHierarchy("Type"));
  pivotTable.addDataHierarchy(pivotTable.getHierarchy("Sales"));
}

Crée un vide PivotTableStyle avec le nom spécifié.

addPivotTableStyle(
            name: string,
            makeUniqueName?: boolean
        ): PivotTableStyle;

Paramètres

Retours

Ajoute un nouveau style à la collection.

addPredefinedCellStyle(name: string): void;

Paramètres

Retours

Ajoute un nouveau segment au classeur.

addSlicer(
            slicerSource: string | PivotTable | Table,
            sourceField: string | PivotField | number | TableColumn,
            slicerDestination?: string | Worksheet
        ): Slicer;

Paramètres

Retours

Exemples

/**
 * This script adds a slicer for an existing PivotTable.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the PivotTable named "Farm Pivot".
  const farmPivot = workbook.getPivotTable("Farm Pivot");

  // Create the slicer. 
  // Note that this assumes "Type" is already added as a hierarchy to the PivotTable.
  const fruitSlicer: ExcelScript.Slicer = workbook.addSlicer(
    farmPivot, /* The table or PivotTale to be sliced. */
    farmPivot.getHierarchy("Type").getFields()[0] /* What source field to use as the slicer options. */
  );

  // Select the items to display.
  fruitSlicer.selectItems(["Lemon", "Lime"]);

  // Set the left margin of the slicer.
  fruitSlicer.setLeft(400);
}

Crée un style de segment vide avec le nom spécifié.

addSlicerStyle(name: string, makeUniqueName?: boolean): SlicerStyle;

Paramètres

Retours

Crée une table. L’objet de plage ou l’adresse source détermine la feuille de calcul sous laquelle la table sera ajoutée. Si la table ne peut pas être ajoutée (par exemple, parce que l’adresse n’est pas valide ou que la table chevauche une autre table), une erreur est générée.

addTable(address: Range | string, hasHeaders: boolean): Table;

Paramètres

Retours

Exemples

/**
 * This sample converts the information in the first worksheet
 * into a table with headers.
*/
function main(workbook: ExcelScript.Workbook) {
  // This assumes there is one contiguous range in the first worksheet.
  const dataRange = workbook.getFirstWorksheet().getUsedRange();
  
  // Add a table at the workbook level.
  workbook.addTable(dataRange.getAddress(), true);
}

Crée un vide TableStyle avec le nom spécifié.

addTableStyle(name: string, makeUniqueName?: boolean): TableStyle;

Paramètres

Retours

Crée un vide TimelineStyle avec le nom spécifié.

addTimelineStyle(name: string, makeUniqueName?: boolean): TimelineStyle;

Paramètres

Retours

Ajoute une nouvelle feuille de calcul au classeur. La feuille de calcul est ajoutée à la fin des feuilles de calcul existantes. Si vous souhaitez activer la feuille de calcul qui vient d’être ajoutée, appelez-la .activate() .

addWorksheet(name?: string): Worksheet;

Paramètres

Retours

Exemples

/**
 * This script adds a new worksheet named "Data" to the workbook.
 * If a worksheet with that name already exists, the script logs a note.
 */
function main(workbook: ExcelScript.Workbook) {
  // Check if the "Data" worksheet already exists.
  if (workbook.getWorksheet("Data")) {
    console.log("The Data worksheet is already in the workbook.");
  } else {
    // Add a new worksheet.
    let worksheet = workbook.addWorksheet("Data");
  }
}

Interrompt tous les liens vers les classeurs liés. Une fois les liens rompus, toutes les formules référençant des liens de classeur sont entièrement supprimées et remplacées par les dernières valeurs récupérées.

breakAllLinksToLinkedWorkbooks(): void;

Retours

Obtient la cellule active du classeur.

getActiveCell(): Range;

Retours

Exemples

/**
 * This script logs the value of the current active cell. 
 * If multiple cells are selected, the top-leftmost cell will be logged.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current active cell in the workbook.
  let cell = workbook.getActiveCell();
  console.log(`The current cell's value is ${cell.getValue()}`);
}

Obtient la feuille de calcul active du classeur. S’il n’existe aucun graphique actif, cette méthode retourne undefined.

getActiveChart(): Chart;

Retours

Obtient le segment actif actuel du classeur. S’il n’existe aucun segment actif, cette méthode retourne undefined.

getActiveSlicer(): Slicer;

Retours

Obtient la feuille de calcul active du classeur.

getActiveWorksheet(): Worksheet;

Retours

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

getApplication(): Application;

Retours

Spécifie si le classeur est en mode Enregistrement automatique.

getAutoSave(): boolean;

Retours

Obtient un objet de liaison par ID. Si l’objet de liaison n’existe pas, cette méthode retourne undefined.

getBinding(id: string): Binding | undefined;

Paramètres

Retours

Représente une collection de liaisons appartenant au classeur.

getBindings(): Binding[];

Retours

Renvoie un nombre sur la version de moteur de calcul Excel.

getCalculationEngineVersion(): number;

Retours

True si tous les graphiques dans le classeur suivent les points de données réelles auquel qu’il sont joints. False si les graphiques suivent l’index des points de données.

getChartDataPointTrack(): boolean;

Retours

Obtient un commentaire à partir de la collection de sites en fonction de son ID. Si l’objet comment n’existe pas, cette méthode retourne undefined.

getComment(commentId: string): Comment | undefined;

Paramètres

Retours

Obtient le commentaire à partir de la cellule spécifiée. S’il n’y a aucun commentaire dans la cellule, une erreur est générée.

getCommentByCell(cellAddress: Range | string): Comment;

Paramètres

Retours

Obtient le commentaire auquel la réponse donnée est connectée.

getCommentByReplyId(replyId: string): Comment;

Paramètres

Retours

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

getComments(): Comment[];

Retours

Obtient une partie XML personnalisée en fonction de son ID. Si n’existe CustomXmlPart pas, cette méthode retourne undefined.

getCustomXmlPart(id: string): CustomXmlPart | undefined;

Paramètres

Retours

Obtient une nouvelle collection de parties XML personnalisées dont les espaces de noms correspondent à l’espace de noms donné.

getCustomXmlPartByNamespace(namespaceUri: string): CustomXmlPart[];

Paramètres

Retours

Représente la collection de parties XML personnalisées contenues dans ce classeur.

getCustomXmlParts(): CustomXmlPart[];

Retours

Obtient une nouvelle collection de parties XML personnalisées dont les espaces de noms correspondent à l’espace de noms donné.

getCustomXmlPartsByNamespace(namespaceUri: string): CustomXmlPart[];

Paramètres

Retours

Obtient le style de tableau croisé dynamique par défaut pour l’étendue de l’objet parent.

getDefaultPivotTableStyle(): PivotTableStyle;

Retours

Obtient la valeur par défaut SlicerStyle pour l’étendue de l’objet parent.

getDefaultSlicerStyle(): SlicerStyle;

Retours

Obtient le style de tableau par défaut pour l’étendue de l’objet parent.

getDefaultTableStyle(): TableStyle;

Retours

Obtient le style de chronologie par défaut pour l’étendue de l’objet parent.

getDefaultTimelineStyle(): TimelineStyle;

Retours

Obtient la première feuille de calcul dans la collection.

getFirstWorksheet(visibleOnly?: boolean): Worksheet;

Paramètres

Retours

Spécifie si des modifications ont été apportées depuis le dernier enregistrement du classeur. Vous pouvez définir cette propriété true sur si vous souhaitez fermer un classeur modifié sans l’enregistrer ou sans être invité à l’enregistrer.

getIsDirty(): boolean;

Retours

Obtient la dernière feuille de calcul dans la collection.

getLastWorksheet(visibleOnly?: boolean): Worksheet;

Paramètres

Retours

Obtient des informations sur un classeur lié par son URL. Si le classeur n’existe pas, cette méthode retourne undefined.

getLinkedWorkbookByUrl(key: string): LinkedWorkbook | undefined;

Paramètres

Retours

Représente le mode de mise à jour des liens de classeur. Le mode est le même pour tous les liens de classeur présents dans le classeur.

getLinkedWorkbookRefreshMode(): WorkbookLinksRefreshMode;

Retours

Exemples

/**
 * This script refreshes all the links to external workbooks, 
 * if the linked workbook refresh mode is set to manual.
 * To learn about linked workbooks, see https://support.microsoft.com/office/c98d1803-dd75-4668-ac6a-d7cca2a9b95f.
 */
function main(workbook: ExcelScript.Workbook) {
  // Check the refresh mode.
  if (workbook.getLinkedWorkbookRefreshMode() === ExcelScript.WorkbookLinksRefreshMode.manual) {
    console.log("Refreshing workbook links");

    // Trigger a refresh of linked workbook content.
    workbook.refreshAllLinksToLinkedWorkbooks();
  }

Retourne une collection de classeurs liés. Dans les formules, les liens de classeur peuvent être utilisés pour référencer des données (valeurs de cellule et noms) en dehors du classeur actif.

getLinkedWorkbooks(): LinkedWorkbook[];

Retours

Exemples

/**
 * This script removes all links to other workbooks.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get all the linked workbook references.
    const externalWorkbooks: ExcelScript.LinkedWorkbook[] = workbook.getLinkedWorkbooks();
    console.log(`There are ${externalWorkbooks.length} other workbooks linked to from this workbook.`);

    // Remove all the links to those workbooks.
    // This changes the value of cells with workbook links to "#CONNECT!".
    externalWorkbooks.forEach((workbookLink) => {
        workbookLink.breakLinks();
    });
}

Obtient le nom du classeur.

getName(): string;

Retours

Exemples

/**
 * This script logs the name of the workbook without the ".xlsx" extension.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the workbook's name.
  let name = workbook.getName();

  // Remove the file extension.
  name = name.substring(0, name.lastIndexOf(".xlsx"));

  // Display the name in the console.
  console.log(name);
}

Obtient un NamedItem objet à l’aide de son nom. Si l’objet n’existe pas, cette méthode retourne undefined.

getNamedItem(name: string): NamedItem | undefined;

Paramètres

Retours

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

getNames(): NamedItem[];

Retours

Exemples

/**
 * This script looks for every named range with "Review" in the name 
 * and marks the range with a yellow fill.
 */
function main(workbook: ExcelScript.Workbook) {
  // Look at every named item in the workbook.
  workbook.getNames().forEach((namedItem) => {
    // Find names containing "Review".
    if (namedItem.getName().includes("Review")) {
      // Only change the fill color if the named item is a range (not a formula).
      let itemType: ExcelScript.NamedItemType = namedItem.getType();
      if (itemType === ExcelScript.NamedItemType.range) {
        // Set the range's fill color to yellow.
        namedItem.getRange().getFormat().getFill().setColor("yellow");
      }
    }
  });
}

Obtient un tableau croisé dynamique par nom. Si le tableau croisé dynamique n’existe pas, cette méthode retourne undefined.

getPivotTable(name: string): PivotTable | undefined;

Paramètres

Retours

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

getPivotTables(): PivotTable[];

Retours

Obtient un PivotTableStyle par nom. Si n’existe PivotTableStyle pas, cette méthode retourne undefined.

getPivotTableStyle(name: string): PivotTableStyle | undefined;

Paramètres

Retours

Représente une collection de PivotTableStyles associée au classeur.

getPivotTableStyles(): PivotTableStyle[];

Retours

Obtient un style par nom. Si l’objet de style n’existe pas, cette méthode retourne undefined.

getPredefinedCellStyle(name: string): PredefinedCellStyle | undefined;

Paramètres

Retours

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

getPredefinedCellStyles(): PredefinedCellStyle[];

Retours

Spécifie si le classeur a déjà été enregistré localement ou en ligne.

getPreviouslySaved(): boolean;

Retours

Obtient les propriétés du classeur.

getProperties(): DocumentProperties;

Retours

Retourne l’objet de protection d’un classeur.

getProtection(): WorkbookProtection;

Retours

Exemples

/**
 * This script protects the workbook with a password, if it isn't already protected.
 * The password is provided by the user through a prompt.
 */
function main(workbook: ExcelScript.Workbook, password?: string) {
  // Get the workbook-level protection object.
  const protection = workbook.getProtection();

  // Check if the workbook is already protected.
  if (!protection.getProtected()) {
      // Protect the workbook with the given password.
      // If the optional password was omitted, 
      // no password will be needed to unprotect the workbook.
    protection.protect(password);
  }
}

Retourne une collection de requêtes Power Query qui font partie du classeur.

getQueries(): Query[];

Retours

Obtient une requête de la collection en fonction de son nom.

getQuery(key: string): Query;

Paramètres

Retours

Retourne true si le classeur est ouvert en mode lecture seule.

getReadOnly(): boolean;

Retours

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(): Range;

Retours

Obtient la ou les plage(s) sélectionnée(s) actuelle(s) dans le classeur. Contrairement à getSelectedRange(), cette méthode retourne un RangeAreas objet qui représente toutes les plages sélectionnées.

getSelectedRanges(): RangeAreas;

Retours

Obtient un segment à l’aide de son nom ou de son ID. Si le segment n’existe pas, cette méthode retourne undefined.

getSlicer(key: string): Slicer | undefined;

Paramètres

Retours

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

getSlicers(): Slicer[];

Retours

Obtient un SlicerStyle par nom. Si le style de segment n’existe pas, cette méthode retourne undefined.

getSlicerStyle(name: string): SlicerStyle | undefined;

Paramètres

Retours

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

getSlicerStyles(): SlicerStyle[];

Retours

Obtient un tableau à l’aide de son nom ou de son ID. Si la table n’existe pas, cette méthode retourne undefined.

getTable(key: string): Table | undefined;

Paramètres

Retours

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

getTables(): Table[];

Retours

Obtient un TableStyle par nom. Si le style de tableau n’existe pas, cette méthode retourne undefined.

getTableStyle(name: string): TableStyle | undefined;

Paramètres

Retours

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

getTableStyles(): TableStyle[];

Retours

Obtient un TimelineStyle par nom. Si le style de chronologie n’existe pas, cette méthode retourne undefined.

getTimelineStyle(name: string): TimelineStyle | undefined;

Paramètres

Retours

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

getTimelineStyles(): TimelineStyle[];

Retours

True si les calculs réalisés dans ce classeur utiliseront uniquement la précision des nombres tels qu’ils sont affichés. Les données perdent définitivement en précision lors du basculement de cette propriété de false à true.

getUsePrecisionAsDisplayed(): boolean;

Retours

Obtient un objet de feuille de calcul à l’aide de son nom ou de son ID. Si la feuille de calcul n’existe pas, cette méthode retourne undefined.

getWorksheet(key: string): Worksheet | undefined;

Paramètres

Retours

Exemples

/**
 * This script switches the active view to a worksheet named "Data", if it exists.
 */
function main(workbook: ExcelScript.Workbook) {
  // Check if the "Data" worksheet exists.
  let dataWorksheet = workbook.getWorksheet("Data");
  if (dataWorksheet) {
    // Switch to the "Data" worksheet.
    dataWorksheet.activate();
  } else {
    console.log(`No worksheet named "Data" in this workbook.`);
  }
}

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

getWorksheets(): Worksheet[];

Retours

Exemples

/**
 * This script logs the names of all the worksheets in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get all the worksheets in the workbook. 
  let sheets = workbook.getWorksheets();

  // Get a list of all the worksheet names.
  let names = sheets.map ((sheet) => sheet.getName());

  // Write in the console all the worksheet names and the total count.
  console.log(names);
  console.log(`Total worksheets inside of this workbook: ${sheets.length}`);
}

Actualise toutes les connexions de données.

refreshAllDataConnections(): void;

Retours

Effectue une demande d’actualisation de tous les liens de classeur.

refreshAllLinksToLinkedWorkbooks(): void;

Retours

Actualise tous les tableaux croisés dynamiques de la collection.

refreshAllPivotTables(): void;

Retours

True si tous les graphiques dans le classeur suivent les points de données réelles auquel qu’il sont joints. False si les graphiques suivent l’index des points de données.

setChartDataPointTrack(chartDataPointTrack: boolean): void;

Paramètres

Retours

Définit le style de tableau croisé dynamique par défaut à utiliser dans l’étendue de l’objet parent.

setDefaultPivotTableStyle(
            newDefaultStyle: PivotTableStyle | string
        ): void;

Paramètres

Retours

Définit le style de segment par défaut à utiliser dans l’étendue de l’objet parent.

setDefaultSlicerStyle(newDefaultStyle: SlicerStyle | string): void;

Paramètres

Retours

Définit le style de tableau par défaut à utiliser dans l’étendue de l’objet parent.

setDefaultTableStyle(newDefaultStyle: TableStyle | string): void;

Paramètres

Retours

Définit le style de chronologie par défaut à utiliser dans l’étendue de l’objet parent.

setDefaultTimelineStyle(newDefaultStyle: TimelineStyle | string): void;

Paramètres

Retours

Spécifie si des modifications ont été apportées depuis le dernier enregistrement du classeur. Vous pouvez définir cette propriété true sur si vous souhaitez fermer un classeur modifié sans l’enregistrer ou sans être invité à l’enregistrer.

setIsDirty(isDirty: boolean): void;

Paramètres

Retours

Représente le mode de mise à jour des liens de classeur. Le mode est le même pour tous les liens de classeur présents dans le classeur.

setLinkedWorkbookRefreshMode(
            linkedWorkbookRefreshMode: WorkbookLinksRefreshMode
        ): void;

Paramètres

Retours

True si les calculs réalisés dans ce classeur utiliseront uniquement la précision des nombres tels qu’ils sont affichés. Les données perdent définitivement en précision lors du basculement de cette propriété de false à true.

setUsePrecisionAsDisplayed(usePrecisionAsDisplayed: boolean): void;

Paramètres

Retours