ExcelScript.Workbook interface

Référence

Paquet:: ExcelScript

Workbook est l’objet de niveau supérieur qui contient des objets de classeur associés tels que des feuilles de calcul, des tableaux et des plages.

Remarques

Exemples

/**
 * This script adds a new worksheet to the workbook, then switches to it.
 */
function main(workbook: ExcelScript.Workbook) {
  // Add a new worksheet with the default name.
  let worksheet = workbook.addWorksheet();

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

Méthodes

addBinding(range, bindingType, id)	Ajoute une nouvelle liaison à une plage spécifique.
addBindingFromNamedItem(name, bindingType, id)	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.
addBindingFromSelection(bindingType, id)	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.
addComment(cellAddress, content, contentType)	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.
addCustomXmlPart(xml)	Ajoute une nouvelle partie XML personnalisée au classeur.
addNamedItem(name, reference, comment)	Ajoute un nouveau nom à la collection de l’étendue donnée.
addNamedItemFormulaLocal(name, formula, comment)	Ajoute un nouveau nom à la collection de l’étendue donnée à l’aide des paramètres régionaux de l’utilisateur pour la formule.
addPivotTable(name, source, destination)	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.
addPivotTableStyle(name, makeUniqueName)	Crée un vide `PivotTableStyle` avec le nom spécifié.
addPredefinedCellStyle(name)	Ajoute un nouveau style à la collection.
addSlicer(slicerSource, sourceField, slicerDestination)	Ajoute un nouveau segment au classeur.
addSlicerStyle(name, makeUniqueName)	Crée un style de segment vide avec le nom spécifié.
addTable(address, hasHeaders)	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.
addTableStyle(name, makeUniqueName)	Crée un vide `TableStyle` avec le nom spécifié.
addTimelineStyle(name, makeUniqueName)	Crée un vide `TimelineStyle` avec le nom spécifié.
addWorksheet(name)	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()` .
breakAllLinksToLinkedWorkbooks()	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.
getActiveCell()	Obtient la cellule active du classeur.
getActiveChart()	Obtient la feuille de calcul active du classeur. S’il n’existe aucun graphique actif, cette méthode retourne `undefined`.
getActiveSlicer()	Obtient le segment actif actuel du classeur. S’il n’existe aucun segment actif, cette méthode retourne `undefined`.
getActiveWorksheet()	Obtient la feuille de calcul active du classeur.
getApplication()	Représente l’application Excel instance qui contient ce classeur.
getAutoSave()	Spécifie si le classeur est en mode Enregistrement automatique.
getBinding(id)	Obtient un objet de liaison par ID. Si l’objet de liaison n’existe pas, cette méthode retourne `undefined`.
getBindings()	Représente une collection de liaisons appartenant au classeur.
getCalculationEngineVersion()	Renvoie un nombre sur la version de moteur de calcul Excel.
getChartDataPointTrack()	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.
getComment(commentId)	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`.
getCommentByCell(cellAddress)	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.
getCommentByReplyId(replyId)	Obtient le commentaire auquel la réponse donnée est connectée.
getComments()	Représente une collection de commentaires associés au classeur.
getCustomXmlPart(id)	Obtient une partie XML personnalisée en fonction de son ID. Si n’existe `CustomXmlPart` pas, cette méthode retourne `undefined`.
getCustomXmlPartByNamespace(namespaceUri)	Obtient une nouvelle collection de parties XML personnalisées dont les espaces de noms correspondent à l’espace de noms donné.
getCustomXmlParts()	Représente la collection de parties XML personnalisées contenues dans ce classeur.
getCustomXmlPartsByNamespace(namespaceUri)	Obtient une nouvelle collection de parties XML personnalisées dont les espaces de noms correspondent à l’espace de noms donné.
getDefaultPivotTableStyle()	Obtient le style de tableau croisé dynamique par défaut pour l’étendue de l’objet parent.
getDefaultSlicerStyle()	Obtient la valeur par défaut `SlicerStyle` pour l’étendue de l’objet parent.
getDefaultTableStyle()	Obtient le style de tableau par défaut pour l’étendue de l’objet parent.
getDefaultTimelineStyle()	Obtient le style chronologie par défaut pour l’étendue de l’objet parent.
getFirstWorksheet(visibleOnly)	Obtient la première feuille de calcul dans la collection.
getIsDirty()	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.
getLastWorksheet(visibleOnly)	Obtient la dernière feuille de calcul dans la collection.
getLinkedWorkbookByUrl(key)	Obtient des informations sur un classeur lié par son URL. Si le classeur n’existe pas, cette méthode retourne `undefined`.
getLinkedWorkbookRefreshMode()	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.
getLinkedWorkbooks()	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.
getName()	Obtient le nom du classeur.
getNamedItem(name)	Obtient un `NamedItem` objet à l’aide de son nom. Si l’objet n’existe pas, cette méthode retourne `undefined`.
getNames()	Représente une collection d’éléments nommés de portée classeur (plages et constantes nommées).
getPivotTable(name)	Obtient un tableau croisé dynamique par nom. Si le tableau croisé dynamique n’existe pas, cette méthode retourne `undefined`.
getPivotTables()	Représente une collection de tableaux croisés dynamiques associés au classeur.
getPivotTableStyle(name)	Obtient un `PivotTableStyle` par nom. Si n’existe `PivotTableStyle` pas, cette méthode retourne `undefined`.
getPivotTableStyles()	Représente une collection de PivotTableStyles associée au classeur.
getPredefinedCellStyle(name)	Obtient un style par nom. Si l’objet de style n’existe pas, cette méthode retourne `undefined`.
getPredefinedCellStyles()	Représente une collection de styles associés au classeur.
getPreviouslySaved()	Spécifie si le classeur a déjà été enregistré localement ou en ligne.
getProperties()	Obtient les propriétés du classeur.
getProtection()	Retourne l’objet de protection d’un classeur.
getQueries()	Retourne une collection de requêtes Power Query qui font partie du classeur.
getQuery(key)	Obtient une requête de la collection en fonction de son nom.
getReadOnly()	Retourne `true` si le classeur est ouvert en mode lecture seule.
getSelectedRange()	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.
getSelectedRanges()	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.
getSlicer(key)	Obtient un segment à l’aide de son nom ou de son ID. Si le segment n’existe pas, cette méthode retourne `undefined`.
getSlicers()	Représente une collection de segments associés au classeur.
getSlicerStyle(name)	Obtient un `SlicerStyle` par nom. Si le style de segment n’existe pas, cette méthode retourne `undefined`.
getSlicerStyles()	Représente une collection de styles associés au classeur.
getTable(key)	Obtient un tableau à l’aide de son nom ou de son ID. Si la table n’existe pas, cette méthode retourne `undefined`.
getTables()	Représente une collection de tableaux associés au classeur.
getTableStyle(name)	Obtient un `TableStyle` par nom. Si le style de tableau n’existe pas, cette méthode retourne `undefined`.
getTableStyles()	Représente une collection de TableStyles associés au classeur.
getTimelineStyle(name)	Obtient un `TimelineStyle` par nom. Si le style chronologie n’existe pas, cette méthode retourne `undefined`.
getTimelineStyles()	Représente une collection de TimelineStyles associés au classeur.
getUsePrecisionAsDisplayed()	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`.
getWorksheet(key)	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`.
getWorksheets()	Représente une collection de feuilles de calcul associées au classeur.
refreshAllDataConnections()	Effectue une demande d’actualisation de toutes les connexions de données.
refreshAllLinksToLinkedWorkbooks()	Effectue une demande d’actualisation de tous les liens de classeur.
refreshAllPivotTables()	Actualise tous les tableaux croisés dynamiques de la collection.
setChartDataPointTrack(chartDataPointTrack)	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.
setDefaultPivotTableStyle(newDefaultStyle)	Définit le style de tableau croisé dynamique par défaut à utiliser dans l’étendue de l’objet parent.
setDefaultSlicerStyle(newDefaultStyle)	Définit le style de segment par défaut à utiliser dans l’étendue de l’objet parent.
setDefaultTableStyle(newDefaultStyle)	Définit le style de tableau par défaut à utiliser dans l’étendue de l’objet parent.
setDefaultTimelineStyle(newDefaultStyle)	Définit le style de chronologie par défaut à utiliser dans l’étendue de l’objet parent.
setIsDirty(isDirty)	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.
setLinkedWorkbookRefreshMode(linkedWorkbookRefreshMode)	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.
setUsePrecisionAsDisplayed(usePrecisionAsDisplayed)	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`.

Détails de la méthode

addBinding(range, bindingType, id)

Ajoute une nouvelle liaison à une plage spécifique.

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

Paramètres

range: ExcelScript.Range | string

Plage à laquelle lier la liaison. Il peut s’agir d’un Range objet ou d’une chaîne. Si c’est une chaîne, elle doit contenir l’adresse complète, y compris le nom de la feuille.

bindingType: ExcelScript.BindingType

Type de liaison. Voir ExcelScript.BindingType (en anglais).

id: string

Nom de la liaison.

Retours

ExcelScript.Binding

addBindingFromNamedItem(name, bindingType, id)

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

name: string

Nom à partir duquel créer la liaison.

bindingType: ExcelScript.BindingType

Type de liaison. Voir ExcelScript.BindingType (en anglais).

id: string

Nom de la liaison.

Retours

ExcelScript.Binding

addBindingFromSelection(bindingType, id)

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

bindingType: ExcelScript.BindingType

Type de liaison. Voir ExcelScript.BindingType (en anglais).

id: string

Nom de la liaison.

Retours

ExcelScript.Binding

addComment(cellAddress, content, contentType)

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

cellAddress: ExcelScript.Range | string

Cellule à laquelle le commentaire est ajouté. Il peut s’agir d’un Range objet ou d’une chaîne. S’il s’agit d’une chaîne, elle doit contenir l’adresse complète, y compris le nom de la feuille. Une InvalidArgument erreur est générée si la plage fournie est supérieure à une cellule.

content: ExcelScript.CommentRichContent | string

Contenu du commentaire. Il peut s’agir d’une chaîne ou d’un CommentRichContent objet. Les chaînes sont utilisées pour le texte brut. CommentRichContent les objets autorisent d’autres fonctionnalités de commentaire, telles que les mentions.

contentType: ExcelScript.ContentType

Optional. Type de contenu contenu dans le commentaire. La valeur par défaut est enum ContentType.Plain.

Retours

ExcelScript.Comment

addCustomXmlPart(xml)

Ajoute une nouvelle partie XML personnalisée au classeur.

addCustomXmlPart(xml: string): CustomXmlPart;

Paramètres

xml: string

Contenu XML. Doit être un fragment XML valide.

Retours

ExcelScript.CustomXmlPart

addNamedItem(name, reference, comment)

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

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

Paramètres

name: string

Nom de l’élément nommé.

reference: ExcelScript.Range | string

Formule ou plage à laquelle le nom fait référence.

comment: string

Optional. Commentaire associé à l’élément nommé.

Retours

ExcelScript.NamedItem

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

addNamedItemFormulaLocal(name, formula, comment)

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

name: string

Nom de l’élément nommé.

formula: string

Formule dans les paramètres régionaux de l’utilisateur à laquelle le nom fait référence.

comment: string

Optional. Commentaire associé à l’élément nommé.

Retours

ExcelScript.NamedItem

addPivotTable(name, source, destination)

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

name: string

Nom du nouveau tableau croisé dynamique.

source: ExcelScript.Range | string | ExcelScript.Table

Données sources pour le nouveau tableau croisé dynamique, il peut s’agir d’une plage (ou d’une adresse de chaîne, y compris le nom de la feuille de calcul) ou d’une table.

destination: ExcelScript.Range | string

Cellule située dans le coin supérieur gauche de la plage de destination du rapport de tableau croisé dynamique (plage de la feuille de calcul destinée à recevoir le rapport obtenu).

Retours

ExcelScript.PivotTable

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

addPivotTableStyle(name, makeUniqueName)

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

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

Paramètres

name: string

Nom unique du nouveau style de tableau croisé dynamique. Génère une InvalidArgument erreur si le nom est déjà utilisé.

makeUniqueName: boolean

Optional. La valeur par défaut est false. Si truela valeur est , ajoute des nombres au nom afin de le rendre unique, si nécessaire.

Retours

ExcelScript.PivotTableStyle

addPredefinedCellStyle(name)

Ajoute un nouveau style à la collection.

addPredefinedCellStyle(name: string): void;

Paramètres

name: string

Nom du style à ajouter.

Retours

void

addSlicer(slicerSource, sourceField, slicerDestination)

Ajoute un nouveau segment au classeur.

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

Paramètres

slicerSource: string | ExcelScript.PivotTable | ExcelScript.Table

Source de données sur laquelle le nouveau segment sera basé. Il peut s’agir d’un PivotTable objet, d’un Table objet ou d’une chaîne. Lorsqu’un objet PivotTable est passé, la source de données est la source de l’objet PivotTable . Lorsqu’un Table objet est passé, la source de données est l’objet Table . Lorsqu’une chaîne est passée, elle est interprétée comme le nom ou l’ID d’un tableau croisé dynamique ou d’une table.

sourceField: string | ExcelScript.PivotField | number | ExcelScript.TableColumn

Champ dans la source de données par lequel filtrer. Il peut s’agir d’un PivotField objet, d’un TableColumn objet, de l’ID d’un PivotField ou du nom ou de l’ID d’un TableColumn.

slicerDestination: string | ExcelScript.Worksheet

Optional. Feuille de calcul dans laquelle le nouveau segment sera créé. Il peut s’agir d’un Worksheet objet ou du nom ou de l’ID d’une feuille de calcul. Ce paramètre peut être omis si la collection de segments est récupérée à partir d’une feuille de calcul.

Retours

ExcelScript.Slicer

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

addSlicerStyle(name, makeUniqueName)

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

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

Paramètres

name: string

Nom unique du nouveau style de segment. Lève une InvalidArgument exception si le nom est déjà utilisé.

makeUniqueName: boolean

Optional. La valeur par défaut est false. Si truela valeur est , ajoute des nombres au nom afin de le rendre unique, si nécessaire.

Retours

ExcelScript.SlicerStyle

addTable(address, hasHeaders)

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

address: ExcelScript.Range | string

Objet Range , adresse de chaîne ou nom de la plage représentant la source de données. Si l’adresse ne contient pas de nom de feuille, la feuille ouverte est utilisée.

hasHeaders: boolean

Valeur booléenne qui indique si les données importées ont des étiquettes de colonne. Si la source ne contient pas d’en-têtes (par exemple, lorsque cette propriété a la falsevaleur ), Excel génère automatiquement un en-tête et déplace les données d’une ligne vers le bas.

Retours

ExcelScript.Table

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

addTableStyle(name, makeUniqueName)

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

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

Paramètres

name: string

Nom unique du nouveau style de tableau. Génère une InvalidArgument erreur si le nom est déjà utilisé.

makeUniqueName: boolean

Optional. La valeur par défaut est false. Si truela valeur est , ajoute des nombres au nom afin de le rendre unique, si nécessaire.

Retours

ExcelScript.TableStyle

addTimelineStyle(name, makeUniqueName)

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

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

Paramètres

name: string

Nom unique du nouveau style chronologie. Génère une InvalidArgument erreur si le nom est déjà utilisé.

makeUniqueName: boolean

Optional. La valeur par défaut est false. Si truela valeur est , ajoute des nombres au nom afin de le rendre unique, si nécessaire.

Retours

ExcelScript.TimelineStyle

addWorksheet(name)

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

name: string

Optional. Nom de la feuille de calcul à ajouter. S’il est spécifié, le nom doit être unique. Si cette propriété n’est pas définie, Excel détermine le nom de la nouvelle feuille de calcul.

Retours

ExcelScript.Worksheet

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

breakAllLinksToLinkedWorkbooks()

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

void

getActiveCell()

Obtient la cellule active du classeur.

getActiveCell(): Range;

Retours

ExcelScript.Range

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

getActiveChart()

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

getActiveChart(): Chart;

Retours

ExcelScript.Chart

getActiveSlicer()

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

getActiveSlicer(): Slicer;

Retours

ExcelScript.Slicer

getActiveWorksheet()

Obtient la feuille de calcul active du classeur.

getActiveWorksheet(): Worksheet;

Retours

ExcelScript.Worksheet

getApplication()

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

getApplication(): Application;

Retours

ExcelScript.Application

getAutoSave()

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

getAutoSave(): boolean;

Retours

boolean

getBinding(id)

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

id: string

ID de l’objet de liaison à récupérer.

Retours

ExcelScript.Binding | undefined

getBindings()

Représente une collection de liaisons appartenant au classeur.

getBindings(): Binding[];

Retours

ExcelScript.Binding[]

getCalculationEngineVersion()

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

getCalculationEngineVersion(): number;

Retours

number

getChartDataPointTrack()

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

boolean

getComment(commentId)

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

commentId: string

Identificateur du commentaire.

Retours

ExcelScript.Comment | undefined

getCommentByCell(cellAddress)

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

cellAddress: ExcelScript.Range | string

Cellule sur laquelle se trouve le commentaire. Il peut s’agir d’un Range objet ou d’une chaîne. S’il s’agit d’une chaîne, elle doit contenir l’adresse complète, y compris le nom de la feuille. Une InvalidArgument erreur est générée si la plage fournie est supérieure à une cellule.

Retours

ExcelScript.Comment

getCommentByReplyId(replyId)

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

getCommentByReplyId(replyId: string): Comment;

Paramètres

replyId: string

Identificateur de réponse au commentaire.

Retours

ExcelScript.Comment

getComments()

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

getComments(): Comment[];

Retours

ExcelScript.Comment[]

getCustomXmlPart(id)

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

id: string

ID de l’objet à récupérer.

Retours

ExcelScript.CustomXmlPart | undefined

getCustomXmlPartByNamespace(namespaceUri)

Avertissement

Cette API est à présent déconseillée.

Use getCustomXmlPartsByNamespace instead.

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

namespaceUri: string

Il doit s’agir d’un URI de schéma complet ; par exemple, "http://schemas.contoso.com/review/1.0" ;.

Retours

ExcelScript.CustomXmlPart[]

getCustomXmlParts()

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

getCustomXmlParts(): CustomXmlPart[];

Retours

ExcelScript.CustomXmlPart[]

getCustomXmlPartsByNamespace(namespaceUri)

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

namespaceUri: string

Il doit s’agir d’un URI de schéma complet ; par exemple, "http://schemas.contoso.com/review/1.0" ;.

Retours

ExcelScript.CustomXmlPart[]

getDefaultPivotTableStyle()

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

getDefaultPivotTableStyle(): PivotTableStyle;

Retours

ExcelScript.PivotTableStyle

getDefaultSlicerStyle()

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

getDefaultSlicerStyle(): SlicerStyle;

Retours

ExcelScript.SlicerStyle

getDefaultTableStyle()

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

getDefaultTableStyle(): TableStyle;

Retours

ExcelScript.TableStyle

getDefaultTimelineStyle()

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

getDefaultTimelineStyle(): TimelineStyle;

Retours

ExcelScript.TimelineStyle

getFirstWorksheet(visibleOnly)

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

getFirstWorksheet(visibleOnly?: boolean): Worksheet;

Paramètres

visibleOnly: boolean

Optional. Si truela valeur est , prend uniquement en compte les feuilles de calcul visibles, en ignorant toutes les feuilles de calcul masquées.

Retours

ExcelScript.Worksheet

getIsDirty()

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

boolean

getLastWorksheet(visibleOnly)

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

getLastWorksheet(visibleOnly?: boolean): Worksheet;

Paramètres

visibleOnly: boolean

Optional. Si truela valeur est , prend uniquement en compte les feuilles de calcul visibles, en ignorant toutes les feuilles de calcul masquées.

Retours

ExcelScript.Worksheet

getLinkedWorkbookByUrl(key)

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

key: string

URL du classeur lié.

Retours

ExcelScript.LinkedWorkbook | undefined

getLinkedWorkbookRefreshMode()

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

ExcelScript.WorkbookLinksRefreshMode

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/create-an-external-reference-link-to-a-cell-range-in-another-workbook-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();
  }
}

getLinkedWorkbooks()

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

ExcelScript.LinkedWorkbook[]

getName()

Obtient le nom du classeur.

getName(): string;

Retours

string

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

getNamedItem(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

name: string

Nameditem name.

Retours

ExcelScript.NamedItem | undefined

getNames()

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

getNames(): NamedItem[];

Retours

ExcelScript.NamedItem[]

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

getPivotTable(name)

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

name: string

Nom du tableau croisé dynamique à récupérer.

Retours

ExcelScript.PivotTable | undefined

getPivotTables()

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

getPivotTables(): PivotTable[];

Retours

ExcelScript.PivotTable[]

getPivotTableStyle(name)

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

getPivotTableStyle(name: string): PivotTableStyle | undefined;

Paramètres

name: string

Nom du style de tableau croisé dynamique à récupérer.

Retours

ExcelScript.PivotTableStyle | undefined

getPivotTableStyles()

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

getPivotTableStyles(): PivotTableStyle[];

Retours

ExcelScript.PivotTableStyle[]

getPredefinedCellStyle(name)

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

name: string

Nom du style à récupérer.

Retours

ExcelScript.PredefinedCellStyle | undefined

getPredefinedCellStyles()

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

getPredefinedCellStyles(): PredefinedCellStyle[];

Retours

ExcelScript.PredefinedCellStyle[]

getPreviouslySaved()

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

getPreviouslySaved(): boolean;

Retours

boolean

getProperties()

Obtient les propriétés du classeur.

getProperties(): DocumentProperties;

Retours

ExcelScript.DocumentProperties

getProtection()

Retourne l’objet de protection d’un classeur.

getProtection(): WorkbookProtection;

Retours

ExcelScript.WorkbookProtection

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

getQueries()

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

getQueries(): Query[];

Retours

ExcelScript.Query[]

getQuery(key)

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

getQuery(key: string): Query;

Paramètres

key: string

Nom de la requête qui ne respecte pas la casse.

Retours

ExcelScript.Query

getReadOnly()

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

getReadOnly(): boolean;

Retours

boolean

getSelectedRange()

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

ExcelScript.Range

getSelectedRanges()

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

ExcelScript.RangeAreas

getSlicer(key)

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

key: string

Nom ou ID du segment à récupérer.

Retours

ExcelScript.Slicer | undefined

getSlicers()

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

getSlicers(): Slicer[];

Retours

ExcelScript.Slicer[]

getSlicerStyle(name)

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

name: string

Nom du style de segment à récupérer.

Retours

ExcelScript.SlicerStyle | undefined

getSlicerStyles()

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

getSlicerStyles(): SlicerStyle[];

Retours

ExcelScript.SlicerStyle[]

getTable(key)

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

key: string

Nom ou ID du tableau à récupérer.

Retours

ExcelScript.Table | undefined

getTables()

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

getTables(): Table[];

Retours

ExcelScript.Table[]

getTableStyle(name)

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

name: string

Nom du style de tableau à récupérer.

Retours

ExcelScript.TableStyle | undefined

getTableStyles()

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

getTableStyles(): TableStyle[];

Retours

ExcelScript.TableStyle[]

getTimelineStyle(name)

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

getTimelineStyle(name: string): TimelineStyle | undefined;

Paramètres

name: string

Nom du style chronologie à récupérer.

Retours

ExcelScript.TimelineStyle | undefined

getTimelineStyles()

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

getTimelineStyles(): TimelineStyle[];

Retours

ExcelScript.TimelineStyle[]

getUsePrecisionAsDisplayed()

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

boolean

getWorksheet(key)

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

key: string

Nom ou ID de la feuille de calcul.

Retours

ExcelScript.Worksheet | undefined

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

getWorksheets()

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

getWorksheets(): Worksheet[];

Retours

ExcelScript.Worksheet[]

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

refreshAllDataConnections()

Effectue une demande d’actualisation de toutes les connexions de données.

refreshAllDataConnections(): void;

Retours

void

refreshAllLinksToLinkedWorkbooks()

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

refreshAllLinksToLinkedWorkbooks(): void;

Retours

void

refreshAllPivotTables()

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

refreshAllPivotTables(): void;

Retours

void

setChartDataPointTrack(chartDataPointTrack)

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

chartDataPointTrack: boolean

Retours

void

setDefaultPivotTableStyle(newDefaultStyle)

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

newDefaultStyle: ExcelScript.PivotTableStyle | string

Objet PivotTableStyle , ou nom de l’objet PivotTableStyle , qui doit être la nouvelle valeur par défaut.

Retours

void

setDefaultSlicerStyle(newDefaultStyle)

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

setDefaultSlicerStyle(newDefaultStyle: SlicerStyle | string): void;

Paramètres

newDefaultStyle: ExcelScript.SlicerStyle | string

Objet SlicerStyle , ou nom de l’objet SlicerStyle , qui doit être la nouvelle valeur par défaut.

Retours

void

setDefaultTableStyle(newDefaultStyle)

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

setDefaultTableStyle(newDefaultStyle: TableStyle | string): void;

Paramètres

newDefaultStyle: ExcelScript.TableStyle | string

Objet TableStyle , ou nom de l’objet TableStyle , qui doit être la nouvelle valeur par défaut.

Retours

void

setDefaultTimelineStyle(newDefaultStyle)

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

setDefaultTimelineStyle(newDefaultStyle: TimelineStyle | string): void;

Paramètres

newDefaultStyle: ExcelScript.TimelineStyle | string

Objet TimelineStyle , ou nom de l’objet TimelineStyle , qui doit être la nouvelle valeur par défaut.

Retours

void

setIsDirty(isDirty)

setIsDirty(isDirty: boolean): void;

Paramètres

isDirty: boolean

Retours

void

setLinkedWorkbookRefreshMode(linkedWorkbookRefreshMode)

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

linkedWorkbookRefreshMode: ExcelScript.WorkbookLinksRefreshMode

Retours

void

setUsePrecisionAsDisplayed(usePrecisionAsDisplayed)

setUsePrecisionAsDisplayed(usePrecisionAsDisplayed: boolean): void;

Paramètres

usePrecisionAsDisplayed: boolean

Retours

void