ExcelScript.Range interface

Référence

Paquet:: ExcelScript

Range représente un ensemble d’une ou plusieurs cellules contiguës telles qu’une cellule, une ligne, une colonne ou un bloc de cellules.

Remarques

Exemples

/**
 * This script logs the address of the used range in the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current, active worksheet.
  let currentWorksheet = workbook.getActiveWorksheet();

  // Get the range containing all the cells with data or formatting.
  let usedRange = currentWorksheet.getUsedRange();

  // Log the range's address to the console.
  console.log(usedRange.getAddress());
}

Méthodes

addConditionalFormat(type)	Ajoute un nouveau format conditionnel à la collection à la première/première priorité.
autoFill(destinationRange, autoFillType)	Remplit une plage de la plage actuelle à la plage de destination à l’aide de la logique de remplissage automatique spécifiée. La plage de destination peut être `null` ou étendre la plage source horizontalement ou verticalement. Les plages discontiguées ne sont pas prises en charge.
calculate()	Calcule une plage de cellules dans une feuille de calcul.
clear(applyTo)	Supprime les valeurs et les propriétés de format, de remplissage, de bordure, etc. de la plage.
clearAllConditionalFormats()	Efface toutes les mises en forme conditionnelles actives sur la plage spécifiée actuelle.
convertDataTypeToText()	Convertit les cellules de plage avec des types de données en texte.
copyFrom(sourceRange, copyType, skipBlanks, transpose)	Copie les données de cellule ou la mise en forme de la plage source ou `RangeAreas` vers la plage actuelle. La plage de destination peut avoir une taille différente de celle de la plage source ou `RangeAreas`. La destination est développée automatiquement si elle est plus petite que la source. Remarque : Comme la fonctionnalité de copie dans l’interface utilisateur Excel, si la plage de destination est un multiple exact supérieur à la plage source dans les lignes ou les colonnes, le contenu source est répliqué plusieurs fois. Par exemple, une copie de plage 2x2 dans une plage 2x6 entraîne 3 copies de la plage 2x2 d’origine.
delete(shift)	Supprime les cellules associées à la plage.
find(text, criteria)	Recherche la chaîne donnée basée sur les critères spécifiés. Si la plage actuelle est supérieure à une seule cellule, la recherche est limitée à cette plage, sinon la recherche couvre la feuille entière à partir de cette cellule. S’il n’existe aucune correspondance, cette méthode retourne `undefined`.
flashFill()	Effectue un remplissage instantané sur la plage actuelle. Le remplissage instantané remplit automatiquement les données lorsqu’il détecte un modèle. La plage doit donc être une seule plage de colonnes et contenir des données autour de celle-ci pour trouver un modèle.
getAbsoluteResizedRange(numRows, numColumns)	Obtient un `Range` objet avec la même cellule en haut à gauche que l’objet actuel `Range` , mais avec le nombre spécifié de lignes et de colonnes.
getAddress()	Spécifie la référence de plage dans le style A1. La valeur d’adresse contient la référence de la feuille (par exemple, « Sheet1 ! A1 :B4").
getAddressLocal()	Représente la référence de plage pour la plage spécifiée dans la langue de l’utilisateur.
getBoundingRect(anotherRange)	Renvoie le plus petit objet de plage qui englobe les plages données. Par exemple, « `GetBoundingRect` B2 :C5 » et « D10 :E15 » est « B2 :E15 ».
getCell(row, column)	Renvoie l’objet de plage qui contient une cellule donnée sur la base 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. L’emplacement de la cellule renvoyée est déterminé à partir de la cellule supérieure gauche de la plage.
getCellCount()	Spécifie le nombre de cellules dans la plage. Cette API renvoie -1 si le nombre de cellules est supérieur à 2^31-1 (2 147 483 647).
getColumn(column)	Obtient une colonne contenue dans la plage.
getColumnCount()	Spécifie le nombre total de colonnes dans la plage.
getColumnHidden()	Représente si toutes les colonnes de la plage actuelle sont masquées. La valeur est `true` lorsque toutes les colonnes d’une plage sont masquées. La valeur est quand aucune colonne de la plage n’est `false` masquée. La valeur est `null` lorsque certaines colonnes d’une plage sont masquées et que d’autres colonnes de la même plage ne sont pas masquées.
getColumnIndex()	Spécifie le numéro de colonne de la première cellule de la plage. Avec indice zéro.
getColumnsAfter(count)	Obtient un certain nombre de colonnes à droite de l’objet actuel `Range` .
getColumnsBefore(count)	Obtient un certain nombre de colonnes à gauche de l’objet actuel `Range` .
getConditionalFormat(id)	Retourne un format conditionnel identifié par son ID. Si l’objet de format conditionnel n’existe pas, cette méthode retourne `undefined`.
getConditionalFormats()	Collection de `ConditionalFormats` qui croise la plage.
getDataValidation()	Renvoie un objet de validation des données.
getDirectPrecedents()	Renvoie un `WorkbookRangeAreas` objet qui représente la plage contenant toutes les cellules de précédent direct d’une plage spécifiée dans la même feuille de calcul ou dans plusieurs feuilles de calcul.
getEntireColumn()	Obtient un objet qui représente la colonne entière de la plage (par exemple, si la plage actuelle représente les cellules « B4 :E11 », il s’agit `getEntireColumn` d’une plage qui représente les colonnes « B :E »).
getEntireRow()	Obtient un objet qui représente la ligne entière de la plage (par exemple, si la plage actuelle représente les cellules « B4 :E11 », il s’agit `GetEntireRow` d’une plage qui représente les lignes « 4:11 »).
getExtendedRange(direction, activeCell)	Retourne un objet de plage qui inclut la plage actuelle et jusqu’au bord de la plage, en fonction de la direction fournie. Cela correspond au comportement Ctrl+Maj+Touche de direction dans l’interface utilisateur Excel sur Windows.
getFormat()	Renvoie un objet de format, encapsulant la police, le remplissage, les bordures, l’alignement et d’autres propriétés de la plage.
getFormula()	Représente la formule de cellule en notation de style A1. Si la plage contient plusieurs cellules, les données de la première cellule (représentées par l’index de ligne de 0 et l’index de colonne de 0) sont retournées.
getFormulaLocal()	Représente la formule de cellule en notation de style A1, dans la langue de l’utilisateur et les paramètres régionaux de mise en forme des nombres. Par exemple, la formule « =SUM(A1, 1.5) » en anglais deviendrait « =SUMME(A1; 1,5) » en allemand. Si la plage contient plusieurs cellules, les données de la première cellule (représentées par l’index de ligne de 0 et l’index de colonne de 0) sont retournées.
getFormulaR1C1()	Représente la formule de cellule en notation de style R1C1. Si la plage contient plusieurs cellules, les données de la première cellule (représentées par l’index de ligne de 0 et l’index de colonne de 0) sont retournées.
getFormulas()	Représente la formule dans le style de notation A1. Si une cellule n’a pas de formule, sa valeur est retournée à la place.
getFormulasLocal()	Représente la formule en notation A1, en utilisant le langage et les paramètres de format de nombre régionaux de l’utilisateur. Par exemple, la formule « =SUM(A1, 1.5) » en anglais deviendrait « =SUMME(A1; 1,5) » en allemand. Si une cellule n’a pas de formule, sa valeur est retournée à la place.
getFormulasR1C1()	Représente la formule dans le style de notation R1C1. Si une cellule n’a pas de formule, sa valeur est retournée à la place.
getHasSpill()	Représente si toutes les cellules ont une bordure renversée. Renvoie `true` si toutes les cellules ont une bordure de déversement, ou `false` si toutes les cellules n’ont pas de bordure de déversement. Retourne `null` s’il existe des cellules avec et sans bordures de déversement dans la plage.
getHeight()	Retourne la distance en points, pour un zoom à 100 %, entre le bord supérieur de la plage et le bord inférieur de la plage.
getHidden()	Représente si toutes les cellules de la plage actuelle sont masquées. La valeur est `true` lorsque toutes les cellules d’une plage sont masquées. La valeur est quand aucune cellule de la plage n’est `false` masquée. La valeur est `null` lorsque certaines cellules d’une plage sont masquées et que d’autres cellules de la même plage ne sont pas masquées.
getHyperlink()	Représente le lien hypertexte pour la plage actuelle.
getImage()	Restitue la plage sous la forme d’une image png codée en base64.
getIntersection(anotherRange)	Obtient l’objet de plage qui représente l’intersection rectangulaire des plages données. Si aucune intersection n’est trouvée, cette méthode retourne `undefined`.
getIsEntireColumn()	Représente si la plage active est une colonne entière.
getIsEntireRow()	Représente si la plage active est une ligne entière.
getLastCell()	Obtient la dernière cellule de la plage. Par exemple, la dernière cellule de la plage « B2:D5 » est « D5 ».
getLastColumn()	Obtient la dernière colonne de la plage. Par exemple, la dernière colonne de la plage « B2:D5 » est « D2:D5 ».
getLastRow()	Obtient la dernière ligne de la plage. Par exemple, la dernière ligne de la plage « B2:D5 » est « B5:D5 ».
getLeft()	Retourne la distance en points, pour un zoom à 100 %, entre le bord gauche de la feuille de calcul et le bord gauche de la plage.
getLinkedDataTypeState()	Représente l’état du type de données de la cellule.
getLinkedDataTypeStates()	Représente l’état du type de données de chaque cellule.
getMergedAreas()	Renvoie un `RangeAreas` objet qui représente les zones fusionnées dans cette plage. Notez que si le nombre de zones fusionnées dans cette plage est supérieur à 512, cette méthode ne retourne pas le résultat. Si l’objet `RangeAreas` n’existe pas, cette fonction retourne `undefined`.
getNumberFormat()	Représente le code de format numérique Excel de cellule pour la plage donnée. Si la plage contient plusieurs cellules, les données de la première cellule (représentées par l’index de ligne de 0 et l’index de colonne de 0) sont retournées.
getNumberFormatCategories()	Représente la catégorie de format numérique de chaque cellule.
getNumberFormatCategory()	Spécifie la catégorie de format numérique de la première cellule de la plage (représentée par l’index de ligne de 0 et l’index de colonne de 0).
getNumberFormatLocal()	Représente le code de format numérique Excel de la cellule pour la plage donnée, en fonction des paramètres de langue de l’utilisateur. Excel n’effectue aucune contrainte de langage ou de mise en forme lors de l’obtention ou de la définition de la `numberFormatLocal` propriété. Tout texte retourné utilise les chaînes mises en forme localement en fonction de la langue spécifiée dans les paramètres système. Si la plage contient plusieurs cellules, les données de la première cellule (représentées par l’index de ligne de 0 et l’index de colonne de 0) sont retournées.
getNumberFormats()	Représente le code de format numérique d’Excel pour la plage donnée.
getNumberFormatsLocal()	Représente le code de format numérique d’Excel pour la plage donnée, en fonction des paramètres de langue de l’utilisateur. Excel n’effectue aucune contrainte de langage ou de mise en forme lors de l’obtention ou de la définition de la `numberFormatLocal` propriété. Tout texte retourné utilise les chaînes mises en forme localement en fonction de la langue spécifiée dans les paramètres système.
getOffsetRange(rowOffset, columnOffset)	Obtient un objet qui représente une plage décalée par rapport à la plage spécifiée. Les dimensions de la plage renvoyée correspondent à cette plage. Si la plage obtenue se retrouve en dehors des limites de grille de la feuille de calcul, une erreur est déclenchée.
getPivotTables(fullyContained)	Obtient une collection délimitée de tableaux croisés dynamiques qui chevauchent la plage.
getPredefinedCellStyle()	Représente le style de la plage actuelle. Si les styles des cellules sont incohérents, `null` est retourné. Pour les styles personnalisés, le nom du style est retourné. Pour les styles intégrés, une chaîne représentant une valeur dans l’énumération `BuiltInStyle` est retournée.
getRangeEdge(direction, activeCell)	Retourne un objet de plage qui est la cellule de bord de la région de données qui correspond à la direction fournie. Cela correspond au comportement ctrl+touche de direction dans l’interface utilisateur d’Excel sur Windows.
getResizedRange(deltaRows, deltaColumns)	Obtient un `Range` objet similaire à l’objet actuel `Range` , mais avec son coin inférieur droit développé (ou contracté) par un certain nombre de lignes et de colonnes.
getRow(row)	Obtient une ligne contenue dans la plage.
getRowCount()	Renvoie le nombre total de lignes de la plage.
getRowHidden()	Représente si toutes les lignes de la plage actuelle sont masquées. La valeur est `true` lorsque toutes les lignes d’une plage sont masquées. La valeur est quand aucune ligne de la plage n’est `false` masquée. La valeur est `null` lorsque certaines lignes d’une plage sont masquées et que d’autres lignes de la même plage ne sont pas masquées.
getRowIndex()	Renvoie le numéro de ligne de la première cellule de la plage. Avec indice zéro.
getRowsAbove(count)	Obtient un certain nombre de lignes au-dessus de l’objet actuel `Range` .
getRowsBelow(count)	Obtient un certain nombre de lignes sous l’objet actuel `Range` .
getSavedAsArray()	Représente si toutes les cellules doivent être enregistrées sous forme de formule matricielle. Retourne `true` si toutes les cellules sont enregistrées en tant que formule matricielle, ou `false` si toutes les cellules ne sont pas enregistrées en tant que formule matricielle. Renvoie `null` si certaines cellules sont enregistrées en tant que formule matricielle et que d’autres ne le sont pas.
getSort()	Représente le tri de plage de la plage actuelle.
getSpecialCells(cellType, cellValueType)	Obtient l’objet `RangeAreas` , comprenant une ou plusieurs plages, qui représente toutes les cellules qui correspondent au type et à la valeur spécifiés. Si aucune cellule spéciale n’est trouvée, cette méthode retourne `undefined`.
getSpillingToRange()	Obtient l’objet de la plage contenant la plage renversé lorsque appelée sur une cellule d’ancrage. Si la plage n’est pas une cellule d’ancrage ou si la plage de déversement est introuvable, cette méthode retourne `undefined`.
getSpillParent()	Obtient l’objet de plage contenant la cellule d’ancrage pour la cellule qui est renversée. S’il ne s’agit pas d’une cellule renversée ou si plusieurs cellules sont fournies, cette méthode retourne `undefined`.
getSurroundingRegion()	Renvoie un `Range` objet qui représente la région environnante pour la cellule en haut à gauche de cette plage. Une région environnante est une plage délimitée par une combinaison de lignes et de colonnes vides par rapport à cette plage.
getTables(fullyContained)	Obtient une collection de tableaux qui se chevauchent avec la plage dans l’étendue.
getText()	Représente la valeur Text de la plage spécifiée. La valeur de texte ne dépend pas de la largeur de la cellule. Le remplacement par le signe # qui se produit dans l’interface utilisateur d’Excel n’a aucun effet sur la valeur de texte renvoyée par l’API. Si la plage contient plusieurs cellules, les données de la première cellule (représentées par l’index de ligne de 0 et l’index de colonne de 0) sont retournées.
getTexts()	Valeurs de texte de la plage spécifiée. La valeur de texte ne dépend pas de la largeur de la cellule. La substitution de signe numérique (#) qui se produit dans l’interface utilisateur Excel n’affecte pas la valeur de texte retournée par l’API.
getTop()	Retourne la distance en points, pour un zoom à 100 %, entre le bord supérieur de la feuille de calcul et le bord supérieur de la plage.
getUsedRange(valuesOnly)	Renvoie la plage utilisée d’un objet de plage donné. Si aucune cellule n’est utilisée dans la plage, cette méthode retourne `undefined`.
getValue()	Représente la valeur brute de la plage spécifiée. Les données renvoyées peuvent être des chaînes, des valeurs numériques ou des valeurs booléennes. Une cellule contenant une erreur renvoie la chaîne d’erreur. Si la plage contient plusieurs cellules, les données de la première cellule (représentées par l’index de ligne de 0 et l’index de colonne de 0) sont retournées.
getValues()	Représente les valeurs brutes de la plage spécifiée. Les données retournées peuvent être une chaîne, un nombre ou une valeur booléenne. Les cellules contenant une erreur renvoie la chaîne d’erreur. Si la valeur retournée commence par un signe plus (« + »), moins (« - ») ou égal (« = »), Excel interprète cette valeur comme une formule.
getValueType()	Représente le type de données dans la cellule. Si la plage contient plusieurs cellules, les données de la première cellule (représentées par l’index de ligne de 0 et l’index de colonne de 0) sont retournées.
getValueTypes()	Spécifie le type de données dans chaque cellule.
getVisibleView()	Représente les lignes visibles de la plage en cours.
getWidth()	Retourne la distance en points, pour un zoom de 100 %, entre le bord gauche de la plage et le bord droit de la plage.
getWorksheet()	Feuille de calcul contenant la plage.
group(groupOption)	Groupes colonnes et lignes d’un plan.
hideGroupDetails(groupOption)	Masque les détails du groupe de lignes ou de colonnes.
insert(shift)	Insère une cellule ou une plage de cellules dans la feuille de calcul à la place d’une plage donnée et décale les autres cellules pour libérer de l’espace. Retourne un nouvel `Range` objet à l’espace maintenant vide.
merge(across)	Fusionne la plage de cellules dans une zone de la feuille de calcul.
moveTo(destinationRange)	Déplace les valeurs de cellule, la mise en forme et les formules de la plage actuelle vers la plage de destination, en remplaçant les anciennes informations dans ces cellules. La plage de destination est développée automatiquement si elle est plus petite que la plage actuelle. Les cellules de la plage de destination qui se trouvent en dehors de la zone de la plage d’origine ne sont pas modifiées.
removeDuplicates(columns, includesHeader)	Supprime les valeurs dupliquées de la plage spécifiée par les colonnes.
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.
select()	Sélectionne la plage spécifiée dans l’interface utilisateur d’Excel.
setColumnHidden(columnHidden)	Représente si toutes les colonnes de la plage actuelle sont masquées. La valeur est `true` lorsque toutes les colonnes d’une plage sont masquées. La valeur est quand aucune colonne de la plage n’est `false` masquée. La valeur est `null` lorsque certaines colonnes d’une plage sont masquées et que d’autres colonnes de la même plage ne sont pas masquées.
setDirty()	Cette méthode désigne une plage qui doit être recalculée lorsque le recalcul suivant se produit.
setFormula(formula)	Définit la formule de cellule en notation de style A1. Si la plage contient plusieurs cellules, chaque cellule de la plage donnée est mise à jour avec les données d’entrée.
setFormulaLocal(formulaLocal)	Définissez la formule de cellule en notation de style A1, dans la langue de l’utilisateur et les paramètres régionaux de mise en forme des nombres. Par exemple, la formule « =SUM(A1, 1.5) » en anglais deviendrait « =SUMME(A1; 1,5) » en allemand. Si la plage contient plusieurs cellules, chaque cellule de la plage donnée est mise à jour avec les données d’entrée.
setFormulaR1C1(formulaR1C1)	Définit la formule de cellule en notation de style R1C1. Si la plage contient plusieurs cellules, chaque cellule de la plage donnée est mise à jour avec les données d’entrée.
setFormulas(formulas)	Représente la formule dans le style de notation A1. Si une cellule n’a pas de formule, sa valeur est retournée à la place.
setFormulasLocal(formulasLocal)	Représente la formule en notation A1, en utilisant le langage et les paramètres de format de nombre régionaux de l’utilisateur. Par exemple, la formule « =SUM(A1, 1.5) » en anglais deviendrait « =SUMME(A1; 1,5) » en allemand. Si une cellule n’a pas de formule, sa valeur est retournée à la place.
setFormulasR1C1(formulasR1C1)	Représente la formule dans le style de notation R1C1. Si une cellule n’a pas de formule, sa valeur est retournée à la place.
setHyperlink(hyperlink)	Représente le lien hypertexte pour la plage actuelle.
setNumberFormat(numberFormat)	Définit le code de format numérique Excel de cellule pour la plage donnée. Si la plage contient plusieurs cellules, chaque cellule de la plage donnée est mise à jour avec les données d’entrée.
setNumberFormatLocal(numberFormatLocal)	Définit le code de format numérique Excel de cellule pour la plage donnée, en fonction des paramètres de langue de l’utilisateur. Excel n’effectue aucune contrainte de langage ou de mise en forme lors de l’obtention ou de la définition de la `numberFormatLocal` propriété. Tout texte retourné utilise les chaînes mises en forme localement en fonction de la langue spécifiée dans les paramètres système. Si la plage contient plusieurs cellules, chaque cellule de la plage donnée est mise à jour avec les données d’entrée.
setNumberFormats(numberFormats)	Représente le code de format numérique d’Excel pour la plage donnée.
setNumberFormatsLocal(numberFormatsLocal)	Représente le code de format numérique d’Excel pour la plage donnée, en fonction des paramètres de langue de l’utilisateur. Excel n’effectue aucune contrainte de langage ou de mise en forme lors de l’obtention ou de la définition de la `numberFormatLocal` propriété. Tout texte retourné utilise les chaînes mises en forme localement en fonction de la langue spécifiée dans les paramètres système.
setPredefinedCellStyle(predefinedCellStyle)	Représente le style de la plage actuelle.
setRowHidden(rowHidden)	Représente si toutes les lignes de la plage actuelle sont masquées. La valeur est `true` lorsque toutes les lignes d’une plage sont masquées. La valeur est quand aucune ligne de la plage n’est `false` masquée. La valeur est `null` lorsque certaines lignes d’une plage sont masquées et que d’autres lignes de la même plage ne sont pas masquées.
setValue(value)	Définit la valeur brute de la plage spécifiée. Les données en cours de définition peuvent être de type chaîne, nombre ou booléen. `null` la valeur sera ignorée (non définie ou remplacée dans Excel). Si la plage contient plusieurs cellules, chaque cellule de la plage donnée est mise à jour avec les données d’entrée.
setValues(values)	Définit les valeurs brutes de la plage spécifiée. Les données fournies peuvent être une chaîne, un nombre ou une valeur booléenne. Si la valeur fournie commence par un signe plus (« + »), moins (« - ») ou égal (« = »), Excel interprète cette valeur comme une formule.
showCard()	Affiche la carte pour une cellule active si son contenu est riche en valeur.
showGroupDetails(groupOption)	Affiche les détails du groupe de lignes ou de colonnes.
ungroup(groupOption)	Dissocie les colonnes et les lignes d’un plan.
unmerge()	Annule la fusion de la plage de cellules.

Détails de la méthode

addConditionalFormat(type)

Ajoute un nouveau format conditionnel à la collection à la première/première priorité.

addConditionalFormat(type: ConditionalFormatType): ConditionalFormat;

Paramètres

type: ExcelScript.ConditionalFormatType

Type de format conditionnel ajouté. Pour plus d’informations, consultez ExcelScript.ConditionalFormatType .

Retours

ExcelScript.ConditionalFormat

Exemples

/**
 * This sample applies conditional formatting to the currently used range in the worksheet. 
 * The conditional formatting is a green fill for the top 10% of values.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the used range in the worksheet.
  let range = selectedSheet.getUsedRange();

  // Set the fill color to green for the top 10% of values in the range.
  let conditionalFormat = range.addConditionalFormat(ExcelScript.ConditionalFormatType.topBottom)
  conditionalFormat.getTopBottom().getFormat().getFill().setColor("green");
  conditionalFormat.getTopBottom().setRule({
    rank: 10, // The percentage threshold.
    type: ExcelScript.ConditionalTopBottomCriterionType.topPercent // The type of the top/bottom condition.
  });
}

autoFill(destinationRange, autoFillType)

Remplit une plage de la plage actuelle à la plage de destination à l’aide de la logique de remplissage automatique spécifiée. La plage de destination peut être null ou étendre la plage source horizontalement ou verticalement. Les plages discontiguées ne sont pas prises en charge.

autoFill(
            destinationRange?: Range | string,
            autoFillType?: AutoFillType
        ): void;

Paramètres

destinationRange: ExcelScript.Range | string

Plage de destination du remplissage automatique. Si la plage de destination est null, les données sont remplies en fonction des cellules environnantes (qui est le comportement lorsque vous double-cliquez sur la poignée de remplissage de plage de l’interface utilisateur).

autoFillType: ExcelScript.AutoFillType

Type de remplissage automatique. Spécifie la façon dont la plage de destination doit être remplie, en fonction du contenu de la plage actuelle. La valeur par défaut est « FillDefault ».

Retours

void

Exemples

/**
 * This script uses the autofill feature to complete a table.
 * See https://support.microsoft.com/office/74e31bdd-d993-45da-aa82-35a236c5b5db
 * for examples of autofill scenarios.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current, active worksheet.
  let currentWorksheet = workbook.getActiveWorksheet();

  // Get the data range that shows the pattern.
  let dataRange = currentWorksheet.getRange("C2:C3");

  // Autofill the connected range. C2:C3 are filled in. C4:C14 are blank.
  // This uses the default behavior to match a pattern with the table's contents.
  dataRange.autoFill("C2:C14");
}

calculate()

Calcule une plage de cellules dans une feuille de calcul.

calculate(): void;

Retours

void

Exemples

/**
 * This script recalculates the used range of a specific worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Only recalculate if the calculation mode is not set to automatic.
  if (workbook.getApplication().getCalculationMode() !== ExcelScript.CalculationMode.automatic) {
    // Get the used range from a worksheet named "Monthly Report".
    const sheet = workbook.getWorksheet("Monthly Report");
    const range = sheet.getUsedRange();
    console.log(`Calculating ${range.getAddress()}`);

    // Force all the used cells in that worksheet to calculate.
    sheet.getUsedRange().calculate();
  }
}

clear(applyTo)

Supprime les valeurs et les propriétés de format, de remplissage, de bordure, etc. de la plage.

clear(applyTo?: ClearApplyTo): void;

Paramètres

applyTo: ExcelScript.ClearApplyTo

Optional. Détermine le type d’action de suppression. Pour plus d’informations, consultez ExcelScript.ClearApplyTo .

Retours

void

Exemples

/**
 * This script removes all the formatting from the selected range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the selected range.
  let range = workbook.getSelectedRange();

  // Clear all the formatting in that range.
  range.clear(ExcelScript.ClearApplyTo.formats);
}

clearAllConditionalFormats()

Efface toutes les mises en forme conditionnelles actives sur la plage spécifiée actuelle.

clearAllConditionalFormats(): void;

Retours

void

convertDataTypeToText()

Convertit les cellules de plage avec des types de données en texte.

convertDataTypeToText(): void;

Retours

void

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Copie les données de cellule ou la mise en forme de la plage source ou RangeAreas vers la plage actuelle. La plage de destination peut avoir une taille différente de celle de la plage source ou RangeAreas. La destination est développée automatiquement si elle est plus petite que la source. Remarque : Comme la fonctionnalité de copie dans l’interface utilisateur Excel, si la plage de destination est un multiple exact supérieur à la plage source dans les lignes ou les colonnes, le contenu source est répliqué plusieurs fois. Par exemple, une copie de plage 2x2 dans une plage 2x6 entraîne 3 copies de la plage 2x2 d’origine.

copyFrom(
            sourceRange: Range | RangeAreas | string,
            copyType?: RangeCopyType,
            skipBlanks?: boolean,
            transpose?: boolean
        ): void;

Paramètres

sourceRange: ExcelScript.Range | ExcelScript.RangeAreas | string

Plage source ou RangeAreas à partir de laquelle effectuer la copie. Lorsque la source RangeAreas a plusieurs plages, sa forme doit pouvoir être créée en supprimant des lignes ou des colonnes complètes d’une plage rectangulaire.

copyType: ExcelScript.RangeCopyType

Type de données de cellule ou de mise en forme à copier. La valeur par défaut est « All ».

skipBlanks: boolean

True si pour ignorer les cellules vides dans la plage source. La valeur par défaut est False.

transpose: boolean

True si pour transposer les cellules dans la plage de destination. La valeur par défaut est False.

Retours

void

Exemples

/**
 * This script copies a table from one worksheet to a new worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the worksheet named "TableTemplate".
  let base = workbook.getWorksheet("TableTemplate");
  
  // Get the range to be copied based on the first table.
  let tableRange = base.getTables()[0].getRange();

  // Get the area in a new worksheet for the new table.
  let newWorksheet = workbook.addWorksheet();
  let newRange = newWorksheet.getRangeByIndexes(0,0, tableRange.getRowCount(), tableRange.getColumnCount());

  // Copy the existing data into the new range.
  newRange.copyFrom(tableRange);
}

delete(shift)

Supprime les cellules associées à la plage.

delete(shift: DeleteShiftDirection): void;

Paramètres

shift: ExcelScript.DeleteShiftDirection

Indique la façon dont les cellules doivent être décalées. Pour plus d’informations, consultez ExcelScript.DeleteShiftDirection .

Retours

void

Exemples

/**
 * This sample creates a sample range, then deletes
 * "A1" using different DeleteShiftDirection values.
 */
function main(workbook: ExcelScript.Workbook) {
  // Add sample data to better visualize the delete changes.
  const currentSheet = workbook.getActiveWorksheet();
  currentSheet.getRange("A1:D4").setValues([
    [1,2,3,4],
    [5,6,7,8],
    [9,10,11,12],
    [13,14,15,16]]);

  // Delete A1 and shift the cells from the right to fill the space.
  // The value being deleted is 1.
  currentSheet.getRange("A1").delete(ExcelScript.DeleteShiftDirection.left);

  // Delete A1 and shift the cells from the bottom to fill the space.
  // The value being deleted is 2.
  currentSheet.getRange("A1").delete(ExcelScript.DeleteShiftDirection.up);

  // Log the sample range. The values should be:
  /*
    5, 3, 4, "",
    9, 6, 7, 8,
    13, 10, 11, 12,
    "", 14, 15, 16
  */
  console.log(currentSheet.getRange("A1:D4").getValues()); 
}

find(text, criteria)

Recherche la chaîne donnée basée sur les critères spécifiés. Si la plage actuelle est supérieure à une seule cellule, la recherche est limitée à cette plage, sinon la recherche couvre la feuille entière à partir de cette cellule. S’il n’existe aucune correspondance, cette méthode retourne undefined.

find(text: string, criteria: SearchCriteria): Range;

Paramètres

text: string

Chaîne à rechercher.

criteria: ExcelScript.SearchCriteria

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

Retours

ExcelScript.Range

Exemples

/**
 * This script searches through a table column and finds cells marked "no change". 
 * Those cells have "no change" replaced with the value from the cell to the left.
 * This script uses Range.find instead of Worksheet.findAll 
 * to limit the search to a specific range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range of a table named "Orders".
  let table = workbook.getTable("Orders");
  let range = table.getColumnByName("March").getRange();

  // Find all cells with the value "no change".
  let cellToOverwrite = range.find("no change", { completeMatch: true });
  while (cellToOverwrite) {
    let cellToCopyFrom = cellToOverwrite.getOffsetRange(0,-1);
    cellToOverwrite.setValue(cellToCopyFrom.getValue());
    cellToOverwrite = range.find("no change", { completeMatch: true });
  }
}

flashFill()

Effectue un remplissage instantané sur la plage actuelle. Le remplissage instantané remplit automatiquement les données lorsqu’il détecte un modèle. La plage doit donc être une seule plage de colonnes et contenir des données autour de celle-ci pour trouver un modèle.

flashFill(): void;

Retours

void

Exemples

/**
 * This script uses the Flash Fill feature to complete a table.
 * See https://support.microsoft.com/office/3f9bcf1e-db93-4890-94a0-1578341f73f7
 * for the example table.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current, active worksheet.
  let currentWorksheet = workbook.getActiveWorksheet();

  // Get the data range with a pattern and cells to fill. C2 is filled in. C3:C6 are blank.
  let dataRange = currentWorksheet.getRange("C2:C6");

  // Flash fill the connected range. 
  dataRange.flashFill();
}

getAbsoluteResizedRange(numRows, numColumns)

Obtient un Range objet avec la même cellule en haut à gauche que l’objet actuel Range , mais avec le nombre spécifié de lignes et de colonnes.

getAbsoluteResizedRange(numRows: number, numColumns: number): Range;

Paramètres

numRows: number

Nombre de lignes de la nouvelle taille de plage.

numColumns: number

Nombre de colonnes de la nouvelle taille de plage.

Retours

ExcelScript.Range

getAddress()

Spécifie la référence de plage dans le style A1. La valeur d’adresse contient la référence de la feuille (par exemple, « Sheet1 ! A1 :B4").

getAddress(): string;

Retours

string

Exemples

/**
 * This script logs the address of the used range in each worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Iterate over every worksheet in the workbook.
  workbook.getWorksheets().forEach((sheet) => {
    // Get the used range for a single worksheet.
    let range = sheet.getUsedRange();

    // Print the address of the used range to the console.
    console.log(range.getAddress());
  });
}

getAddressLocal()

Représente la référence de plage pour la plage spécifiée dans la langue de l’utilisateur.

getAddressLocal(): string;

Retours

string

getBoundingRect(anotherRange)

Renvoie le plus petit objet de plage qui englobe les plages données. Par exemple, « GetBoundingRect B2 :C5 » et « D10 :E15 » est « B2 :E15 ».

getBoundingRect(anotherRange: Range | string): Range;

Paramètres

anotherRange: ExcelScript.Range | string

L’objet, l’adresse ou le nom de la plage.

Retours

ExcelScript.Range

Exemples

/**
 * This script gets the bounding range of two existing ranges and puts a border around it.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the current worksheet.
  let sheet = workbook.getActiveWorksheet();

  // Create two range objects for the sample.
  let range1 = sheet.getRange("B2:C5");
  let range2 = sheet.getRange("D10:E15");

  // Get the rectangular range that fully includes both ranges.
  let boundingRectangle = range1.getBoundingRect(range2);

  // Add a border around the whole bounding range (B2:E15).
  let format = boundingRectangle.getFormat();
  format.getRangeBorder(ExcelScript.BorderIndex.edgeTop).setStyle(ExcelScript.BorderLineStyle.continuous); // Top border
  format.getRangeBorder(ExcelScript.BorderIndex.edgeBottom).setStyle(ExcelScript.BorderLineStyle.continuous); // Bottom border
  format.getRangeBorder(ExcelScript.BorderIndex.edgeLeft).setStyle(ExcelScript.BorderLineStyle.continuous); // Left border
  format.getRangeBorder(ExcelScript.BorderIndex.edgeRight).setStyle(ExcelScript.BorderLineStyle.continuous); // Right border
}

getCell(row, column)

Renvoie l’objet de plage qui contient une cellule donnée sur la base 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. L’emplacement de la cellule renvoyée est déterminé à partir de la cellule supérieure gauche de la plage.

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

getCellCount()

Spécifie le nombre de cellules dans la plage. Cette API renvoie -1 si le nombre de cellules est supérieur à 2^31-1 (2 147 483 647).

getCellCount(): number;

Retours

number

getColumn(column)

Obtient une colonne contenue dans la plage.

getColumn(column: number): Range;

Paramètres

column: number

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

Retours

ExcelScript.Range

getColumnCount()

Spécifie le nombre total de colonnes dans la plage.

getColumnCount(): number;

Retours

number

Exemples

/**
 * This sample provides the count of negative numbers that are present
 * in the used range of the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the working range.
  let usedRange = workbook.getActiveWorksheet().getUsedRange();
  let rowCount = usedRange.getRowCount();
  let columnCount = usedRange.getColumnCount();

  // Save the values locally to avoid repeatedly asking the workbook.
  let usedRangeValues = usedRange.getValues();

  // Start the negative number counter.
  let negativeCount = 0;

  // Iterate over the entire range looking for negative numbers.
  for (let i = 0; i < rowCount; i++) {
    for (let j = 0; j < columnCount; j++) {
      if (usedRangeValues[i][j] < 0) {
        negativeCount++;
      }
    }
  }

  // Log the negative number count to the console.
  console.log(negativeCount);
}

getColumnHidden()

Représente si toutes les colonnes de la plage actuelle sont masquées. La valeur est true lorsque toutes les colonnes d’une plage sont masquées. La valeur est quand aucune colonne de la plage n’est false masquée. La valeur est null lorsque certaines colonnes d’une plage sont masquées et que d’autres colonnes de la même plage ne sont pas masquées.

getColumnHidden(): boolean;

Retours

boolean

getColumnIndex()

Spécifie le numéro de colonne de la première cellule de la plage. Avec indice zéro.

getColumnIndex(): number;

Retours

number

getColumnsAfter(count)

Obtient un certain nombre de colonnes à droite de l’objet actuel Range .

getColumnsAfter(count?: number): Range;

Paramètres

count: number

Optional. Nombre de colonnes à inclure dans la plage obtenue. En règle générale, utilisez un nombre positif pour créer une plage en dehors de la plage actuelle. Vous pouvez également utiliser un nombre négatif pour créer une plage à l’intérieur de la plage actuelle. La valeur par défaut est 1.

Retours

ExcelScript.Range

getColumnsBefore(count)

Obtient un certain nombre de colonnes à gauche de l’objet actuel Range .

getColumnsBefore(count?: number): Range;

Paramètres

count: number

Retours

ExcelScript.Range

getConditionalFormat(id)

Retourne un format conditionnel identifié par son ID. Si l’objet de format conditionnel n’existe pas, cette méthode retourne undefined.

getConditionalFormat(id: string): ConditionalFormat | undefined;

Paramètres

id: string

ID du format conditionnel.

Retours

ExcelScript.ConditionalFormat | undefined

getConditionalFormats()

Collection de ConditionalFormats qui croise la plage.

getConditionalFormats(): ConditionalFormat[];

Retours

ExcelScript.ConditionalFormat[]

getDataValidation()

Renvoie un objet de validation des données.

getDataValidation(): DataValidation;

Retours

ExcelScript.DataValidation

Exemples

/**
 * This script creates a drop-down selection list for a cell. It uses the existing values of the selected range as the choices for the list.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the values for data validation.
  let selectedRange = workbook.getSelectedRange();
  let rangeValues = selectedRange.getValues();

  // Convert the values into a comma-delimited string.
  let dataValidationListString = "";
  rangeValues.forEach((rangeValueRow) => {
    rangeValueRow.forEach((value) => {
      dataValidationListString += value + ",";
    });
  });

  // Clear the old range.
  selectedRange.clear(ExcelScript.ClearApplyTo.contents);

  // Apply the data validation to the first cell in the selected range.
  let targetCell = selectedRange.getCell(0,0);
  let dataValidation = targetCell.getDataValidation();

  // Set the content of the drop-down list.
  dataValidation.setRule({
      list: {
        inCellDropDown: true,
        source: dataValidationListString
      }
    });
}

getDirectPrecedents()

Renvoie un WorkbookRangeAreas objet qui représente la plage contenant toutes les cellules de précédent direct d’une plage spécifiée dans la même feuille de calcul ou dans plusieurs feuilles de calcul.

getDirectPrecedents(): WorkbookRangeAreas;

Retours

ExcelScript.WorkbookRangeAreas

Exemples

/**
 * This script finds the direct precedents of the active cell.
 * It changes the font and color of those precedent cells. 
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active cell.
  const selected = workbook.getActiveCell();
  
  // Get the cells that are direct precedents of the current cell.
  const precedents : ExcelScript.WorkbookRangeAreas = selected.getDirectPrecedents();

  // Set the font to bold and the fill color to orange for all the precedent cells.
  precedents.getRanges().forEach(range => {
    range.getFormat().getFill().setColor("orange");
    range.getFormat().getFont().setBold(true);
  });
}

getEntireColumn()

Obtient un objet qui représente la colonne entière de la plage (par exemple, si la plage actuelle représente les cellules « B4 :E11 », il s’agit getEntireColumn d’une plage qui représente les colonnes « B :E »).

getEntireColumn(): Range;

Retours

ExcelScript.Range

getEntireRow()

Obtient un objet qui représente la ligne entière de la plage (par exemple, si la plage actuelle représente les cellules « B4 :E11 », il s’agit GetEntireRow d’une plage qui représente les lignes « 4:11 »).

getEntireRow(): Range;

Retours

ExcelScript.Range

getExtendedRange(direction, activeCell)

Retourne un objet de plage qui inclut la plage actuelle et jusqu’au bord de la plage, en fonction de la direction fournie. Cela correspond au comportement Ctrl+Maj+Touche de direction dans l’interface utilisateur Excel sur Windows.

getExtendedRange(
            direction: KeyboardDirection,
            activeCell?: Range | string
        ): Range;

Paramètres

direction: ExcelScript.KeyboardDirection

Direction à partir de la cellule active.

activeCell: ExcelScript.Range | string

Cellule active de cette plage. Par défaut, la cellule active est la cellule supérieure gauche de la plage. Une erreur est générée si la cellule active ne se trouve pas dans cette plage.

Retours

ExcelScript.Range

Exemples

/**
 * This script makes the font bold on all the contiguous cells between 
 * A1 and the bottom of the used range of the first column.
 */
function main(workbook: ExcelScript.Workbook)
{
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get every cell that's used between A1 and the end of the column.
  // This recreates the Ctrl+Shift+Down arrow key behavior.
  let firstCell = selectedSheet.getRange("A1");
  let firstColumn = firstCell.getExtendedRange(ExcelScript.KeyboardDirection.down);

  // Set the font to bold in that range.
  firstColumn.getFormat().getFont().setBold(true);
}

getFormat()

Renvoie un objet de format, encapsulant la police, le remplissage, les bordures, l’alignement et d’autres propriétés de la plage.

getFormat(): RangeFormat;

Retours

ExcelScript.RangeFormat

Exemples

/**
 * This script gives the total row of a table a green color fill.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table in the workbook.
  let table = workbook.getTables()[0];

  // Get the range for the total row of the table.
  let totalRange = table.getTotalRowRange();

  // Set the fill color to green.
  totalRange.getFormat().getFill().setColor("green");
}

getFormula()

Représente la formule de cellule en notation de style A1. Si la plage contient plusieurs cellules, les données de la première cellule (représentées par l’index de ligne de 0 et l’index de colonne de 0) sont retournées.

getFormula(): string;

Retours

string

Exemples

/*
 * This script sets a cell's formula, 
 * then displays how Excel stores the cell's formula and value separately.
 */
function main(workbook: ExcelScript.Workbook) {
  let selectedSheet = workbook.getActiveWorksheet();

  // Set A1 to 2.
  let a1 = selectedSheet.getRange("A1");
  a1.setValue(2);

  // Set B1 to the formula =(2*A1), which should equal 4.
  let b1 = selectedSheet.getRange("B1")
  b1.setFormula("=(2*A1)");

  // Log the current results for `getFormula` and `getValue` at B1.
  console.log(`B1 - Formula: ${b1.getFormula()} | Value: ${b1.getValue()}`);
}

getFormulaLocal()

Représente la formule de cellule en notation de style A1, dans la langue de l’utilisateur et les paramètres régionaux de mise en forme des nombres. Par exemple, la formule « =SUM(A1, 1.5) » en anglais deviendrait « =SUMME(A1; 1,5) » en allemand. Si la plage contient plusieurs cellules, les données de la première cellule (représentées par l’index de ligne de 0 et l’index de colonne de 0) sont retournées.

getFormulaLocal(): string;

Retours

string

getFormulaR1C1()

Représente la formule de cellule en notation de style R1C1. Si la plage contient plusieurs cellules, les données de la première cellule (représentées par l’index de ligne de 0 et l’index de colonne de 0) sont retournées.

getFormulaR1C1(): string;

Retours

string

getFormulas()

Représente la formule dans le style de notation A1. Si une cellule n’a pas de formule, sa valeur est retournée à la place.

getFormulas(): string[][];

Retours

string[][]

getFormulasLocal()

Représente la formule en notation A1, en utilisant le langage et les paramètres de format de nombre régionaux de l’utilisateur. Par exemple, la formule « =SUM(A1, 1.5) » en anglais deviendrait « =SUMME(A1; 1,5) » en allemand. Si une cellule n’a pas de formule, sa valeur est retournée à la place.

getFormulasLocal(): string[][];

Retours

string[][]

getFormulasR1C1()

Représente la formule dans le style de notation R1C1. Si une cellule n’a pas de formule, sa valeur est retournée à la place.

getFormulasR1C1(): string[][];

Retours

string[][]

getHasSpill()

Représente si toutes les cellules ont une bordure renversée. Renvoie true si toutes les cellules ont une bordure de déversement, ou false si toutes les cellules n’ont pas de bordure de déversement. Retourne null s’il existe des cellules avec et sans bordures de déversement dans la plage.

getHasSpill(): boolean;

Retours

boolean

getHeight()

Retourne la distance en points, pour un zoom à 100 %, entre le bord supérieur de la plage et le bord inférieur de la plage.

getHeight(): number;

Retours

number

getHidden()

Représente si toutes les cellules de la plage actuelle sont masquées. La valeur est true lorsque toutes les cellules d’une plage sont masquées. La valeur est quand aucune cellule de la plage n’est false masquée. La valeur est null lorsque certaines cellules d’une plage sont masquées et que d’autres cellules de la même plage ne sont pas masquées.

getHidden(): boolean;

Retours

boolean

getHyperlink()

Représente le lien hypertexte pour la plage actuelle.

getHyperlink(): RangeHyperlink;

Retours

ExcelScript.RangeHyperlink

Exemples

/**
 * This sample clears all of the hyperlinks from the current worksheet
 * and removes the usual hyperlink formatting.
 */
function main(workbook: ExcelScript.Workbook, sheetName: string = 'Sheet1') {
  // Get the active worksheet. 
  let sheet = workbook.getWorksheet(sheetName);

  // Get the used range to operate on.
  // For large ranges (over 10000 entries), consider splitting the operation into batches for performance.
  const targetRange = sheet.getUsedRange(true);
  console.log(`Target Range to clear hyperlinks from: ${targetRange.getAddress()}`);

  const rowCount = targetRange.getRowCount();
  const colCount = targetRange.getColumnCount();
  console.log(`Searching for hyperlinks in ${targetRange.getAddress()} which contains ${(rowCount * colCount)} cells`);

  // Go through each individual cell looking for a hyperlink. 
  // This allows us to limit the formatting changes to only the cells with hyperlink formatting.
  let clearedCount = 0;
  for (let i = 0; i < rowCount; i++) {
    for (let j = 0; j < colCount; j++) {
      const cell = targetRange.getCell(i, j);
      const hyperlink = cell.getHyperlink();
      if (hyperlink) {
        cell.clear(ExcelScript.ClearApplyTo.hyperlinks);
        cell.getFormat().getFont().setUnderline(ExcelScript.RangeUnderlineStyle.none);
        cell.getFormat().getFont().setColor('Black');
        clearedCount++;
      }
    }
  }

  console.log(`Done. Cleared hyperlinks from ${clearedCount} cells`);
}

getImage()

Restitue la plage sous la forme d’une image png codée en base64.

getImage(): string;

Retours

string

getIntersection(anotherRange)

Obtient l’objet de plage qui représente l’intersection rectangulaire des plages données. Si aucune intersection n’est trouvée, cette méthode retourne undefined.

getIntersection(anotherRange: Range | string): Range;

Paramètres

anotherRange: ExcelScript.Range | string

Objet de plage ou adresse de plage utilisé pour déterminer l’intersection des plages.

Retours

ExcelScript.Range

getIsEntireColumn()

Représente si la plage active est une colonne entière.

getIsEntireColumn(): boolean;

Retours

boolean

getIsEntireRow()

Représente si la plage active est une ligne entière.

getIsEntireRow(): boolean;

Retours

boolean

getLastCell()

Obtient la dernière cellule de la plage. Par exemple, la dernière cellule de la plage « B2:D5 » est « D5 ».

getLastCell(): Range;

Retours

ExcelScript.Range

getLastColumn()

Obtient la dernière colonne de la plage. Par exemple, la dernière colonne de la plage « B2:D5 » est « D2:D5 ».

getLastColumn(): Range;

Retours

ExcelScript.Range

getLastRow()

Obtient la dernière ligne de la plage. Par exemple, la dernière ligne de la plage « B2:D5 » est « B5:D5 ».

getLastRow(): Range;

Retours

ExcelScript.Range

getLeft()

Retourne la distance en points, pour un zoom à 100 %, entre le bord gauche de la feuille de calcul et le bord gauche de la plage.

getLeft(): number;

Retours

number

getLinkedDataTypeState()

Représente l’état du type de données de la cellule.

getLinkedDataTypeState(): LinkedDataTypeState;

Retours

ExcelScript.LinkedDataTypeState

getLinkedDataTypeStates()

Représente l’état du type de données de chaque cellule.

getLinkedDataTypeStates(): LinkedDataTypeState[][];

Retours

ExcelScript.LinkedDataTypeState[][]

getMergedAreas()

Renvoie un RangeAreas objet qui représente les zones fusionnées dans cette plage. Notez que si le nombre de zones fusionnées dans cette plage est supérieur à 512, cette méthode ne retourne pas le résultat. Si l’objet RangeAreas n’existe pas, cette fonction retourne undefined.

getMergedAreas(): RangeAreas;

Retours

ExcelScript.RangeAreas

getNumberFormat()

Représente le code de format numérique Excel de cellule pour la plage donnée. Si la plage contient plusieurs cellules, les données de la première cellule (représentées par l’index de ligne de 0 et l’index de colonne de 0) sont retournées.

getNumberFormat(): string;

Retours

string

getNumberFormatCategories()

Représente la catégorie de format numérique de chaque cellule.

getNumberFormatCategories(): NumberFormatCategory[][];

Retours

ExcelScript.NumberFormatCategory[][]

Exemples

/**
 * This script finds cells in a table column that are not formatted as currency
 * and sets the fill color to red.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the "Cost" column from the "Expenses" table.
  const table = workbook.getTable("Expenses");
  const costColumn = table.getColumnByName("Cost");
  const costColumnRange = costColumn.getRangeBetweenHeaderAndTotal();

  // Get the number format categories for the column's range.
  const numberFormatCategories = costColumnRange.getNumberFormatCategories();

  // If any cell in the column doesn't have a currency format, make the cell red.
  numberFormatCategories.forEach((category, index) =>{
    if (category[0] != ExcelScript.NumberFormatCategory.currency) {
      costColumnRange.getCell(index, 0).getFormat().getFill().setColor("red");
    }
  }); 
}

getNumberFormatCategory()

Spécifie la catégorie de format numérique de la première cellule de la plage (représentée par l’index de ligne de 0 et l’index de colonne de 0).

getNumberFormatCategory(): NumberFormatCategory;

Retours

ExcelScript.NumberFormatCategory

getNumberFormatLocal()

Représente le code de format numérique Excel de la cellule pour la plage donnée, en fonction des paramètres de langue de l’utilisateur. Excel n’effectue aucune contrainte de langage ou de mise en forme lors de l’obtention ou de la définition de la numberFormatLocal propriété. Tout texte retourné utilise les chaînes mises en forme localement en fonction de la langue spécifiée dans les paramètres système. Si la plage contient plusieurs cellules, les données de la première cellule (représentées par l’index de ligne de 0 et l’index de colonne de 0) sont retournées.

getNumberFormatLocal(): string;

Retours

string

getNumberFormats()

Représente le code de format numérique d’Excel pour la plage donnée.

getNumberFormats(): string[][];

Retours

string[][]

getNumberFormatsLocal()

Représente le code de format numérique d’Excel pour la plage donnée, en fonction des paramètres de langue de l’utilisateur. Excel n’effectue aucune contrainte de langage ou de mise en forme lors de l’obtention ou de la définition de la numberFormatLocal propriété. Tout texte retourné utilise les chaînes mises en forme localement en fonction de la langue spécifiée dans les paramètres système.

getNumberFormatsLocal(): string[][];

Retours

string[][]

getOffsetRange(rowOffset, columnOffset)

Obtient un objet qui représente une plage décalée par rapport à la plage spécifiée. Les dimensions de la plage renvoyée correspondent à cette plage. Si la plage obtenue se retrouve en dehors des limites de grille de la feuille de calcul, une erreur est déclenchée.

getOffsetRange(rowOffset: number, columnOffset: number): Range;

Paramètres

rowOffset: number

Nombre de lignes (positif, négatif ou nul) duquel décaler la plage. Les valeurs positives représentent un décalage vers le bas, et les valeurs négatives un décalage vers le haut.

columnOffset: number

Nombre de colonnes (positif, négatif ou nul) duquel décaler la plage. Les valeurs positives représentent un décalage vers la droite, et les valeurs négatives un décalage vers la gauche.

Retours

ExcelScript.Range

Exemples

/**
 * This script gets adjacent cells using relative references.
 * Note that if the active cell is on the top row, part of the script fails, 
 * because it references the cell above the currently selected one.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the currently active cell in the workbook.
  let activeCell = workbook.getActiveCell();
  console.log(`The active cell's address is: ${activeCell.getAddress()}`);

  // Get the cell to the right of the active cell and set its value and color.
  let rightCell = activeCell.getOffsetRange(0,1);
  rightCell.setValue("Right cell");
  console.log(`The right cell's address is: ${rightCell.getAddress()}`);
  rightCell.getFormat().getFont().setColor("Magenta");
  rightCell.getFormat().getFill().setColor("Cyan");

  // Get the cell to the above of the active cell and set its value and color.
  // Note that this operation will fail if the active cell is in the top row.
  let aboveCell = activeCell.getOffsetRange(-1, 0);
  aboveCell.setValue("Above cell");
  console.log(`The above cell's address is: ${aboveCell.getAddress()}`);
  aboveCell.getFormat().getFont().setColor("White");
  aboveCell.getFormat().getFill().setColor("Black");
}

getPivotTables(fullyContained)

Obtient une collection délimitée de tableaux croisés dynamiques qui chevauchent la plage.

getPivotTables(fullyContained?: boolean): PivotTable[];

Paramètres

fullyContained: boolean

Si truela valeur est , retourne uniquement les tableaux croisés dynamiques qui sont entièrement contenus dans les limites de plage. La valeur par défaut est false.

Retours

ExcelScript.PivotTable[]

getPredefinedCellStyle()

Représente le style de la plage actuelle. Si les styles des cellules sont incohérents, null est retourné. Pour les styles personnalisés, le nom du style est retourné. Pour les styles intégrés, une chaîne représentant une valeur dans l’énumération BuiltInStyle est retournée.

getPredefinedCellStyle(): string;

Retours

string

getRangeEdge(direction, activeCell)

Retourne un objet de plage qui est la cellule de bord de la région de données qui correspond à la direction fournie. Cela correspond au comportement ctrl+touche de direction dans l’interface utilisateur d’Excel sur Windows.

getRangeEdge(
            direction: KeyboardDirection,
            activeCell?: Range | string
        ): Range;

Paramètres

direction: ExcelScript.KeyboardDirection

Direction à partir de la cellule active.

activeCell: ExcelScript.Range | string

Cellule active de cette plage. Par défaut, la cellule active est la cellule supérieure gauche de la plage. Une erreur est générée si la cellule active ne se trouve pas dans cette plage.

Retours

ExcelScript.Range

Exemples

/**
 * This script adds the value "Total" after the end of the first column.
 */
function main(workbook: ExcelScript.Workbook)
{
  // Get the current worksheet.
  let selectedSheet = workbook.getActiveWorksheet();

  // Get the last used cell at the end of the column.
  // This recreates the Ctrl+Down arrow key behavior.
  let firstCell = selectedSheet.getRange("A1");
  let firstColumn = selectedSheet.getRange("A1").getRangeEdge(ExcelScript.KeyboardDirection.down);
  let cellAfter = firstColumn.getOffsetRange(1, 0);

  // Set the value of the cell after the current end of the used column to "Total".
  cellAfter.setValue("Total");
}

getResizedRange(deltaRows, deltaColumns)

Obtient un Range objet similaire à l’objet actuel Range , mais avec son coin inférieur droit développé (ou contracté) par un certain nombre de lignes et de colonnes.

getResizedRange(deltaRows: number, deltaColumns: number): Range;

Paramètres

deltaRows: number

Nombre de lignes par lequel développer le coin inférieur droit, par rapport à la plage actuelle. Utilisez un nombre positif pour étendre la plage ou un nombre négatif pour la réduire.

deltaColumns: number

Nombre de colonnes par lesquelles développer le coin inférieur droit, par rapport à la plage actuelle. Utilisez un nombre positif pour étendre la plage ou un nombre négatif pour la réduire.

Retours

ExcelScript.Range

Exemples

/**
 * This script copies the formatting in the active cell to the neighboring cells.
 * Note that this script only works when the active cell isn't on an edge of the worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active cell.
  let activeCell = workbook.getActiveCell();

  // Get the cell that's one row above and one column to the left of the active cell.
  let cornerCell = activeCell.getOffsetRange(-1,-1);

  // Get a range that includes all the cells surrounding the active cell.
  let surroundingRange = cornerCell.getResizedRange(2, 2)

  // Copy the formatting from the active cell to the new range.
  surroundingRange.copyFrom(
    activeCell, /* The source range. */
    ExcelScript.RangeCopyType.formats /* What to copy. */
  );
}

getRow(row)

Obtient une ligne contenue dans la plage.

getRow(row: number): Range;

Paramètres

row: number

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

Retours

ExcelScript.Range

getRowCount()

Renvoie le nombre total de lignes de la plage.

getRowCount(): number;

Retours

number

Exemples

/**
 * This sample provides the count of negative numbers that are present
 * in the used range of the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the working range.
  let usedRange = workbook.getActiveWorksheet().getUsedRange();
  let rowCount = usedRange.getRowCount();
  let columnCount = usedRange.getColumnCount();

  // Save the values locally to avoid repeatedly asking the workbook.
  let usedRangeValues = usedRange.getValues();

  // Start the negative number counter.
  let negativeCount = 0;

  // Iterate over the entire range looking for negative numbers.
  for (let i = 0; i < rowCount; i++) {
    for (let j = 0; j < columnCount; j++) {
      if (usedRangeValues[i][j] < 0) {
        negativeCount++;
      }
    }
  }

  // Log the negative number count to the console.
  console.log(negativeCount);
}

getRowHidden()

Représente si toutes les lignes de la plage actuelle sont masquées. La valeur est true lorsque toutes les lignes d’une plage sont masquées. La valeur est quand aucune ligne de la plage n’est false masquée. La valeur est null lorsque certaines lignes d’une plage sont masquées et que d’autres lignes de la même plage ne sont pas masquées.

getRowHidden(): boolean;

Retours

boolean

getRowIndex()

Renvoie le numéro de ligne de la première cellule de la plage. Avec indice zéro.

getRowIndex(): number;

Retours

number

getRowsAbove(count)

Obtient un certain nombre de lignes au-dessus de l’objet actuel Range .

getRowsAbove(count?: number): Range;

Paramètres

count: number

Optional. Nombre de lignes à inclure dans la plage obtenue. En règle générale, utilisez un nombre positif pour créer une plage en dehors de la plage actuelle. Vous pouvez également utiliser un nombre négatif pour créer une plage à l’intérieur de la plage actuelle. La valeur par défaut est 1.

Retours

ExcelScript.Range

getRowsBelow(count)

Obtient un certain nombre de lignes sous l’objet actuel Range .

getRowsBelow(count?: number): Range;

Paramètres

count: number

Retours

ExcelScript.Range

getSavedAsArray()

Représente si toutes les cellules doivent être enregistrées sous forme de formule matricielle. Retourne true si toutes les cellules sont enregistrées en tant que formule matricielle, ou false si toutes les cellules ne sont pas enregistrées en tant que formule matricielle. Renvoie null si certaines cellules sont enregistrées en tant que formule matricielle et que d’autres ne le sont pas.

getSavedAsArray(): boolean;

Retours

boolean

getSort()

Représente le tri de plage de la plage actuelle.

getSort(): RangeSort;

Retours

ExcelScript.RangeSort

getSpecialCells(cellType, cellValueType)

Obtient l’objet RangeAreas , comprenant une ou plusieurs plages, qui représente toutes les cellules qui correspondent au type et à la valeur spécifiés. Si aucune cellule spéciale n’est trouvée, cette méthode retourne undefined.

getSpecialCells(
            cellType: SpecialCellType,
            cellValueType?: SpecialCellValueType
        ): RangeAreas;

Paramètres

cellType: ExcelScript.SpecialCellType

Type de cellules à inclure.

cellValueType: ExcelScript.SpecialCellValueType

Si cellType est constants ou formulas, cet argument est utilisé pour déterminer les types de cellules à inclure dans le résultat. Ces valeurs peuvent être combinées pour retourner plusieurs types. Par défaut, toutes les constantes ou formules sont sélectionnées, quel qu'en soit le type.

Retours

ExcelScript.RangeAreas

Exemples

/**
 * This sample gets all the blank cells in the current worksheet's used range. It then highlights all those cells with a yellow background.
 */
function main(workbook: ExcelScript.Workbook) {
    // Get the current used range.
    let range = workbook.getActiveWorksheet().getUsedRange();
    
    // Get all the blank cells.
    let blankCells = range.getSpecialCells(ExcelScript.SpecialCellType.blanks);
    // Highlight the blank cells with a yellow background.
    blankCells.getFormat().getFill().setColor("yellow");
}

getSpillingToRange()

Obtient l’objet de la plage contenant la plage renversé lorsque appelée sur une cellule d’ancrage. Si la plage n’est pas une cellule d’ancrage ou si la plage de déversement est introuvable, cette méthode retourne undefined.

getSpillingToRange(): Range;

Retours

ExcelScript.Range

getSpillParent()

Obtient l’objet de plage contenant la cellule d’ancrage pour la cellule qui est renversée. S’il ne s’agit pas d’une cellule renversée ou si plusieurs cellules sont fournies, cette méthode retourne undefined.

getSpillParent(): Range;

Retours

ExcelScript.Range

getSurroundingRegion()

Renvoie un Range objet qui représente la région environnante pour la cellule en haut à gauche de cette plage. Une région environnante est une plage délimitée par une combinaison de lignes et de colonnes vides par rapport à cette plage.

getSurroundingRegion(): Range;

Retours

ExcelScript.Range

getTables(fullyContained)

Obtient une collection de tableaux qui se chevauchent avec la plage dans l’étendue.

getTables(fullyContained?: boolean): Table[];

Paramètres

fullyContained: boolean

Si truela valeur est , retourne uniquement les tables qui sont entièrement contenues dans les limites de plage. La valeur par défaut est false.

Retours

ExcelScript.Table[]

getText()

Représente la valeur Text de la plage spécifiée. La valeur de texte ne dépend pas de la largeur de la cellule. Le remplacement par le signe # qui se produit dans l’interface utilisateur d’Excel n’a aucun effet sur la valeur de texte renvoyée par l’API. Si la plage contient plusieurs cellules, les données de la première cellule (représentées par l’index de ligne de 0 et l’index de colonne de 0) sont retournées.

getText(): string;

Retours

string

getTexts()

Valeurs de texte de la plage spécifiée. La valeur de texte ne dépend pas de la largeur de la cellule. La substitution de signe numérique (#) qui se produit dans l’interface utilisateur Excel n’affecte pas la valeur de texte retournée par l’API.

getTexts(): string[][];

Retours

string[][]

getTop()

Retourne la distance en points, pour un zoom à 100 %, entre le bord supérieur de la feuille de calcul et le bord supérieur de la plage.

getTop(): number;

Retours

number

getUsedRange(valuesOnly)

Renvoie la plage utilisée d’un objet de plage donné. Si aucune cellule n’est utilisée dans la plage, cette méthode retourne undefined.

getUsedRange(valuesOnly?: boolean): Range;

Paramètres

valuesOnly: boolean

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

Retours

ExcelScript.Range

getValue()

Représente la valeur brute de la plage spécifiée. Les données renvoyées peuvent être des chaînes, des valeurs numériques ou des valeurs booléennes. Une cellule contenant une erreur renvoie la chaîne d’erreur. Si la plage contient plusieurs cellules, les données de la première cellule (représentées par l’index de ligne de 0 et l’index de colonne de 0) sont retournées.

getValue(): string | number | boolean;

Retours

string | number | boolean

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

getValues()

Représente les valeurs brutes de la plage spécifiée. Les données retournées peuvent être une chaîne, un nombre ou une valeur booléenne. Les cellules contenant une erreur renvoie la chaîne d’erreur. Si la valeur retournée commence par un signe plus (« + »), moins (« - ») ou égal (« = »), Excel interprète cette valeur comme une formule.

getValues(): (string | number | boolean)[][];

Retours

(string | number | boolean)[][]

getValueType()

Représente le type de données dans la cellule. Si la plage contient plusieurs cellules, les données de la première cellule (représentées par l’index de ligne de 0 et l’index de colonne de 0) sont retournées.

getValueType(): RangeValueType;

Retours

ExcelScript.RangeValueType

Exemples

/**
 * This script formats rows in a worksheet based on the first value in that row. 
 * If it's the boolean value TRUE, the row is bolded. 
 * If it's FALSE, nothing is changed. 
 * If the value type isn't a boolean, the row is italicized.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the used range in the active worksheet.
  const sheet = workbook.getActiveWorksheet();
  const usedRange = sheet.getUsedRange();

  // Get the values in the first column.
  const firstColumnValues = usedRange.getColumn(0).getValues();

  // Look at the first cell in each row.
  const rowCount = usedRange.getRowCount();
  for (let i = 0; i < rowCount; i++) {
    // Get the type of the first cell to make sure it's a boolean.
    let firstValueType = usedRange.getCell(i, 0).getValueType();

    // Set the bold or italic of the row as described earlier.
    if (firstValueType === ExcelScript.RangeValueType.boolean) {
      if (firstColumnValues[i][0] as boolean === true) {
        usedRange.getRow(i).getFormat().getFont().setBold(true);
      } else {
        usedRange.getRow(i).getFormat().getFont().setBold(false);
      }
    } else {
      usedRange.getRow(i).getFormat().getFont().setItalic(true);
    }
  }
}

getValueTypes()

Spécifie le type de données dans chaque cellule.

getValueTypes(): RangeValueType[][];

Retours

ExcelScript.RangeValueType[][]

getVisibleView()

Représente les lignes visibles de la plage en cours.

getVisibleView(): RangeView;

Retours

ExcelScript.RangeView

Exemples

/**
 * This script copies values and formatting from the 
 * visible range of a table in Sheet1 into Sheet2.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the filtered data from Sheet1.
  const currentSheet = workbook.getWorksheet("Sheet1");
  const table = currentSheet.getTables()[0];
  const visibleTableRange: ExcelScript.RangeView = table.getRange().getVisibleView();
  const source = currentSheet.getRanges(visibleTableRange.getCellAddresses().toString());

  // Copy the data into the other sheet.
  const otherSheet = workbook.getWorksheet("Sheet2");
  const otherRangeCorner = otherSheet.getRange("A1");
  otherRangeCorner.copyFrom(source, ExcelScript.RangeCopyType.all);
}

getWidth()

Retourne la distance en points, pour un zoom de 100 %, entre le bord gauche de la plage et le bord droit de la plage.

getWidth(): number;

Retours

number

getWorksheet()

Feuille de calcul contenant la plage.

getWorksheet(): Worksheet;

Retours

ExcelScript.Worksheet

group(groupOption)

Groupes colonnes et lignes d’un plan.

group(groupOption: GroupOption): void;

Paramètres

groupOption: ExcelScript.GroupOption

Spécifie comment la plage peut être regroupée par lignes ou colonnes. Une InvalidArgument erreur est générée lorsque l’option de groupe diffère de la propriété ou de isEntireColumnisEntireRow la plage (c’est-à-dire que range.isEntireRow a la valeur true et groupOption est « ByColumns » ou range.isEntireColumn est true et groupOption « ByRows »).

Retours

void

Exemples

/**
 * This script creates a two-level column-based outline on Sheet1.
 */
function main(workbook: ExcelScript.Workbook) {
  // Group columns A-F in the worksheet named Sheet1.
  const sheet = workbook.getWorksheet("Sheet1");
  const firstLevel = sheet.getRange("A:F");
  firstLevel.group(ExcelScript.GroupOption.byColumns);
  
  // Create a second level to the outline by grouping subsections.
  sheet.getRange("A:B").group(ExcelScript.GroupOption.byColumns);
  sheet.getRange("D:E").group(ExcelScript.GroupOption.byColumns);
}

hideGroupDetails(groupOption)

Masque les détails du groupe de lignes ou de colonnes.

hideGroupDetails(groupOption: GroupOption): void;

Paramètres

groupOption: ExcelScript.GroupOption

Spécifie s’il faut masquer les détails des lignes groupées ou des colonnes groupées.

Retours

void

insert(shift)

Insère une cellule ou une plage de cellules dans la feuille de calcul à la place d’une plage donnée et décale les autres cellules pour libérer de l’espace. Retourne un nouvel Range objet à l’espace maintenant vide.

insert(shift: InsertShiftDirection): Range;

Paramètres

shift: ExcelScript.InsertShiftDirection

Indique la façon dont les cellules doivent être décalées. Pour plus d’informations, consultez ExcelScript.InsertShiftDirection .

Retours

ExcelScript.Range

Exemples

/**
 * This script inserts headers at the top of the worksheet.
 */
function main(workbook: ExcelScript.Workbook)
{
  let currentSheet = workbook.getActiveWorksheet();

  // Create headers for 3 columns.
  let myHeaders = [["NAME", "ID", "ROLE"]];

  // Add a blank first row and push existing data down a row.
  let firstRow = currentSheet.getRange("1:1");
  firstRow.insert(ExcelScript.InsertShiftDirection.down);

  // Add the headers.
  currentSheet.getRange("A1:C1").setValues(myHeaders);
}

merge(across)

Fusionne la plage de cellules dans une zone de la feuille de calcul.

merge(across?: boolean): void;

Paramètres

across: boolean

Optional. Définissez true pour fusionner les cellules de chaque ligne de la plage spécifiée en tant que cellules fusionnées distinctes. La valeur par défaut est false.

Retours

void

Exemples

/**
 * This script merges a group of cells into a single region.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active worksheet.
  const selectedSheet = workbook.getActiveWorksheet();

  // Merge cells A1 through A4.
  const range = selectedSheet.getRange("A1:A4");
  range.merge();
}

moveTo(destinationRange)

Déplace les valeurs de cellule, la mise en forme et les formules de la plage actuelle vers la plage de destination, en remplaçant les anciennes informations dans ces cellules. La plage de destination est développée automatiquement si elle est plus petite que la plage actuelle. Les cellules de la plage de destination qui se trouvent en dehors de la zone de la plage d’origine ne sont pas modifiées.

moveTo(destinationRange: Range | string): void;

Paramètres

destinationRange: ExcelScript.Range | string

destinationRange Spécifie la plage vers laquelle les informations de cette plage seront déplacées.

Retours

void

removeDuplicates(columns, includesHeader)

Supprime les valeurs dupliquées de la plage spécifiée par les colonnes.

removeDuplicates(
            columns: number[],
            includesHeader: boolean
        ): RemoveDuplicatesResult;

Paramètres

columns: number[]

Colonnes à l’intérieur de la plage qui peuvent contenir des doublons. Au moins une colonne doit être spécifiée. Avec indice zéro.

includesHeader: boolean

True si les données d’entrée contiennent un en-tête. La valeur par défaut est False.

Retours

ExcelScript.RemoveDuplicatesResult

Exemples

/**
 * This script removes duplicate rows from a range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the used range of the active worksheet.
  const usedRange = workbook.getActiveWorksheet().getUsedRange();

  // Remove any row that has a same value in the 0-indexed column as a previous row.
  const removedResults = usedRange.removeDuplicates([0], true);

  // Log the count of removed rows.
  console.log(`Rows removed: ${removedResults.getRemoved()}.`);
}

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

Exemples

/**
 * This script searches through a table column and replaces  
 * cells marked "monthly special" with "parsnip".
 * This script uses Range.replaceAll instead of Worksheet.replaceAll
 * to limit the search to a specific range.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the range of a table named "Orders".
  let table = workbook.getTable("Orders");
  let range = table.getColumnByName("Vegetable").getRange();
  
  // Change the value of any cells with the value "monthly special".
  range.replaceAll("monthly special", "parsnip", {completeMatch: true});
}

select()

Sélectionne la plage spécifiée dans l’interface utilisateur d’Excel.

select(): void;

Retours

void

Exemples

/**
 * This script selects the first row of a table.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the first table on the current worksheet.
  const sheet = workbook.getActiveWorksheet()
  const table = sheet.getTables()[0];

  // Get the first data row in the table.
  const row = table.getRangeBetweenHeaderAndTotal().getRow(0);

  // Select the first data row.
  row.select();
}

setColumnHidden(columnHidden)

setColumnHidden(columnHidden: boolean): void;

Paramètres

columnHidden: boolean

Retours

void

setDirty()

Cette méthode désigne une plage qui doit être recalculée lorsque le recalcul suivant se produit.

setDirty(): void;

Retours

void

setFormula(formula)

Définit la formule de cellule en notation de style A1. Si la plage contient plusieurs cellules, chaque cellule de la plage donnée est mise à jour avec les données d’entrée.

setFormula(formula: string): void;

Paramètres

formula: string

Retours

void

Exemples

/*
 * This script sets a cell's formula, 
 * then displays how Excel stores the cell's formula and value separately.
 */
function main(workbook: ExcelScript.Workbook) {
  let selectedSheet = workbook.getActiveWorksheet();

  // Set A1 to 2.
  let a1 = selectedSheet.getRange("A1");
  a1.setValue(2);

  // Set B1 to the formula =(2*A1), which should equal 4.
  let b1 = selectedSheet.getRange("B1")
  b1.setFormula("=(2*A1)");

  // Log the current results for `getFormula` and `getValue` at B1.
  console.log(`B1 - Formula: ${b1.getFormula()} | Value: ${b1.getValue()}`);
}

setFormulaLocal(formulaLocal)

Définissez la formule de cellule en notation de style A1, dans la langue de l’utilisateur et les paramètres régionaux de mise en forme des nombres. Par exemple, la formule « =SUM(A1, 1.5) » en anglais deviendrait « =SUMME(A1; 1,5) » en allemand. Si la plage contient plusieurs cellules, chaque cellule de la plage donnée est mise à jour avec les données d’entrée.

setFormulaLocal(formulaLocal: string): void;

Paramètres

formulaLocal: string

Retours

void

setFormulaR1C1(formulaR1C1)

Définit la formule de cellule en notation de style R1C1. Si la plage contient plusieurs cellules, chaque cellule de la plage donnée est mise à jour avec les données d’entrée.

setFormulaR1C1(formulaR1C1: string): void;

Paramètres

formulaR1C1: string

Retours

void

setFormulas(formulas)

Représente la formule dans le style de notation A1. Si une cellule n’a pas de formule, sa valeur est retournée à la place.

setFormulas(formulas: string[][]): void;

Paramètres

formulas: string[][]

Retours

void

Exemples

/**
 * This script sets the values of a range, then adds SUM formulas to calculate
 * the totals for each row of that range. 
 */
function main(workbook: ExcelScript.Workbook)
{
  let currentSheet = workbook.getActiveWorksheet();

  // Set the values of a range.
  let values = [[1, 2, 4], [8, 16, 32], [64, 128, 256]];
  let valueRange = currentSheet.getRange("A1:C3");
  valueRange.setValues(values);

  // Set the formulas of a range.
  let formulas = [["=SUM(A1:C1)"], ["=SUM(A2:C2)"], ["=SUM(A3:C3)"]];
  let formulaRange = currentSheet.getRange("D1:D3");
  formulaRange.setFormulas(formulas);
}

setFormulasLocal(formulasLocal)

setFormulasLocal(formulasLocal: string[][]): void;

Paramètres

formulasLocal: string[][]

Retours

void

setFormulasR1C1(formulasR1C1)

Représente la formule dans le style de notation R1C1. Si une cellule n’a pas de formule, sa valeur est retournée à la place.

setFormulasR1C1(formulasR1C1: string[][]): void;

Paramètres

formulasR1C1: string[][]

Retours

void

setHyperlink(hyperlink)

Représente le lien hypertexte pour la plage actuelle.

setHyperlink(hyperlink: RangeHyperlink): void;

Paramètres

hyperlink: ExcelScript.RangeHyperlink

Retours

void

Exemples

/** 
 * This script inserts a hyperlink to the first cell of the last worksheet in the workbook.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active cell.
  let cell = workbook.getActiveCell();

  // Get the last worksheet in the workbook.
  // Note that this might be the current sheet if there's only one worksheet.
  let lastSheet = workbook.getLastWorksheet();

  // Get sheet name. 
  let linkedSheetName = lastSheet.getName();
  console.log(`Setting hyperlink of ${cell.getAddress()} to the ${linkedSheetName} sheet's A1 cell`);

  // Set the text for the hyperlink.
  let value = `Click to go to: ${linkedSheetName}`;

  // Create the hyperlink using that cell's value.
  cell.setHyperlink({
    textToDisplay: value.toString(),
    screenTip: `Navigate to ${linkedSheetName}`,
    documentReference: `${linkedSheetName}!A1`
  });
}

setNumberFormat(numberFormat)

Définit le code de format numérique Excel de cellule pour la plage donnée. Si la plage contient plusieurs cellules, chaque cellule de la plage donnée est mise à jour avec les données d’entrée.

setNumberFormat(numberFormat: string): void;

Paramètres

numberFormat: string

Retours

void

Exemples

/**
 * This script sets the number format in column C to show the data as a percentage.
 */
function main(workbook: ExcelScript.Workbook) {
  const  selectedSheet = workbook.getActiveWorksheet();
  
  // Set number format for column C to a percentage that rounds to the nearest percentage point.
  selectedSheet.getRange("C:C").setNumberFormat("0%");
}

setNumberFormatLocal(numberFormatLocal)

Définit le code de format numérique Excel de cellule pour la plage donnée, en fonction des paramètres de langue de l’utilisateur. Excel n’effectue aucune contrainte de langage ou de mise en forme lors de l’obtention ou de la définition de la numberFormatLocal propriété. Tout texte retourné utilise les chaînes mises en forme localement en fonction de la langue spécifiée dans les paramètres système. Si la plage contient plusieurs cellules, chaque cellule de la plage donnée est mise à jour avec les données d’entrée.

setNumberFormatLocal(numberFormatLocal: string): void;

Paramètres

numberFormatLocal: string

Retours

void

Exemples

/**
 * This script sets the number format in column D to show the data as a percentage with a decimal.
 */
function main(workbook: ExcelScript.Workbook) {
  const  selectedSheet = workbook.getActiveWorksheet();
  
  // Set number format for column D to a percentage that rounds to the nearest tenth of a percentage.
  selectedSheet.getRange("D:D").setNumberFormatLocal("0.0%");
}

setNumberFormats(numberFormats)

Représente le code de format numérique d’Excel pour la plage donnée.

setNumberFormats(numberFormats: string[][]): void;

Paramètres

numberFormats: string[][]

Retours

void

setNumberFormatsLocal(numberFormatsLocal)

setNumberFormatsLocal(numberFormatsLocal: string[][]): void;

Paramètres

numberFormatsLocal: string[][]

Retours

void

setPredefinedCellStyle(predefinedCellStyle)

Représente le style de la plage actuelle.

setPredefinedCellStyle(predefinedCellStyle: string): void;

Paramètres

predefinedCellStyle: string

Retours

void

setRowHidden(rowHidden)

setRowHidden(rowHidden: boolean): void;

Paramètres

rowHidden: boolean

Retours

void

setValue(value)

Définit la valeur brute de la plage spécifiée. Les données en cours de définition peuvent être de type chaîne, nombre ou booléen. null la valeur sera ignorée (non définie ou remplacée dans Excel). Si la plage contient plusieurs cellules, chaque cellule de la plage donnée est mise à jour avec les données d’entrée.

setValue(value: any): void;

Paramètres

value: any

Retours

void

setValues(values)

Définit les valeurs brutes de la plage spécifiée. Les données fournies peuvent être une chaîne, un nombre ou une valeur booléenne. Si la valeur fournie commence par un signe plus (« + »), moins (« - ») ou égal (« = »), Excel interprète cette valeur comme une formule.

setValues(values: (string | number | boolean)[][]): void;

Paramètres

values: (string | number | boolean)[][]

Retours

void

Exemples

/**
 * This sample inserts some pre-loaded data into a range.
 * It also shows how to get a range that fits the data.
 */
 function main(workbook: ExcelScript.Workbook) {
   // Get the active cell.
   let currentCell = workbook.getActiveCell();
   
   // Calculate the range needed to fit the given data.
   let targetRange = currentCell.getResizedRange(DATA.length - 1, DATA[0].length - 1);

   // Set range values to the data.
   targetRange.setValues(DATA);

   // Autofit the columns so the worksheet is readable. 
   targetRange.getFormat().autofitColumns();
 }

 /* 
  * This sample's data is in a static 2-dimensional array.
  * You could also get the input from other ranges or sources.
  * Note that each row must have the same number of columns to be valid. 
  */
 const DATA = [
   ['Date', 'Salesperson', 'Product', 'Amount']
   , ['3/2/2020', 'Anne', 'Pizza', '$1400']
   , ['3/2/2020', 'Mariya', 'Pizza', '$1700']
   , ['3/7/2020', 'Mark', 'Sandwiches', '$1010']
   , ['3/24/2020', 'Anne', 'Pizza', '$750']
   , ['3/28/2020', 'Mark', 'Salads', '$510']
   , ['4/17/2020', 'Laura', 'Salads', '$900']
   , ['4/17/2020', 'Mariya', 'Salads', '$1600']
   , ['4/28/2020', 'Laura', 'Sandwiches', '$680']
 ];

showCard()

Affiche la carte pour une cellule active si son contenu est riche en valeur.

showCard(): void;

Retours

void

showGroupDetails(groupOption)

Affiche les détails du groupe de lignes ou de colonnes.

showGroupDetails(groupOption: GroupOption): void;

Paramètres

groupOption: ExcelScript.GroupOption

Spécifie s’il faut afficher les détails des lignes groupées ou des colonnes groupées.

Retours

void

ungroup(groupOption)

Dissocie les colonnes et les lignes d’un plan.

ungroup(groupOption: GroupOption): void;

Paramètres

groupOption: ExcelScript.GroupOption

Spécifie comment la plage peut être dissociée par lignes ou colonnes.

Retours

void

unmerge()

Annule la fusion de la plage de cellules.

unmerge(): void;

Retours

void

Exemples

/**
 * This script unmerges every used cell in the current worksheet.
 */
function main(workbook: ExcelScript.Workbook) {
  // Get the active worksheet.
  const selectedSheet = workbook.getActiveWorksheet();

  // Separate all regions into single cells in the currently used range.
  const range = selectedSheet.getUsedRange();
  range.unmerge();
}

Partager via

ExcelScript.Range interface

Remarques

Exemples

Méthodes

Détails de la méthode

addConditionalFormat(type)

Paramètres

Retours

Exemples

autoFill(destinationRange, autoFillType)

Paramètres

Retours

Exemples

calculate()

Retours

Exemples

clear(applyTo)

Paramètres

Retours

Exemples

clearAllConditionalFormats()

Retours

convertDataTypeToText()

Retours

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Paramètres

Retours

Exemples

delete(shift)

Paramètres

Retours

Exemples

find(text, criteria)

Paramètres

Retours

Exemples

flashFill()

Retours

Exemples

getAbsoluteResizedRange(numRows, numColumns)

Paramètres

Retours

getAddress()

Retours

Exemples

getAddressLocal()

Retours

getBoundingRect(anotherRange)

Paramètres

Retours

Exemples

getCell(row, column)

Paramètres

Retours

getCellCount()

Retours

getColumn(column)

Paramètres

Retours

getColumnCount()

Retours

Exemples

getColumnHidden()

Retours

getColumnIndex()

Retours

getColumnsAfter(count)

Paramètres

Retours

getColumnsBefore(count)

Paramètres

Retours

getConditionalFormat(id)

Paramètres

Retours

getConditionalFormats()

Retours

getDataValidation()

Retours