ExcelScript.Worksheet interface

Référence

Paquet:: ExcelScript

Une feuille de calcul Excel est une grille de cellules. Elle peut contenir des données, des tableaux, des graphiques, etc.

Remarques

Exemples

/**
 * This script creates a new worksheet named "Plum" and sets its tab color to purple.
 */
function main(workbook: ExcelScript.Workbook) {
  const newSheet = workbook.addWorksheet("Plum")
  newSheet.setTabColor("purple");
}

Méthodes

activate()	Active la feuille de calcul dans l’interface utilisateur Excel.
addChart(type, sourceData, seriesBy)	Crée un graphique.
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.
addGeometricShape(geometricShapeType)	Ajoute une forme géométrique à la feuille de calcul. Renvoie un `Shape` objet qui représente la nouvelle forme.
addGroup(values)	Groupes un sous-ensemble de formes dans la feuille de calcul de cette collection de sites. Renvoie un `Shape` objet qui représente le nouveau groupe de formes.
addHorizontalPageBreak(pageBreakRange)	Ajoute un saut de page avant la cellule en haut à gauche de la plage spécifiée.
addImage(base64ImageString)	Crée une image à partir d’une chaîne en base 64 et il est ajouté à la feuille de calcul. Renvoie l’objet `Shape` qui représente la nouvelle image.
addLine(startLeft, startTop, endLeft, endTop, connectorType)	Ajoute une ligne à la feuille de calcul. Renvoie un `Shape` objet qui représente la nouvelle ligne.
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.
addNamedSheetView(name)	Crée une vue feuille avec le nom donné.
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.
addSlicer(slicerSource, sourceField, slicerDestination)	Ajoute un nouveau segment au classeur.
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.
addTextBox(text)	Ajoute une zone de texte à la feuille de calcul avec le texte fourni en tant que le contenu. Renvoie un `Shape` objet qui représente la nouvelle zone de texte.
addVerticalPageBreak(pageBreakRange)	Ajoute un saut de page avant la cellule en haut à gauche de la plage spécifiée.
addWorksheetCustomProperty(key, value)	Ajoute une nouvelle propriété personnalisée qui correspond à la clé fournie. Cette opération remplace les propriétés personnalisées existantes par cette clé.
calculate(markAllDirty)	Calcule toutes les cellules d’une feuille de calcul.
copy(positionType, relativeTo)	Copie une feuille de calcul et la place à la position spécifiée.
delete()	Supprime la feuille de calcul du classeur. Notez que si la visibilité de la feuille de calcul est définie sur « VeryHidden », l’opération de suppression échoue avec une `InvalidOperation` exception. Vous devez d’abord modifier sa visibilité sur masquée ou visible avant de la supprimer.
enterTemporaryNamedSheetView()	Crée et active une nouvelle vue de feuille temporaire. Les vues temporaires sont supprimées lors de la fermeture de l’application, de la sortie de la vue temporaire avec la méthode de sortie ou du basculement vers une autre vue feuille. La vue feuille temporaire est également accessible avec la chaîne vide (« »), si l’affichage temporaire existe.
exitActiveNamedSheetView()	Quitte l’affichage feuille actuellement actif.
findAll(text, criteria)	Recherche toutes les occurrences de la chaîne donnée en fonction des critères spécifiés et les renvoie en tant qu’objet `RangeAreas` , comprenant une ou plusieurs plages rectangulaires.
getActiveNamedSheetView()	Obtient l’affichage feuille actuellement actif de la feuille de calcul.
getAutoFilter()	Représente l’objet `AutoFilter` de la feuille de calcul.
getCell(row, column)	Obtient l’objet `Range` contenant la cellule unique en fonction des numéros de ligne et de colonne. La cellule peut se trouver en dehors des limites de sa plage parente, tant qu’elle reste dans la grille de feuille de calcul.
getChart(name)	Extrait un graphique à l’aide de son nom. Si plusieurs graphiques portent le même nom, c’est le premier d’entre eux qui est renvoyé. Si le graphique n’existe pas, cette méthode retourne `undefined`.
getCharts()	Retourne une collection de graphiques qui font partie de la feuille de calcul.
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()	Renvoie une collection de tous les objets Lecteur sur l’ordinateur.
getCustomProperties()	Obtient une collection de propriétés personnalisées au niveau de la feuille de calcul.
getEnableCalculation()	Détermine si Excel doit recalculer la feuille de calcul si nécessaire. True si Excel recalcule la feuille de calcul si nécessaire. Elle a la valeur False si Excel ne recalcule pas la feuille.
getFreezePanes()	Obtient un objet qui peut être utilisé pour manipuler des volets figés dans la feuille de calcul.
getHorizontalPageBreaks()	Obtient la collection de saut de page horizontal pour la feuille de calcul. Cette collection contient uniquement les sauts de page manuels.
getId()	Renvoie une valeur qui permet d’identifier la feuille de calcul de façon unique dans un classeur donné. La valeur de l’identificateur reste identique, même lorsque la feuille de calcul est renommée ou déplacée.
getName()	Nom complet de la feuille de calcul. Le nom doit comporter moins de 32 caractères.
getNamedItem(name)	Obtient un `NamedItem` objet à l’aide de son nom. Si l’objet n’existe pas, cette méthode retourne `undefined`.
getNamedSheetView(key)	Obtient une vue de feuille à l’aide de son nom. Si l’objet en mode Feuille n’existe pas, cette méthode retourne `undefined`.
getNamedSheetViews()	Retourne une collection d’affichages feuille qui sont présents dans la feuille de calcul.
getNames()	Collection de noms inclus dans l’étendue de la feuille de calcul active.
getNext(visibleOnly)	Obtient la feuille de calcul qui suit celle-ci. Si aucune feuille de calcul ne suit celle-ci, cette méthode retourne `undefined`.
getPageLayout()	Obtient l’objet `PageLayout` de la feuille de calcul.
getPivotTable(name)	Obtient un tableau croisé dynamique par nom. Si le tableau croisé dynamique n’existe pas, cette méthode retourne `undefined`.
getPivotTables()	Collection de tableaux croisés dynamiques qui font partie de la feuille de calcul.
getPosition()	Position de la feuille de calcul au sein du classeur (sur une base zéro).
getPrevious(visibleOnly)	Obtient la feuille de calcul qui précède celle-ci. S’il n’existe aucune feuille de calcul précédente, cette méthode retourne `undefined`.
getProtection()	Renvoie l’objet de protection de feuille pour une feuille de calcul.
getRange(address)	Obtient l’objet `Range` , qui représente un seul bloc rectangulaire de cellules, spécifié par l’adresse ou le nom.
getRangeByIndexes(startRow, startColumn, rowCount, columnCount)	Obtient l’objet `Range` commençant à un index de ligne et d’un index de colonne particuliers, et couvrant un certain nombre de lignes et de colonnes.
getRanges(address)	Obtient l’objet `RangeAreas` , qui représente un ou plusieurs blocs de plages rectangulaires, spécifiés par l’adresse ou le nom.
getShape(key)	Obtient une forme à l’aide de son nom ou de son ID. Si l’objet shape n’existe pas, cette méthode retourne `undefined`.
getShapes()	Renvoie une collection de tous les objets Forme sur la feuille de calcul.
getShowGridlines()	Spécifie si le quadrillage est visible par l’utilisateur.
getShowHeadings()	Spécifie si les titres sont visibles par l’utilisateur.
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()	Retourne une collection de segments qui font partie de la feuille de calcul.
getStandardHeight()	Renvoie la hauteur standard (par défaut) de toutes les lignes dans la feuille de calcul, en points.
getStandardWidth()	Spécifie la largeur standard (par défaut) de toutes les colonnes de la feuille de calcul. Une unité de largeur de colonne est égale à la largeur d'un caractère du style Normal. Dans le cas des polices proportionnelles, la largeur du caractère 0 (zéro) est utilisée.
getTabColor()	Couleur d’onglet de la feuille de calcul. Lors de la récupération de la couleur de l’onglet, si la feuille de calcul est invisible, la valeur est `null`. Si la feuille de calcul est visible, mais que la couleur de l’onglet est définie sur auto, une chaîne vide est retournée. Sinon, la propriété sera définie sur une couleur, au format #RRGGBB (par exemple, « FFA500 »). Lorsque vous définissez la couleur, utilisez une chaîne vide pour définir une couleur « auto » ou une couleur réelle dans le cas contraire.
getTabId()	Retourne une valeur représentant cette feuille de calcul qui peut être lue par Open Office XML. Il s’agit d’une valeur entière, qui est différente de `worksheet.id` (qui retourne un identificateur global unique) et `worksheet.name` (qui retourne une valeur telle que « Sheet1 »).
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()	Collection de tableaux qui font partie de la feuille de calcul.
getUsedRange(valuesOnly)
getVerticalPageBreaks()	Obtient la collection de saut de page vertical pour la feuille de calcul. Cette collection contient uniquement les sauts de page manuels.
getVisibility()	Visibilité de la feuille de calcul.
getWorksheetCustomProperty(key)	Obtient un objet de propriété personnalisé par sa clé, qui ne tient pas compte de la casse. Si la propriété personnalisée n’existe pas, cette méthode retourne `undefined`.
refreshAllPivotTables()	Actualise tous les tableaux croisés dynamiques de la collection.
removeAllHorizontalPageBreaks()	Redéfinit tous les sauts de page de la collection.
removeAllVerticalPageBreaks()	Redéfinit tous les sauts de page de la collection.
replaceAll(text, replacement, criteria)	Détecte et remplace la chaîne donnée basée sur les critères spécifiés dans la plage active.
setEnableCalculation(enableCalculation)	Détermine si Excel doit recalculer la feuille de calcul si nécessaire. True si Excel recalcule la feuille de calcul si nécessaire. Elle a la valeur False si Excel ne recalcule pas la feuille.
setName(name)	Nom complet de la feuille de calcul. Le nom doit comporter moins de 32 caractères.
setPosition(position)	Position de la feuille de calcul au sein du classeur (sur une base zéro).
setShowGridlines(showGridlines)	Spécifie si le quadrillage est visible par l’utilisateur.
setShowHeadings(showHeadings)	Spécifie si les titres sont visibles par l’utilisateur.
setStandardWidth(standardWidth)	Spécifie la largeur standard (par défaut) de toutes les colonnes de la feuille de calcul. Une unité de largeur de colonne est égale à la largeur d'un caractère du style Normal. Dans le cas des polices proportionnelles, la largeur du caractère 0 (zéro) est utilisée.
setTabColor(tabColor)	Couleur d’onglet de la feuille de calcul. Lors de la récupération de la couleur de l’onglet, si la feuille de calcul est invisible, la valeur est `null`. Si la feuille de calcul est visible, mais que la couleur de l’onglet est définie sur auto, une chaîne vide est retournée. Sinon, la propriété sera définie sur une couleur, au format #RRGGBB (par exemple, « FFA500 »). Lorsque vous définissez la couleur, utilisez une chaîne vide pour définir une couleur « auto » ou une couleur réelle dans le cas contraire.
setVisibility(visibility)	Visibilité de la feuille de calcul.
showOutlineLevels(rowLevels, columnLevels)	Affiche les groupes de lignes ou de colonnes selon leurs niveaux hiérarchiques. Présente les groupes et résume une liste de données dans la feuille de calcul. Les `rowLevels` paramètres et `columnLevels` spécifient le nombre de niveaux du plan qui seront affichés. La plage d’arguments acceptables est comprise entre 0 et 8. La valeur 0 ne modifie pas l’affichage actuel. Une valeur supérieure au nombre actuel de niveaux affiche tous les niveaux.

Détails de la méthode

activate()

Active la feuille de calcul dans l’interface utilisateur Excel.

activate(): void;

Retours

void

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

addChart(type, sourceData, seriesBy)

Crée un graphique.

addChart(
            type: ChartType,
            sourceData: Range,
            seriesBy?: ChartSeriesBy
        ): Chart;

Paramètres

type: ExcelScript.ChartType

Représente le type d’un graphique. Pour plus d’informations, consultez ExcelScript.ChartType .

sourceData: ExcelScript.Range

Objet Range correspondant aux données sources.

seriesBy: ExcelScript.ChartSeriesBy

Optional. Spécifie la façon dont les colonnes ou les lignes sont utilisées comme séries de données sur le graphique. Pour plus d’informations, consultez ExcelScript.ChartSeriesBy .

Retours

ExcelScript.Chart

Exemples

/**
 * This sample creates a column-clustered chart based on the current worksheet's data.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the data range.
  let range = selectedSheet.getUsedRange();

  // Insert a chart using the data on the current worksheet.
  let chart = selectedSheet.addChart(ExcelScript.ChartType.columnClustered, range);

  // Name the chart for easy access in other scripts.
  chart.setName("ColumnChart");
}

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

addGeometricShape(geometricShapeType)

Ajoute une forme géométrique à la feuille de calcul. Renvoie un Shape objet qui représente la nouvelle forme.

addGeometricShape(geometricShapeType: GeometricShapeType): Shape;

Paramètres

geometricShapeType: ExcelScript.GeometricShapeType

Représente le type de la forme géométrique. Pour plus d’informations, consultez ExcelScript.GeometricShapeType .

Retours

ExcelScript.Shape

Exemples

/**
 * This script creates a hexagon shape on the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();
  const hexagon: ExcelScript.Shape = 
    currentSheet.addGeometricShape(ExcelScript.GeometricShapeType.hexagon);
  
  // Set the hexagon size to 40x40 pixels.
  hexagon.setHeight(40);
  hexagon.setWidth(40);

  // Position the hexagon at [100,100] pixels.
  hexagon.setLeft(100);
  hexagon.setTop(100);
}

addGroup(values)

Groupes un sous-ensemble de formes dans la feuille de calcul de cette collection de sites. Renvoie un Shape objet qui représente le nouveau groupe de formes.

addGroup(values: Array<string | Shape>): Shape;

Paramètres

values: Array<string | ExcelScript.Shape>

Tableau d’ID de forme ou d’objets de forme.

Retours

ExcelScript.Shape

addHorizontalPageBreak(pageBreakRange)

Ajoute un saut de page avant la cellule en haut à gauche de la plage spécifiée.

addHorizontalPageBreak(pageBreakRange: Range | string): PageBreak;

Paramètres

pageBreakRange: ExcelScript.Range | string

Plage immédiatement après le saut de page à ajouter.

Retours

ExcelScript.PageBreak

addImage(base64ImageString)

Crée une image à partir d’une chaîne en base 64 et il est ajouté à la feuille de calcul. Renvoie l’objet Shape qui représente la nouvelle image.

addImage(base64ImageString: string): Shape;

Paramètres

base64ImageString: string

Chaîne encodée en base64 représentant une image au format JPEG ou PNG.

Retours

ExcelScript.Shape

Exemples

/**
 * This sample copies an image from a URL. 
 * This could be used to copy photos that a colleague stored in a shared folder to a related workbook.
 */
async function main(workbook: ExcelScript.Workbook) {
  // Fetch the image from a URL.
  const link = "https://raw.githubusercontent.com/OfficeDev/office-scripts-docs/master/docs/images/git-octocat.png";
  const response = await fetch(link);

  // Store the response as an ArrayBuffer, since it is a raw image file.
  const data = await response.arrayBuffer();

  // Convert the image data into a base64-encoded string.
  const image = convertToBase64(data);

  // Add the image to the current worksheet.
  workbook.getActiveWorksheet().addImage(image);
}

/**
 * Converts an ArrayBuffer containing a .png image into a base64-encoded string.
 */
function convertToBase64(input: ArrayBuffer) {
  const uInt8Array = new Uint8Array(input);
  const count = uInt8Array.length;

  // Allocate the necessary space up front.
  const charCodeArray = new Array<string>(count) 
  
  // Convert every entry in the array to a character.
  for (let i = count; i >= 0; i--) { 
    charCodeArray[i] = String.fromCharCode(uInt8Array[i]);
  }

  // Convert the characters to base64.
  const base64 = btoa(charCodeArray.join(''));
  return base64;
}

addLine(startLeft, startTop, endLeft, endTop, connectorType)

Ajoute une ligne à la feuille de calcul. Renvoie un Shape objet qui représente la nouvelle ligne.

addLine(
            startLeft: number,
            startTop: number,
            endLeft: number,
            endTop: number,
            connectorType?: ConnectorType
        ): Shape;

Paramètres

startLeft: number

Distance, en points, entre le début de la ligne et le côté gauche de la feuille de calcul.

startTop: number

Distance, en points, entre le début de la ligne et le haut de la feuille de calcul.

endLeft: number

Distance, en points, entre la fin de la ligne et la gauche de la feuille de calcul.

endTop: number

Distance, en points, entre la fin de la ligne et le haut de la feuille de calcul.

connectorType: ExcelScript.ConnectorType

Représente le type de connecteur. Pour plus d’informations, consultez ExcelScript.ConnectorType .

Retours

ExcelScript.Shape

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

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

addNamedSheetView(name)

Crée une vue feuille avec le nom donné.

addNamedSheetView(name: string): NamedSheetView;

Paramètres

name: string

Nom de l’affichage feuille à créer. Génère une erreur lorsque le nom fourni existe déjà, est vide ou s’il s’agit d’un nom réservé par la feuille de calcul.

Retours

ExcelScript.NamedSheetView

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 a new worksheet.
 * This script assumes there is a table in the current worksheet with columns named "Type" and "Sales".
 */
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];

  // Add the PivotTable to a new worksheet.
  let newSheet = workbook.addWorksheet("Pivot");
  let pivotTable = newSheet.addPivotTable("My Pivot", table, "A1");

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

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

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 on the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first PivotTable from the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const pivot = currentSheet.getPivotTables()[0];

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

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

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

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 creates a table from the current worksheet's used range, then sorts it based on the first column.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Create a table with the used cells.
  let usedRange = selectedSheet.getUsedRange();
  let newTable = selectedSheet.addTable(usedRange, true);

  // Sort the table using the first column.
  newTable.getSort().apply([{ key: 0, ascending: true }]);
}

addTextBox(text)

Ajoute une zone de texte à la feuille de calcul avec le texte fourni en tant que le contenu. Renvoie un Shape objet qui représente la nouvelle zone de texte.

addTextBox(text?: string): Shape;

Paramètres

text: string

Représente le texte qui sera affiché dans la zone de texte créée.

Retours

ExcelScript.Shape

addVerticalPageBreak(pageBreakRange)

Ajoute un saut de page avant la cellule en haut à gauche de la plage spécifiée.

addVerticalPageBreak(pageBreakRange: Range | string): PageBreak;

Paramètres

pageBreakRange: ExcelScript.Range | string

Plage immédiatement après le saut de page à ajouter.

Retours

ExcelScript.PageBreak

addWorksheetCustomProperty(key, value)

Ajoute une nouvelle propriété personnalisée qui correspond à la clé fournie. Cette opération remplace les propriétés personnalisées existantes par cette clé.

addWorksheetCustomProperty(
            key: string,
            value: string
        ): WorksheetCustomProperty;

Paramètres

key: string

Clé qui identifie l’objet de propriété personnalisé. Il ne respecte pas la casse. La clé est limitée à 255 caractères (des valeurs plus grandes entraînent la levée d’une InvalidArgument erreur.)

value: string

Valeur de cette propriété personnalisée.

Retours

ExcelScript.WorksheetCustomProperty

calculate(markAllDirty)

Calcule toutes les cellules d’une feuille de calcul.

calculate(markAllDirty: boolean): void;

Paramètres

markAllDirty: boolean

True, pour marquer tout comme sale.

Retours

void

copy(positionType, relativeTo)

Copie une feuille de calcul et la place à la position spécifiée.

copy(
            positionType?: WorksheetPositionType,
            relativeTo?: Worksheet
        ): Worksheet;

Paramètres

positionType: ExcelScript.WorksheetPositionType

Emplacement dans le classeur où placer la feuille de calcul nouvellement créée. La valeur par défaut est « None », ce qui insère la feuille de calcul au début de la feuille de calcul.

relativeTo: ExcelScript.Worksheet

Feuille de calcul existante qui détermine la position de la feuille de calcul nouvellement créée. Cela n’est nécessaire que si positionType est « Avant » ou « Après ».

Retours

ExcelScript.Worksheet

Exemples

/**
 * This script duplicates a worksheet named "Template". 
 * The new worksheet is added after the template.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the worksheet named "Template".
  let template = workbook.getWorksheet("Template");

  // Copy the worksheet.
  let newSheet = template.copy(
    ExcelScript.WorksheetPositionType.after,
    template
  );

  // Name the worksheet using the current date.
  let date = new Date(Date.now());
  newSheet.setName(`${date.toDateString()}`);
}

delete()

Supprime la feuille de calcul du classeur. Notez que si la visibilité de la feuille de calcul est définie sur « VeryHidden », l’opération de suppression échoue avec une InvalidOperation exception. Vous devez d’abord modifier sa visibilité sur masquée ou visible avant de la supprimer.

delete(): void;

Retours

void

Exemples

/**
 * The following scripts removes the first worksheet in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first worksheet.
  let sheet = workbook.getWorksheets()[0];

  // Remove that worksheet from the workbook.
  sheet.delete();
}

enterTemporaryNamedSheetView()

Crée et active une nouvelle vue de feuille temporaire. Les vues temporaires sont supprimées lors de la fermeture de l’application, de la sortie de la vue temporaire avec la méthode de sortie ou du basculement vers une autre vue feuille. La vue feuille temporaire est également accessible avec la chaîne vide (« »), si l’affichage temporaire existe.

enterTemporaryNamedSheetView(): NamedSheetView;

Retours

ExcelScript.NamedSheetView

exitActiveNamedSheetView()

Quitte l’affichage feuille actuellement actif.

exitActiveNamedSheetView(): void;

Retours

void

findAll(text, criteria)

Recherche toutes les occurrences de la chaîne donnée en fonction des critères spécifiés et les renvoie en tant qu’objet RangeAreas , comprenant une ou plusieurs plages rectangulaires.

findAll(text: string, criteria: WorksheetSearchCriteria): RangeAreas;

Paramètres

text: string

Chaîne à rechercher.

criteria: ExcelScript.WorksheetSearchCriteria

Critères de recherche supplémentaires, notamment si la recherche doit correspondre à la cellule entière ou respecter la casse.

Retours

ExcelScript.RangeAreas

Exemples

/**
 * This script searches through a worksheet and finds cells containing "No". 
 * Those cells are filled with the color red.
 * Use Range.find instead of Worksheet.findAll when you want to limit the search to a specific range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current, active worksheet.
  let worksheet = workbook.getActiveWorksheet();
  let noCells = worksheet.findAll("No", { completeMatch: true });

  // Set the fill color to red.
  noCells.getFormat().getFill().setColor("red");
}

getActiveNamedSheetView()

Obtient l’affichage feuille actuellement actif de la feuille de calcul.

getActiveNamedSheetView(): NamedSheetView;

Retours

ExcelScript.NamedSheetView

getAutoFilter()

Représente l’objet AutoFilter de la feuille de calcul.

getAutoFilter(): AutoFilter;

Retours

ExcelScript.AutoFilter

Exemples

/**
 * This script creates an autoFilter on the worksheet that filters out rows based on column values. 
 * The autoFilter filters to only include rows that have a value in column D in the top 10 percentile 
 * (of column D values).
 */
function main(workbook: ExcelScript.Workbook) {
  const currentSheet = workbook.getActiveWorksheet();
  const dataRange = currentSheet.getUsedRange();

  // Add a filter that will only show the rows with the top 10% of values in column D
  // (index 3, assuming the used range spans from at least A:D).
  currentSheet.getAutoFilter().apply(dataRange, 3, {
    criterion1: "10",
    filterOn: ExcelScript.FilterOn.topPercent
  });
}

getCell(row, column)

Obtient l’objet Range contenant la cellule unique en fonction des numéros de ligne et de colonne. La cellule peut se trouver en dehors des limites de sa plage parente, tant qu’elle reste dans la grille de feuille de calcul.

getCell(row: number, column: number): Range;

Paramètres

row: number

Numéro de ligne de la cellule à récupérer. Avec indice zéro.

column: number

Numéro de colonne de la cellule à récupérer. Avec indice zéro.

Retours

ExcelScript.Range

getChart(name)

Extrait un graphique à l’aide de son nom. Si plusieurs graphiques portent le même nom, c’est le premier d’entre eux qui est renvoyé. Si le graphique n’existe pas, cette méthode retourne undefined.

getChart(name: string): Chart | undefined;

Paramètres

name: string

Nom du graphique à extraire.

Retours

ExcelScript.Chart | undefined

Exemples

/**
 * This sample moves an existing chart to a specific place on the worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();
  
  // Get an existing chart named "ColumnChart".
  let chart = selectedSheet.getChart("ColumnChart");

  // Place the chart over the range "F1:L13".
  chart.setPosition("F1", "L13");
}

getCharts()

Retourne une collection de graphiques qui font partie de la feuille de calcul.

getCharts(): Chart[];

Retours

ExcelScript.Chart[]

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

Renvoie une collection de tous les objets Lecteur sur l’ordinateur.

getComments(): Comment[];

Retours

ExcelScript.Comment[]

getCustomProperties()

Obtient une collection de propriétés personnalisées au niveau de la feuille de calcul.

getCustomProperties(): WorksheetCustomProperty[];

Retours

ExcelScript.WorksheetCustomProperty[]

getEnableCalculation()

Détermine si Excel doit recalculer la feuille de calcul si nécessaire. True si Excel recalcule la feuille de calcul si nécessaire. Elle a la valeur False si Excel ne recalcule pas la feuille.

getEnableCalculation(): boolean;

Retours

boolean

getFreezePanes()

Obtient un objet qui peut être utilisé pour manipuler des volets figés dans la feuille de calcul.

getFreezePanes(): WorksheetFreezePanes;

Retours

ExcelScript.WorksheetFreezePanes

getHorizontalPageBreaks()

Obtient la collection de saut de page horizontal pour la feuille de calcul. Cette collection contient uniquement les sauts de page manuels.

getHorizontalPageBreaks(): PageBreak[];

Retours

ExcelScript.PageBreak[]

getId()

Renvoie une valeur qui permet d’identifier la feuille de calcul de façon unique dans un classeur donné. La valeur de l’identificateur reste identique, même lorsque la feuille de calcul est renommée ou déplacée.

getId(): string;

Retours

string

getName()

Nom complet de la feuille de calcul. Le nom doit comporter moins de 32 caractères.

getName(): string;

Retours

string

Exemples

/**
 * This sample gets all the worksheet names in the workbook.
 * It then logs those names to the console.
 */
function main(workbook: ExcelScript.Workbook) {
    // Create an array to hold the worksheet names.
    let worksheetNames = [];

    // Iterate over the worksheet collection in the workbook.
    for (let worksheet of workbook.getWorksheets()) {
        worksheetNames.push(worksheet.getName());
    }

    // Log the array of worksheet names.
    console.log(worksheetNames);
}

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

getNamedSheetView(key)

Obtient une vue de feuille à l’aide de son nom. Si l’objet en mode Feuille n’existe pas, cette méthode retourne undefined.

getNamedSheetView(key: string): NamedSheetView | undefined;

Paramètres

key: string

Nom respectant la casse de l’affichage feuille. Utilisez la chaîne vide (« ») pour obtenir l’affichage de feuille temporaire, si l’affichage temporaire existe.

Retours

ExcelScript.NamedSheetView | undefined

getNamedSheetViews()

Retourne une collection d’affichages feuille qui sont présents dans la feuille de calcul.

getNamedSheetViews(): NamedSheetView[];

Retours

ExcelScript.NamedSheetView[]

getNames()

Collection de noms inclus dans l’étendue de la feuille de calcul active.

getNames(): NamedItem[];

Retours

ExcelScript.NamedItem[]

getNext(visibleOnly)

Obtient la feuille de calcul qui suit celle-ci. Si aucune feuille de calcul ne suit celle-ci, cette méthode retourne undefined.

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

getPageLayout()

Obtient l’objet PageLayout de la feuille de calcul.

getPageLayout(): PageLayout;

Retours

ExcelScript.PageLayout

Exemples

/**
 * This script sets the printing orientation for the entire workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Go to each worksheet so the print settings are consistent.
  workbook.getWorksheets().forEach((sheet) => {
    const pageLayout = sheet.getPageLayout();

    // Print every page with a landscape orientation.
    pageLayout.setOrientation(ExcelScript.PageOrientation.landscape);
  });
}

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

Collection de tableaux croisés dynamiques qui font partie de la feuille de calcul.

getPivotTables(): PivotTable[];

Retours

ExcelScript.PivotTable[]

getPosition()

Position de la feuille de calcul au sein du classeur (sur une base zéro).

getPosition(): number;

Retours

number

getPrevious(visibleOnly)

Obtient la feuille de calcul qui précède celle-ci. S’il n’existe aucune feuille de calcul précédente, cette méthode retourne undefined.

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

getProtection()

Renvoie l’objet de protection de feuille pour une feuille de calcul.

getProtection(): WorksheetProtection;

Retours

ExcelScript.WorksheetProtection

Exemples

/**
 * This script protects cells from being selected on the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the protection settings for the current worksheet.
  const currentSheet = workbook.getActiveWorksheet();
  const sheetProtection = currentSheet.getProtection();

  // Create a new WorksheetProtectionOptions object with the selectionMode property set to `none`.
  let protectionOptions : ExcelScript.WorksheetProtectionOptions = {
    selectionMode: ExcelScript.ProtectionSelectionMode.none
  }

  // Apply the given protection options.
  sheetProtection.protect(protectionOptions);
}

getRange(address)

Obtient l’objet Range , qui représente un seul bloc rectangulaire de cellules, spécifié par l’adresse ou le nom.

getRange(address?: string): Range;

Paramètres

address: string

Optional. Chaîne représentant l’adresse ou le nom de la plage. Par exemple, « A1 :B2 ». Si cette propriété n’est pas définie, la plage de la feuille de calcul toute entière est renvoyée.

Retours

ExcelScript.Range

Exemples

/**
 * This sample reads the value of A1 and prints it to the console.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the value of cell A1.
  let range = selectedSheet.getRange("A1");
  
  // Print the value of A1.
  console.log(range.getValue());
}

getRangeByIndexes(startRow, startColumn, rowCount, columnCount)

Obtient l’objet Range commençant à un index de ligne et d’un index de colonne particuliers, et couvrant un certain nombre de lignes et de colonnes.

getRangeByIndexes(
            startRow: number,
            startColumn: number,
            rowCount: number,
            columnCount: number
        ): Range;

Paramètres

startRow: number

Ligne de début (indexé zéro).

startColumn: number

Colonne de début (indexé zéro).

rowCount: number

Nombre de lignes à inclure dans la plage.

columnCount: number

Nombre de colonnes à inclure dans la plage.

Retours

ExcelScript.Range

getRanges(address)

Obtient l’objet RangeAreas , qui représente un ou plusieurs blocs de plages rectangulaires, spécifiés par l’adresse ou le nom.

getRanges(address?: string): RangeAreas;

Paramètres

address: string

Optional. Chaîne contenant les adresses ou les noms séparés par des virgules ou des points-virgules des plages individuelles. Par exemple, « A1 :B2, A5 :B5 » ou « A1 :B2 ; A5 :B5". S’il n’est pas spécifié, un RangeAreas objet pour la feuille de calcul entière est retourné.

Retours

ExcelScript.RangeAreas

getShape(key)

Obtient une forme à l’aide de son nom ou de son ID. Si l’objet shape n’existe pas, cette méthode retourne undefined.

getShape(key: string): Shape | undefined;

Paramètres

key: string

Nom ou ID de la forme à récupérer.

Retours

ExcelScript.Shape | undefined

getShapes()

Renvoie une collection de tous les objets Forme sur la feuille de calcul.

getShapes(): Shape[];

Retours

ExcelScript.Shape[]

getShowGridlines()

Spécifie si le quadrillage est visible par l’utilisateur.

getShowGridlines(): boolean;

Retours

boolean

getShowHeadings()

Spécifie si les titres sont visibles par l’utilisateur.

getShowHeadings(): boolean;

Retours

boolean

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

Retourne une collection de segments qui font partie de la feuille de calcul.

getSlicers(): Slicer[];

Retours

ExcelScript.Slicer[]

getStandardHeight()

Renvoie la hauteur standard (par défaut) de toutes les lignes dans la feuille de calcul, en points.

getStandardHeight(): number;

Retours

number

getStandardWidth()

Spécifie la largeur standard (par défaut) de toutes les colonnes de la feuille de calcul. Une unité de largeur de colonne est égale à la largeur d'un caractère du style Normal. Dans le cas des polices proportionnelles, la largeur du caractère 0 (zéro) est utilisée.

getStandardWidth(): number;

Retours

number

getTabColor()

Couleur d’onglet de la feuille de calcul. Lors de la récupération de la couleur de l’onglet, si la feuille de calcul est invisible, la valeur est null. Si la feuille de calcul est visible, mais que la couleur de l’onglet est définie sur auto, une chaîne vide est retournée. Sinon, la propriété sera définie sur une couleur, au format #RRGGBB (par exemple, « FFA500 »). Lorsque vous définissez la couleur, utilisez une chaîne vide pour définir une couleur « auto » ou une couleur réelle dans le cas contraire.

getTabColor(): string;

Retours

string

getTabId()

Retourne une valeur représentant cette feuille de calcul qui peut être lue par Open Office XML. Il s’agit d’une valeur entière, qui est différente de worksheet.id (qui retourne un identificateur global unique) et worksheet.name (qui retourne une valeur telle que « Sheet1 »).

getTabId(): number;

Retours

number

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

Collection de tableaux qui font partie de la feuille de calcul.

getTables(): Table[];

Retours

ExcelScript.Table[]

getUsedRange(valuesOnly)

getUsedRange(valuesOnly?: boolean): Range;

Paramètres

valuesOnly: boolean

Optional. Prend uniquement en compte les cellules avec des valeurs sous forme de cellules utilisées.

Retours

ExcelScript.Range

getVerticalPageBreaks()

Obtient la collection de saut de page vertical pour la feuille de calcul. Cette collection contient uniquement les sauts de page manuels.

getVerticalPageBreaks(): PageBreak[];

Retours

ExcelScript.PageBreak[]

getVisibility()

Visibilité de la feuille de calcul.

getVisibility(): SheetVisibility;

Retours

ExcelScript.SheetVisibility

getWorksheetCustomProperty(key)

Obtient un objet de propriété personnalisé par sa clé, qui ne tient pas compte de la casse. Si la propriété personnalisée n’existe pas, cette méthode retourne undefined.

getWorksheetCustomProperty(
            key: string
        ): WorksheetCustomProperty | undefined;

Paramètres

key: string

Clé qui identifie l’objet de propriété personnalisé. Il ne respecte pas la casse.

Retours

ExcelScript.WorksheetCustomProperty | undefined

refreshAllPivotTables()

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

refreshAllPivotTables(): void;

Retours

void

removeAllHorizontalPageBreaks()

Redéfinit tous les sauts de page de la collection.

removeAllHorizontalPageBreaks(): void;

Retours

void

removeAllVerticalPageBreaks()

Redéfinit tous les sauts de page de la collection.

removeAllVerticalPageBreaks(): void;

Retours

void

replaceAll(text, replacement, criteria)

Détecte et remplace la chaîne donnée basée sur les critères spécifiés dans la plage active.

replaceAll(
            text: string,
            replacement: string,
            criteria: ReplaceCriteria
        ): number;

Paramètres

text: string

Chaîne à rechercher.

replacement: string

Chaîne qui remplace la chaîne d’origine.

criteria: ExcelScript.ReplaceCriteria

Critères de remplacement supplémentaires.

Retours

number

setEnableCalculation(enableCalculation)

Détermine si Excel doit recalculer la feuille de calcul si nécessaire. True si Excel recalcule la feuille de calcul si nécessaire. Elle a la valeur False si Excel ne recalcule pas la feuille.

setEnableCalculation(enableCalculation: boolean): void;

Paramètres

enableCalculation: boolean

Retours

void

setName(name)

Nom complet de la feuille de calcul. Le nom doit comporter moins de 32 caractères.

setName(name: string): void;

Paramètres

name: string

Retours

void

Exemples

/**
 * This sample renames a worksheet from "Sheet1" to "SALES".
 */
function main(workbook: ExcelScript.Workbook) {
  // Get a worksheet named "Sheet1".
  const sheet = workbook.getWorksheet('Sheet1'); 

  // Set its name to SALES.
  sheet.setName('SALES');
}

setPosition(position)

Position de la feuille de calcul au sein du classeur (sur une base zéro).

setPosition(position: number): void;

Paramètres

position: number

Retours

void

Exemples

/**
 * This sample sets the worksheet named "SALES" as the first sheet in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get a worksheet named "SALES".
  const sheet = workbook.getWorksheet('SALES'); 
  // Position the worksheet at the beginning of the workbook.
  sheet.setPosition(0);
}

setShowGridlines(showGridlines)

Spécifie si le quadrillage est visible par l’utilisateur.

setShowGridlines(showGridlines: boolean): void;

Paramètres

showGridlines: boolean

Retours

void

setShowHeadings(showHeadings)

Spécifie si les titres sont visibles par l’utilisateur.

setShowHeadings(showHeadings: boolean): void;

Paramètres

showHeadings: boolean

Retours

void

setStandardWidth(standardWidth)

setStandardWidth(standardWidth: number): void;

Paramètres

standardWidth: number

Retours

void

setTabColor(tabColor)

setTabColor(tabColor: string): void;

Paramètres

tabColor: string

Retours

void

Exemples

/**
 * This script sets the tab color of every worksheet in the workbook to red.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get all the worksheets in the workbook. 
  let sheets = workbook.getWorksheets();
  
  // Set the tab color of each worksheet to a random color.
  for (let sheet of sheets) {    
    // Set the color of the current worksheet's tab to red.
    sheet.setTabColor("red");
  }
}

setVisibility(visibility)

Visibilité de la feuille de calcul.

setVisibility(visibility: SheetVisibility): void;

Paramètres

visibility: ExcelScript.SheetVisibility

Retours

void

Exemples

/**
 * This script unhides all the worksheets in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Iterate over each worksheet.
  workbook.getWorksheets().forEach((worksheet) => {
    // Set the worksheet visibility to visible.
    worksheet.setVisibility(ExcelScript.SheetVisibility.visible);
  });
}

showOutlineLevels(rowLevels, columnLevels)

Affiche les groupes de lignes ou de colonnes selon leurs niveaux hiérarchiques. Présente les groupes et résume une liste de données dans la feuille de calcul. Les rowLevels paramètres et columnLevels spécifient le nombre de niveaux du plan qui seront affichés. La plage d’arguments acceptables est comprise entre 0 et 8. La valeur 0 ne modifie pas l’affichage actuel. Une valeur supérieure au nombre actuel de niveaux affiche tous les niveaux.

showOutlineLevels(rowLevels: number, columnLevels: number): void;

Paramètres

rowLevels: number

Nombre de niveaux de ligne d’un plan à afficher.

columnLevels: number

Nombre de niveaux de colonne d’un plan à afficher.

Retours

void

Partager via

ExcelScript.Worksheet interface

Remarques

Exemples

Méthodes

Détails de la méthode

activate()

Retours

Exemples

addChart(type, sourceData, seriesBy)

Paramètres

Retours

Exemples

addComment(cellAddress, content, contentType)

Paramètres

Retours

addGeometricShape(geometricShapeType)

Paramètres

Retours

Exemples

addGroup(values)

Paramètres

Retours

addHorizontalPageBreak(pageBreakRange)

Paramètres

Retours

addImage(base64ImageString)

Paramètres

Retours

Exemples

addLine(startLeft, startTop, endLeft, endTop, connectorType)

Paramètres

Retours

addNamedItem(name, reference, comment)

Paramètres

Retours

addNamedItemFormulaLocal(name, formula, comment)

Paramètres

Retours

addNamedSheetView(name)

Paramètres

Retours

addPivotTable(name, source, destination)

Paramètres

Retours

Exemples

addSlicer(slicerSource, sourceField, slicerDestination)

Paramètres

Retours

Exemples

addTable(address, hasHeaders)

Paramètres

Retours

Exemples

addTextBox(text)

Paramètres

Retours

addVerticalPageBreak(pageBreakRange)

Paramètres

Retours

addWorksheetCustomProperty(key, value)

Paramètres

Retours

calculate(markAllDirty)

Paramètres

Retours

copy(positionType, relativeTo)

Paramètres

Retours

Exemples

delete()

Retours

Exemples

enterTemporaryNamedSheetView()

Retours

exitActiveNamedSheetView()

Retours

findAll(text, criteria)

Paramètres

Retours