Excel.Range class

La plage représente un ensemble d’une ou plusieurs cellules contiguës telles qu’une cellule, une ligne, une colonne ou un bloc de cellules. Pour en savoir plus sur la façon dont les plages sont utilisées dans l’API, commencez par Plages dans l’API JavaScript d’Excel.

Remarques

[Jeu d’API : ExcelApi 1.1]

Propriétés

address	Spécifie la référence de plage dans le style A1. La valeur Address contient la référence de feuille (par exemple, « Feuil1 ! A1 :B4").
addressLocal	Représente la référence de plage pour la plage spécifiée dans la langue de l’utilisateur.
cellCount	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).
columnCount	Spécifie le nombre total de colonnes dans la plage.
columnHidden	Indique si toutes les colonnes de la plage actuelle sont masquées. `true` Valeur lorsque toutes les colonnes d’une plage sont masquées. Valeur lorsque `false` aucune colonne de la plage n’est masquée. `null` Valeur lorsque certaines colonnes d’une plage sont masquées et que d’autres colonnes de la même plage ne sont pas masquées.
columnIndex	Spécifie le numéro de colonne de la première cellule de la plage. Avec indice zéro.
conditionalFormats	La collection de `ConditionalFormats` qui recoupe la gamme.
context	Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.
control	Accède au contrôle de cellule appliqué à cette plage. Si la plage comporte plusieurs contrôles de cellule, .`EmptyCellControl`
dataValidation	Renvoie un objet de validation des données.
format	Renvoie un objet de mise en forme qui encapsule la police, le remplissage, les bordures, l’alignement et d’autres propriétés de la plage.
formulas	Représente la formule dans le style de notation A1. Si une cellule n’a pas de formule, sa valeur est renvoyée à la place.
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 renvoyée à la place.
formulasR1C1	Représente la formule dans le style de notation R1C1. Si une cellule n’a pas de formule, sa valeur est renvoyée à la place.
hasSpill	Représente si toutes les cellules ont une bordure renversée. Renvoie `true` si toutes les cellules ont une bordure de débordement ou `false` si toutes les cellules n’ont pas de bordure de débordement. Renvoie `null` s’il y a des cellules avec et sans bordure de débordement dans la plage.
height	Renvoie la distance en points, pour un zoom de 100 %, du bord supérieur de la plage au bord inférieur de la plage.
hidden	Indique si toutes les cellules de la plage actuelle sont masquées. Valeur lorsque `true` toutes les cellules d’une plage sont masquées. Valeur lorsque `false` aucune cellule de la plage n’est masquée. `null` Valeur lorsque certaines cellules d’une plage sont masquées et que d’autres cellules de la même plage ne sont pas masquées.
hyperlink	Représente le lien hypertexte de la plage active.
isEntireColumn	Représente si la plage active est une colonne entière.
isEntireRow	Représente si la plage active est une ligne entière.
left	Renvoie la distance en points, pour un zoom de 100 %, du bord gauche de la feuille de calcul au bord gauche de la plage.
linkedDataTypeState	Représente l’état du type de données de chaque cellule.
numberFormat	Représente le code de format de nombre d’Excel pour une plage donnée. Pour plus d’informations sur la mise en forme des nombres dans Excel, voir Codes de format de nombre.
numberFormatCategories	Représente la catégorie de format de nombre de chaque cellule.
numberFormatLocal	Représente le code de format de nombre d’Excel pour une plage donnée, en fonction des paramètres de langue de l’utilisateur. Excel n’effectue aucune coercition de langage ou de format lors de l’obtention ou de la définition de la `numberFormatLocal` propriété. Tout texte renvoyé utilise les chaînes mises en forme localement en fonction de la langue spécifiée dans les paramètres système.
rowCount	Renvoie le nombre total de lignes de la plage.
rowHidden	Indique si toutes les lignes de la plage actuelle sont masquées. Valeur lorsque `true` toutes les lignes d’une plage sont masquées. `false` Valeur lorsque aucune ligne de la plage n’est masquée. `null` Valeur lorsque certaines lignes d’une plage sont masquées et que d’autres lignes de la même plage ne sont pas masquées.
rowIndex	Renvoie le numéro de ligne de la première cellule de la plage. Avec indice zéro.
savedAsArray	Indique si toutes les cellules sont enregistrées sous la forme d’une formule matricielle. Renvoie `true` si toutes les cellules sont enregistrées sous la forme d’une formule matricielle ou `false` si toutes les cellules ne sont pas enregistrées sous la forme d’une formule matricielle. Renvoie `null` si certaines cellules sont enregistrées en tant que formule matricielle et d’autres non.
sort	Représente le tri de plage de la plage actuelle.
style	Représente le style de la plage actuelle. Si les styles des cellules sont incohérents, `null` est renvoyée. Pour les styles personnalisés, le nom du style est renvoyé. Pour les styles intégrés, une chaîne représentant une valeur dans l’énumération `BuiltInStyle` est renvoyée.
text	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 dièse (#) qui se produit dans l’interface utilisateur Excel n’affecte pas la valeur de texte retournée par l’API.
top	Renvoie la distance en points, pour un zoom de 100 %, entre le bord supérieur de la feuille de calcul et le bord supérieur de la plage.
values	Représente les valeurs brutes de la plage spécifiée. Les données renvoyé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 renvoyée commence par un plus (« + »), moins (« - ») ou un signe égal (« = »), Excel interprète cette valeur comme une formule. Les chaînes en forme de paramètres régionaux (telles que la date « 19-8-2025 » en nl-NL ou fr-FR, format DD-MM-YYYY) sont stockées en tant que texte et non en tant que dates. Pour vous assurer que les dates sont stockées en tant que dates, utilisez une API adaptée aux paramètres régionaux, comme `formulasLocal` ou un format indépendant des paramètres régionaux, comme ISO (AAAA-MM-JJ) ou une date numérique de série.
valuesAsJson	Représentation JSON des valeurs dans les cellules de cette plage. Contrairement à `Range.values`, `Range.valuesAsJson` prend en charge tous les types de données pouvant se trouver dans une cellule. Par exemple, des valeurs numériques mises en forme et des images web, en plus des valeurs booléennes, numériques et de chaîne standard. Les données renvoyées à partir de cette API s’alignent toujours sur les paramètres régionaux fr-FR. Pour récupérer des données dans les paramètres régionaux d’affichage de l’utilisateur, utilisez `Range.valuesAsJsonLocal`.
valuesAsJsonLocal	Représentation JSON des valeurs dans les cellules de cette plage. Contrairement à `Range.values`, `Range.valuesAsJsonLocal` prend en charge tous les types de données pouvant se trouver dans une cellule. Par exemple, des valeurs numériques mises en forme et des images web, en plus des valeurs booléennes, numériques et de chaîne standard. Les données renvoyées par cette API s’alignent toujours sur les paramètres régionaux d’affichage de l’utilisateur. Pour récupérer des données indépendamment des paramètres régionaux, utilisez `Range.valuesAsJson`.
valueTypes	Spécifie le type de données dans chaque cellule.
width	Renvoie la distance en points, pour un zoom de 100 %, du bord gauche de la plage au bord droit de la plage.
worksheet	Feuille de calcul contenant la plage.

Méthodes

autoFill(destinationRange, autoFillType)	Remplit une plage de la plage actuelle vers 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 non contiguës ne sont pas prises en charge. Pour plus d’informations, voir Utiliser la recopie incrémentée et le remplissage instantané.
autoFill(destinationRange, autoFillType)	Remplit une plage de la plage actuelle vers 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 non contiguës ne sont pas prises en charge. Pour plus d’informations, voir Utiliser la recopie incrémentée et le remplissage instantané.
calculate()	Calcule une plage de cellules dans une feuille de calcul.
clear(applyTo)	Effacer les valeurs de plage et la mise en forme, telles que le remplissage et la bordure.
clear(applyTo)	Effacer les valeurs de plage et la mise en forme, telles que le remplissage et la bordure.
clearOrResetContents()	Efface les valeurs des cellules de la plage, en accordant une attention particulière aux cellules contenant des contrôles. Si la plage ne contient que des valeurs vides et des contrôles définis sur leur valeur par défaut, les valeurs et la mise en forme des contrôles sont supprimées. Dans le cas contraire, les cellules avec les contrôles sont définies sur leur valeur par défaut et efface les valeurs des autres cellules de la plage.
convertDataTypeToText()	Convertit les cellules de la plage avec les types de données en texte.
convertToLinkedDataType(serviceID, languageCulture)	Convertit les cellules de la plage en types de données liés dans la feuille de calcul.
copyFrom(sourceRange, copyType, skipBlanks, transpose)	Copie les données ou la mise en forme des cellules de la plage source ou `RangeAreas` de la plage active. La plage de destination peut être d’une taille différente 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 de l’interface utilisateur d’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 la plage 2x2 dans une plage 2x6 donnera 3 copies de la plage 2x2 d’origine.
copyFrom(sourceRange, copyType, skipBlanks, transpose)	Copie les données ou la mise en forme des cellules de la plage source ou `RangeAreas` de la plage active. La plage de destination peut être d’une taille différente 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 de l’interface utilisateur d’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 la plage 2x2 dans une plage 2x6 donnera 3 copies de la plage 2x2 d’origine.
delete(shift)	Supprime les cellules associées à la plage.
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 plus grande qu’une seule cellule, la recherche est limitée à cette plage, sinon la recherche couvre toute la feuille commençant après cette cellule.
findOrNullObject(text, criteria)	Recherche la chaîne donnée basée sur les critères spécifiés. Si la plage actuelle est plus grande qu’une seule cellule, la recherche est limitée à cette plage, sinon la recherche couvre toute la feuille commençant après cette cellule. S’il n’y a pas de correspondance, cette méthode renvoie un objet dont la `isNullObject` propriété est définie sur `true`. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
flashFill()	Effectue un remplissage instantané à la plage actuelle. Le remplissage instantané renseigne automatiquement les données lorsqu’il détecte un modèle. La plage doit donc être une plage de colonne unique et avoir des données autour d’elle afin de trouver un modèle.
getAbsoluteResizedRange(numRows, numColumns)	Obtient un objet avec la `Range` même cellule supérieure gauche que l’objet actuel `Range` , mais avec le nombre spécifié de lignes et de colonnes.
getBoundingRect(anotherRange)	Renvoie le plus petit objet de plage qui englobe les plages données. Par exemple, les `GetBoundingRect` valeurs de « B2 :C5 » et « D10 :E15 » font « 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 la feuille de calcul. L’emplacement de la cellule renvoyée est déterminé à partir de la cellule supérieure gauche de la plage.
getCellProperties(cellPropertiesLoadOptions)	Renvoie une plage en 2D, qui comprend les propriétés de police, de remplissage, de bordures, d’alignement, etc. de la plage.
getColumn(column)	Obtient une colonne contenue dans la plage.
getColumnProperties(columnPropertiesLoadOptions)	Renvoie une plage à dimension unique, qui comprend les données de char colonne de police, de remplissage, de bordures, d’alignement, etc. de la plage. Pour les propriétés ne sont pas cohérentes au sein de chaque cellule dans une colonne donnée, null est renvoyé.
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` .
getDependents()	Renvoie un `WorkbookRangeAreas` objet qui représente la plage contenant toutes les cellules dépendantes d’une plage spécifiée dans la même feuille de calcul ou dans plusieurs feuilles de calcul. Génère une `ItemNotFound` erreur si aucune personne à charge n’est trouvée.
getDirectDependents()	Renvoie un `WorkbookRangeAreas` objet qui représente la plage contenant toutes les cellules dépendantes directes d’une plage spécifiée dans la même feuille de calcul ou dans plusieurs feuilles de calcul. Génère une `ItemNotFound` erreur si aucune personne à charge n’est trouvée.
getDirectPrecedents()	Renvoie un `WorkbookRangeAreas` objet qui représente la plage contenant toutes les cellules précédentes directes d’une plage spécifiée dans la même feuille de calcul ou dans plusieurs feuilles de calcul. Génère une `ItemNotFound` erreur si aucun précédent n’est trouvé.
getDisplayedCellProperties(cellPropertiesLoadOptions)	Renvoie un tableau 2D encapsulant les données d’affichage pour la police, le remplissage, les bordures, l’alignement et d’autres propriétés de chaque cellule. Contrairement à `getCellProperties`, qui affiche uniquement les propriétés définies directement pour la cellule, renvoie les propriétés affichées à partir de sources indirectes, telles que la mise en forme conditionnelle ou les styles.
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)	Renvoie 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 d’Excel sur Windows.
getExtendedRange(direction, activeCell)	Renvoie 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 d’Excel sur Windows.
getImage()	Rend 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.
getIntersectionOrNullObject(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 renvoie un objet dont la `isNullObject` propriété est définie sur `true`. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
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 ».
getMergedAreasOrNullObject()	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 renverra pas le résultat. Si l’objet `RangeAreas` n’existe pas, cette méthode renvoie un objet dont la `isNullObject` propriété est définie sur `true`. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
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 étendue de tableaux croisés dynamiques qui chevauchent la plage.
getPrecedents()	Renvoie un `WorkbookRangeAreas` objet qui représente la plage contenant toutes les cellules précédentes d’une plage spécifiée dans la même feuille de calcul ou dans plusieurs feuilles de calcul. Génère une `ItemNotFound` erreur si aucun précédent n’est trouvé.
getRangeEdge(direction, activeCell)	Renvoie 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 de Ctrl+Touche de direction dans l’interface utilisateur d’Excel sur Windows.
getRangeEdge(direction, activeCell)	Renvoie 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 de Ctrl+Touche de direction dans l’interface utilisateur d’Excel sur Windows.
getResizedRange(deltaRows, deltaColumns)	Récupère un `Range` objet semblable à l’objet actuel `Range` , mais dont le coin inférieur droit est développé (ou réduit) d’un certain nombre de lignes et de colonnes.
getRow(row)	Obtient une ligne contenue dans la plage.
getRowProperties(rowPropertiesLoadOptions)	Renvoie une plage à dimension unique , qui comprend les données de police, de remplissage, de bordures, d’alignement, etc. de la plage. Pour les propriétés qui ne sont pas cohérentes dans chaque cellule d’une ligne donnée, `null` sont retournées.
getRowsAbove(count)	Récupère 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` .
getSpecialCells(cellType, cellValueType)	Obtient l’objet `RangeAreas` , comprenant une ou plusieurs plages rectangulaires, qui représente toutes les cellules correspondant au type et à la valeur spécifiés. Si aucune cellule spéciale n’est trouvée, une `ItemNotFound` erreur est générée.
getSpecialCells(cellType, cellValueType)	Obtient l’objet `RangeAreas` , comprenant une ou plusieurs plages rectangulaires, qui représente toutes les cellules correspondant au type et à la valeur spécifiés. Si aucune cellule spéciale n’est trouvée, une `ItemNotFound` erreur est générée.
getSpecialCellsOrNullObject(cellType, cellValueType)	Récupère l’objet `RangeAreas` , comprenant une ou plusieurs plages, qui représente toutes les cellules correspondant au type et à la valeur spécifiés. Si aucune cellule spéciale n’est trouvée, cette méthode renvoie un objet dont la `isNullObject` propriété est définie sur `true`. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
getSpecialCellsOrNullObject(cellType, cellValueType)	Récupère l’objet `RangeAreas` , comprenant une ou plusieurs plages, qui représente toutes les cellules correspondant au type et à la valeur spécifiés. Si aucune cellule spéciale n’est trouvée, cette méthode renvoie un objet dont la `isNullObject` propriété est définie sur `true`. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
getSpillingToRange()	Obtient l’objet de la plage contenant la plage renversé lorsque appelée sur une cellule d’ancrage. Échoue si appliqué à une plage comportant plusieurs cellules.
getSpillingToRangeOrNullObject()	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 renvoie un objet dont `isNullObject` la propriété est définie sur `true`. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
getSpillParent()	Obtient l’objet de la plage contenant la cellule d’ancrage d’une cellule prise renversée dans. Échoue si appliqué à une plage comportant plusieurs cellules.
getSpillParentOrNullObject()	Obtient l’objet de plage contenant la cellule d’ancrage pour la cellule dans laquelle elle est déversée. S’il ne s’agit pas d’une cellule renversée ou si plusieurs cellules sont données, cette méthode renvoie un objet avec sa `isNullObject` propriété définie sur `true`. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
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.
getUsedRange(valuesOnly)	Renvoie la plage utilisée d’un objet de plage donné. Si aucune cellule n’est utilisée dans la plage, cette fonction renvoie une `ItemNotFound` erreur.
getUsedRangeOrNullObject(valuesOnly)	Renvoie la plage utilisée d’un objet de plage donné. S’il n’y a pas de cellules utilisées dans la plage, cette méthode renvoie un objet avec sa `isNullObject` propriété définie sur `true`. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.
getVisibleView()	Représente les lignes visibles de la plage en cours.
group(groupOption)	Regroupe des colonnes et des lignes pour établir un plan.
group(groupOption)	Regroupe des colonnes et des lignes pour établir un plan.
hideGroupDetails(groupOption)	Masque les détails du groupe de lignes ou de colonnes.
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. Renvoie un nouvel `Range` objet à l’espace vide.
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. Renvoie un nouvel `Range` objet à l’espace vide.
load(options)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter `context.sync()` avant de lire les propriétés.
load(propertyNames)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter `context.sync()` avant de lire les propriétés.
load(propertyNamesAndPaths)	Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter `context.sync()` avant de lire les propriétés.
merge(across)	Fusionne la plage de cellules dans une zone de la feuille de calcul.
moveTo(destinationRange)	Déplacement des valeurs de cellule, de la mise en forme et des formules de la plage actuelle vers la plage de destination, en remplaçant les anciennes informations de ces cellules. La plage de destination est développée automatiquement si elle est inférieure à la plage actuelle. Toutes 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. Remarque : lorsqu’une plage est déplacée vers une nouvelle adresse à l’aide de cette API, le nouvel objet de plage doit être récupéré à l’aide de la nouvelle adresse.
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.
set(properties, options)	Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.
set(properties)	Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
setCellProperties(cellPropertiesData)	Mises à jour de la plage sur la base d’un tableau 2D de propriétés de cellule, encapsulant des éléments tels que la police, le remplissage, les bordures et l’alignement.
setColumnProperties(columnPropertiesData)	Mises à jour de la plage sur la base d’un tableau unidimensionnel de propriétés de colonne, encapsulant des éléments tels que la police, le remplissage, les bordures et l’alignement.
setDirty()	Cette méthode désigne une plage qui doit être recalculée lorsque le recalcul suivant se produit.
setRowProperties(rowPropertiesData)	Mises à jour de la plage sur la base d’un tableau unidimensionnel de propriétés de ligne, encapsulant des éléments tels que la police, le remplissage, les bordures et l’alignement.
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.
showGroupDetails(groupOption)	Affiche les détails du groupe de lignes ou de colonnes.
toJSON()	Remplace la méthode JavaScript `toJSON()` afin de fournir une sortie plus utile lorsqu’un objet API est passé à `JSON.stringify()`. (`JSON.stringify`, à son tour, appelle la `toJSON` méthode de l’objet qui lui est passé.) Alors que l’objet d’origine `Excel.Range` est un objet API, la `toJSON` méthode renvoie un objet JavaScript simple (typé ) `Excel.Interfaces.RangeData`qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.
track()	Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet entre des `.sync` appels et en dehors de l’exécution séquentielle d’un lot « .run » et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivis lors de la création initiale de l’objet.
ungroup(groupOption)	Dissocie les colonnes et les lignes d’un plan.
ungroup(groupOption)	Dissocie les colonnes et les lignes d’un plan.
unmerge()	Annule la fusion de la plage de cellules.
untrack()	Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler `context.sync()` avant que la libération de mémoire prenne effet.

address

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

readonly address: string;

Valeur de propriété

string

Remarques

[Jeu d’API : ExcelApi 1.1]

addressLocal

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

readonly addressLocal: string;

Valeur de propriété

string

Remarques

[Jeu d’API : ExcelApi 1.1]

cellCount

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

readonly cellCount: number;

Valeur de propriété

number

Remarques

[Jeu d’API : ExcelApi 1.1]

columnCount

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

readonly columnCount: number;

Valeur de propriété

number

Remarques

[Jeu d’API : ExcelApi 1.1]

columnHidden

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

columnHidden: boolean;

Valeur de propriété

boolean

Remarques

[Jeu d’API : ExcelApi 1.2]

columnIndex

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

readonly columnIndex: number;

Valeur de propriété

number

Remarques

[Jeu d’API : ExcelApi 1.1]

conditionalFormats

La collection de ConditionalFormats qui recoupe la gamme.

readonly conditionalFormats: Excel.ConditionalFormatCollection;

Valeur de propriété

Excel.ConditionalFormatCollection

Remarques

[Jeu d’API : ExcelApi 1.6]

context

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

context: RequestContext;

Valeur de propriété

Excel.RequestContext

control

Accède au contrôle de cellule appliqué à cette plage. Si la plage comporte plusieurs contrôles de cellule, .EmptyCellControl

control: CellControl;

Valeur de propriété

Excel.CellControl

Remarques

[Jeu d’API : ExcelApi 1.18]

dataValidation

Renvoie un objet de validation des données.

readonly dataValidation: Excel.DataValidation;

Valeur de propriété

Excel.DataValidation

Remarques

[Jeu d’API : ExcelApi 1.8]

format

Renvoie un objet de mise en forme qui encapsule la police, le remplissage, les bordures, l’alignement et d’autres propriétés de la plage.

readonly format: Excel.RangeFormat;

Valeur de propriété

Excel.RangeFormat

Remarques

[Jeu d’API : ExcelApi 1.1]

formulas

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

formulas: any[][];

Valeur de propriété

any[][]

Remarques

[Jeu d’API : ExcelApi 1.1]

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 renvoyée à la place.

formulasLocal: any[][];

Valeur de propriété

any[][]

Remarques

[Jeu d’API : ExcelApi 1.1]

formulasR1C1

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

formulasR1C1: any[][];

Valeur de propriété

any[][]

Remarques

[Jeu d’API : ExcelApi 1.2]

hasSpill

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

readonly hasSpill: boolean;

Valeur de propriété

boolean

Remarques

[Jeu d’API : ExcelApi 1.12]

height

Renvoie la distance en points, pour un zoom de 100 %, du bord supérieur de la plage au bord inférieur de la plage.

readonly height: number;

Valeur de propriété

number

Remarques

[Jeu d’API : ExcelApi 1.10]

hidden

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

readonly hidden: boolean;

Valeur de propriété

boolean

Remarques

[Jeu d’API : ExcelApi 1.2]

hyperlink

Représente le lien hypertexte de la plage active.

hyperlink: Excel.RangeHyperlink;

Valeur de propriété

Excel.RangeHyperlink

Remarques

[Jeu d’API : ExcelApi 1.7]

isEntireColumn

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

readonly isEntireColumn: boolean;

Valeur de propriété

boolean

Remarques

[Jeu d’API : ExcelApi 1.7]

isEntireRow

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

readonly isEntireRow: boolean;

Valeur de propriété

boolean

Remarques

[Jeu d’API : ExcelApi 1.7]

left

Renvoie la distance en points, pour un zoom de 100 %, du bord gauche de la feuille de calcul au bord gauche de la plage.

readonly left: number;

Valeur de propriété

number

Remarques

[Jeu d’API : ExcelApi 1.10]

linkedDataTypeState

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

readonly linkedDataTypeState: Excel.LinkedDataTypeState[][];

Valeur de propriété

Excel.LinkedDataTypeState[][]

Remarques

[Jeu d’API : ExcelApi 1.9]

numberFormat

Représente le code de format de nombre d’Excel pour une plage donnée. Pour plus d’informations sur la mise en forme des nombres dans Excel, voir Codes de format de nombre.

numberFormat: any[][];

Valeur de propriété

any[][]

Remarques

[Jeu d’API : ExcelApi 1.1]

numberFormatCategories

Représente la catégorie de format de nombre de chaque cellule.

readonly numberFormatCategories: Excel.NumberFormatCategory[][];

Valeur de propriété

Excel.NumberFormatCategory[][]

Remarques

[Jeu d’API : ExcelApi 1.12]

numberFormatLocal

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

numberFormatLocal: any[][];

Valeur de propriété

any[][]

Remarques

[Jeu d’API : ExcelApi 1.7]

rowCount

Renvoie le nombre total de lignes de la plage.

readonly rowCount: number;

Valeur de propriété

number

Remarques

[Jeu d’API : ExcelApi 1.1]

rowHidden

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

rowHidden: boolean;

Valeur de propriété

boolean

Remarques

[Jeu d’API : ExcelApi 1.2]

rowIndex

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

readonly rowIndex: number;

Valeur de propriété

number

Remarques

[Jeu d’API : ExcelApi 1.1]

savedAsArray

Indique si toutes les cellules sont enregistrées sous la forme d’une formule matricielle. Renvoie true si toutes les cellules sont enregistrées sous la forme d’une formule matricielle ou false si toutes les cellules ne sont pas enregistrées sous la forme d’une formule matricielle. Renvoie null si certaines cellules sont enregistrées en tant que formule matricielle et d’autres non.

readonly savedAsArray: boolean;

Valeur de propriété

boolean

Remarques

[Jeu d’API : ExcelApi 1.12]

sort

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

readonly sort: Excel.RangeSort;

Valeur de propriété

Excel.RangeSort

Remarques

[Jeu d’API : ExcelApi 1.2]

style

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

style: string;

Valeur de propriété

string

Remarques

[Jeu d’API : ExcelApi 1.7]

text

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 dièse (#) qui se produit dans l’interface utilisateur Excel n’affecte pas la valeur de texte retournée par l’API.

readonly text: string[][];

Valeur de propriété

string[][]

Remarques

[Jeu d’API : ExcelApi 1.1]

top

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

readonly top: number;

Valeur de propriété

number

Remarques

[Jeu d’API : ExcelApi 1.10]

values

Représente les valeurs brutes de la plage spécifiée. Les données renvoyé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 renvoyée commence par un plus (« + »), moins (« - ») ou un signe égal (« = »), Excel interprète cette valeur comme une formule. Les chaînes en forme de paramètres régionaux (telles que la date « 19-8-2025 » en nl-NL ou fr-FR, format DD-MM-YYYY) sont stockées en tant que texte et non en tant que dates. Pour vous assurer que les dates sont stockées en tant que dates, utilisez une API adaptée aux paramètres régionaux, comme formulasLocal ou un format indépendant des paramètres régionaux, comme ISO (AAAA-MM-JJ) ou une date numérique de série.

values: any[][];

Valeur de propriété

any[][]

Remarques

[Jeu d’API : ExcelApi 1.1]

valuesAsJson

Représentation JSON des valeurs dans les cellules de cette plage. Contrairement à Range.values, Range.valuesAsJson prend en charge tous les types de données pouvant se trouver dans une cellule. Par exemple, des valeurs numériques mises en forme et des images web, en plus des valeurs booléennes, numériques et de chaîne standard. Les données renvoyées à partir de cette API s’alignent toujours sur les paramètres régionaux fr-FR. Pour récupérer des données dans les paramètres régionaux d’affichage de l’utilisateur, utilisez Range.valuesAsJsonLocal.

valuesAsJson: CellValue[][];

Valeur de propriété

Excel.CellValue[][]

Remarques

[Jeu d’API : ExcelApi 1.16]

valuesAsJsonLocal

Représentation JSON des valeurs dans les cellules de cette plage. Contrairement à Range.values, Range.valuesAsJsonLocal prend en charge tous les types de données pouvant se trouver dans une cellule. Par exemple, des valeurs numériques mises en forme et des images web, en plus des valeurs booléennes, numériques et de chaîne standard. Les données renvoyées par cette API s’alignent toujours sur les paramètres régionaux d’affichage de l’utilisateur. Pour récupérer des données indépendamment des paramètres régionaux, utilisez Range.valuesAsJson.

valuesAsJsonLocal: CellValue[][];

Valeur de propriété

Excel.CellValue[][]

Remarques

[Jeu d’API : ExcelApi 1.16]

valueTypes

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

readonly valueTypes: Excel.RangeValueType[][];

Valeur de propriété

Excel.RangeValueType[][]

Remarques

[Jeu d’API : ExcelApi 1.1]

width

Renvoie la distance en points, pour un zoom de 100 %, du bord gauche de la plage au bord droit de la plage.

readonly width: number;

Valeur de propriété

number

Remarques

[Jeu d’API : ExcelApi 1.10]

worksheet

Feuille de calcul contenant la plage.

readonly worksheet: Excel.Worksheet;

Valeur de propriété

Excel.Worksheet

Remarques

[Jeu d’API : ExcelApi 1.1]

autoFill(destinationRange, autoFillType)

Remplit une plage de la plage actuelle vers 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 non contiguës ne sont pas prises en charge.

Pour plus d’informations, voir Utiliser la recopie incrémentée et le remplissage instantané.

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

Paramètres

destinationRange: Excel.Range | string

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

autoFillType: Excel.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

Remarques

[Jeu d’api : ExcelApi 1.9, ExcelApi Preview for null destinationRange]

autoFill(destinationRange, autoFillType)

Remplit une plage de la plage actuelle vers 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 non contiguës ne sont pas prises en charge.

Pour plus d’informations, voir Utiliser la recopie incrémentée et le remplissage instantané.

autoFill(destinationRange?: Range | string, autoFillType?: "FillDefault" | "FillCopy" | "FillSeries" | "FillFormats" | "FillValues" | "FillDays" | "FillWeekdays" | "FillMonths" | "FillYears" | "LinearTrend" | "GrowthTrend" | "FlashFill"): void;

Paramètres

destinationRange: Excel.Range | string

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

autoFillType: "FillDefault" | "FillCopy" | "FillSeries" | "FillFormats" | "FillValues" | "FillDays" | "FillWeekdays" | "FillMonths" | "FillYears" | "LinearTrend" | "GrowthTrend" | "FlashFill"

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

Remarques

[Jeu d’api : ExcelApi 1.9, ExcelApi Preview for null destinationRange]

calculate()

Calcule une plage de cellules dans une feuille de calcul.

calculate(): void;

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.6]

clear(applyTo)

Effacer les valeurs de plage et la mise en forme, telles que le remplissage et la bordure.

clear(applyTo?: Excel.ClearApplyTo): void;

Paramètres

applyTo: Excel.ClearApplyTo

Facultatif. Détermine le type d’action de suppression. Pour Excel.ClearApplyTo plus de détails.

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.1]

clear(applyTo)

Effacer les valeurs de plage et la mise en forme, telles que le remplissage et la bordure.

clear(applyTo?: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"): void;

Paramètres

applyTo: "All" | "Formats" | "Contents" | "Hyperlinks" | "RemoveHyperlinks" | "ResetContents"

convertToLinkedDataType(serviceID: number, languageCulture: string): void;

Paramètres

serviceID: number

ID de service qui sera utilisé pour interroger les données.

languageCulture: string

Culture linguistique pour interroger le service.

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.9]

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Copie les données ou la mise en forme des cellules de la plage source ou RangeAreas de la plage active. La plage de destination peut être d’une taille différente 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 de l’interface utilisateur d’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 la plage 2x2 dans une plage 2x6 donnera 3 copies de la plage 2x2 d’origine.

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

Paramètres

sourceRange: Excel.Range | Excel.RangeAreas | string

Plage source ou RangeAreas à copier. Lorsque la source RangeAreas comporte plusieurs plages, leur forme doit pouvoir être créée en supprimant des lignes ou des colonnes complètes d’une plage rectangulaire.

copyType: Excel.RangeCopyType

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

skipBlanks: boolean

True si vous souhaitez ignorer les cellules vides de la plage source. La valeur par défaut est False.

transpose: boolean

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

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.9]

copyFrom(sourceRange, copyType, skipBlanks, transpose)

Copie les données ou la mise en forme des cellules de la plage source ou RangeAreas de la plage active. La plage de destination peut être d’une taille différente 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 de l’interface utilisateur d’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 la plage 2x2 dans une plage 2x6 donnera 3 copies de la plage 2x2 d’origine.

copyFrom(sourceRange: Range | RangeAreas | string, copyType?: "All" | "Formulas" | "Values" | "Formats" | "Link", skipBlanks?: boolean, transpose?: boolean): void;

Paramètres

sourceRange: Excel.Range | Excel.RangeAreas | string

Plage source ou RangeAreas à copier. Lorsque la source RangeAreas comporte plusieurs plages, leur forme doit pouvoir être créée en supprimant des lignes ou des colonnes complètes d’une plage rectangulaire.

copyType: "All" | "Formulas" | "Values" | "Formats" | "Link"

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

skipBlanks: boolean

True si vous souhaitez ignorer les cellules vides de la plage source. La valeur par défaut est False.

transpose: boolean

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

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.9]

delete(shift)

Supprime les cellules associées à la plage.

delete(shift: Excel.DeleteShiftDirection): void;

Paramètres

shift: Excel.DeleteShiftDirection

Indique la façon dont les cellules doivent être décalées. Pour Excel.DeleteShiftDirection plus de détails.

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.1]

delete(shift)

Supprime les cellules associées à la plage.

delete(shift: "Up" | "Left"): void;

Paramètres

shift: "Up" | "Left"

Indique la façon dont les cellules doivent être décalées. Pour Excel.DeleteShiftDirection plus de détails.

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.1]

find(text, criteria)

Recherche la chaîne donnée basée sur les critères spécifiés. Si la plage actuelle est plus grande qu’une seule cellule, la recherche est limitée à cette plage, sinon la recherche couvre toute la feuille commençant après cette cellule.

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

Paramètres

text: string

Chaîne à trouver.

criteria: Excel.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

Excel.Range

Objet Range représentant la première cellule qui contient une valeur correspondant au texte et aux critères de recherche.

Remarques

[Jeu d’API : ExcelApi 1.9]

findOrNullObject(text, criteria)

Recherche la chaîne donnée basée sur les critères spécifiés. Si la plage actuelle est plus grande qu’une seule cellule, la recherche est limitée à cette plage, sinon la recherche couvre toute la feuille commençant après cette cellule. S’il n’y a pas de correspondance, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

findOrNullObject(text: string, criteria: Excel.SearchCriteria): Excel.Range;

Paramètres

text: string

Chaîne à trouver.

criteria: Excel.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

Excel.Range

Le Range qui correspondait aux critères de recherche.

Remarques

[Jeu d’API : ExcelApi 1.9]

flashFill()

Effectue un remplissage instantané à la plage actuelle. Le remplissage instantané renseigne automatiquement les données lorsqu’il détecte un modèle. La plage doit donc être une plage de colonne unique et avoir des données autour d’elle afin de trouver un modèle.

flashFill(): void;

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.9]

getAbsoluteResizedRange(numRows, numColumns)

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

getAbsoluteResizedRange(numRows: number, numColumns: number): Excel.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

Excel.Range

Remarques

[Jeu d’API : ExcelApi 1.7]

getBoundingRect(anotherRange)

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

getBoundingRect(anotherRange: Range | string): Excel.Range;

Paramètres

anotherRange: Excel.Range | string

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

Retours

Excel.Range

Remarques

[Jeu d’API : ExcelApi 1.1]

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 la 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): Excel.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

Excel.Range

Remarques

[Jeu d’API : ExcelApi 1.1]

getCellProperties(cellPropertiesLoadOptions)

Renvoie une plage en 2D, qui comprend les propriétés de police, de remplissage, de bordures, d’alignement, etc. de la plage.

getCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions): OfficeExtension.ClientResult<CellProperties[][]>;

Paramètres

cellPropertiesLoadOptions: Excel.CellPropertiesLoadOptions

Objet qui représente les propriétés de cellule à charger.

Retours

OfficeExtension.ClientResult<Excel.CellProperties[][]>

Tableau 2D où chaque élément représente les propriétés demandées de la cellule correspondante.

Remarques

[Jeu d’API : ExcelApi 1.9]

getColumn(column)

Obtient une colonne contenue dans la plage.

getColumn(column: number): Excel.Range;

Paramètres

column: number

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

Retours

Excel.Range

Remarques

[Jeu d’API : ExcelApi 1.1]

getColumnProperties(columnPropertiesLoadOptions)

Renvoie une plage à dimension unique, qui comprend les données de char colonne de police, de remplissage, de bordures, d’alignement, etc. de la plage. Pour les propriétés ne sont pas cohérentes au sein de chaque cellule dans une colonne donnée, null est renvoyé.

getColumnProperties(columnPropertiesLoadOptions: ColumnPropertiesLoadOptions): OfficeExtension.ClientResult<ColumnProperties[]>;

Paramètres

columnPropertiesLoadOptions: Excel.ColumnPropertiesLoadOptions

Objet qui représente les propriétés de colonne à charger.

Retours

OfficeExtension.ClientResult<Excel.ColumnProperties[]>

Un tableau où chaque élément représente les propriétés demandées de la colonne correspondante.

Remarques

[Jeu d’API : ExcelApi 1.9]

getColumnsAfter(count)

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

getColumnsAfter(count?: number): Excel.Range;

Paramètres

count: number

Facultatif. 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

Excel.Range

Remarques

[Jeu d’API : ExcelApi 1.2]

getColumnsBefore(count)

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

getColumnsBefore(count?: number): Excel.Range;

Paramètres

count: number

getDisplayedCellProperties(cellPropertiesLoadOptions: CellPropertiesLoadOptions): OfficeExtension.ClientResult<CellProperties[][]>;

Paramètres

cellPropertiesLoadOptions: Excel.CellPropertiesLoadOptions

Objet qui représente les propriétés de cellule à charger.

Retours

OfficeExtension.ClientResult<Excel.CellProperties[][]>

Un tableau 2D où chaque élément représente les propriétés d’affichage demandées de la cellule correspondante.

Remarques

[Jeu d’API : ExcelApi 1.19]

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

Retours

Excel.Range

Remarques

[Jeu d’API : ExcelApi 1.1]

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

Retours

Excel.Range

Remarques

[Jeu d’API : ExcelApi 1.1]

getExtendedRange(direction, activeCell)

Renvoie 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 d’Excel sur Windows.

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

Paramètres

direction: Excel.KeyboardDirection

Direction à partir de la cellule active.

activeCell: Excel.Range | string

Cellule active dans 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 n’est pas comprise dans cette plage.

Retours

Excel.Range

Remarques

[Jeu d’API : ExcelApi 1.13]

getExtendedRange(direction, activeCell)

Renvoie 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 d’Excel sur Windows.

getExtendedRange(direction: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range;

Paramètres

direction: "Left" | "Right" | "Up" | "Down"

Direction à partir de la cellule active.

activeCell: Excel.Range | string

Cellule active dans 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 n’est pas comprise dans cette plage.

Retours

Excel.Range

Remarques

[Jeu d’API : ExcelApi 1.13]

getImage()

Rend la plage sous la forme d’une image PNG codée en Base64.

getImage(): OfficeExtension.ClientResult<string>;

Retours

OfficeExtension.ClientResult<string>

Remarques

[Jeu d’API : ExcelApi 1.7]

getIntersection(anotherRange)

Obtient l’objet de plage qui représente l’intersection rectangulaire des plages données.

getIntersection(anotherRange: Range | string): Excel.Range;

Paramètres

anotherRange: Excel.Range | string

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

Retours

Excel.Range

Remarques

[Jeu d’API : ExcelApi 1.1]

getIntersectionOrNullObject(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 renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getIntersectionOrNullObject(anotherRange: Range | string): Excel.Range;

Paramètres

anotherRange: Excel.Range | string

getOffsetRange(rowOffset: number, columnOffset: number): Excel.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

Excel.Range

Remarques

[Jeu d’API : ExcelApi 1.1]

getPivotTables(fullyContained)

Obtient une collection étendue de tableaux croisés dynamiques qui chevauchent la plage.

getPivotTables(fullyContained?: boolean): Excel.PivotTableScopedCollection;

Paramètres

fullyContained: boolean

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

Retours

Excel.PivotTableScopedCollection

Remarques

[Jeu d’API : ExcelApi 1.12]

getPrecedents()

Renvoie un WorkbookRangeAreas objet qui représente la plage contenant toutes les cellules précédentes d’une plage spécifiée dans la même feuille de calcul ou dans plusieurs feuilles de calcul. Génère une ItemNotFound erreur si aucun précédent n’est trouvé.

getPrecedents(): Excel.WorkbookRangeAreas;

Retours

Excel.WorkbookRangeAreas

Remarques

[Jeu d’API : ExcelApi 1.14]

getRangeEdge(direction, activeCell)

Renvoie 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 de Ctrl+Touche de direction dans l’interface utilisateur d’Excel sur Windows.

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

Paramètres

direction: Excel.KeyboardDirection

Direction à partir de la cellule active.

activeCell: Excel.Range | string

Cellule active dans 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 n’est pas comprise dans cette plage.

Retours

Excel.Range

Remarques

[Jeu d’API : ExcelApi 1.13]

getRangeEdge(direction, activeCell)

Renvoie 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 de Ctrl+Touche de direction dans l’interface utilisateur d’Excel sur Windows.

getRangeEdge(direction: "Left" | "Right" | "Up" | "Down", activeCell?: Range | string): Excel.Range;

Paramètres

direction: "Left" | "Right" | "Up" | "Down"

Direction à partir de la cellule active.

activeCell: Excel.Range | string

Cellule active dans 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 n’est pas comprise dans cette plage.

Retours

Excel.Range

Remarques

[Jeu d’API : ExcelApi 1.13]

getResizedRange(deltaRows, deltaColumns)

Récupère un Range objet semblable à l’objet actuel Range , mais dont le coin inférieur droit est développé (ou réduit) d’un certain nombre de lignes et de colonnes.

getResizedRange(deltaRows: number, deltaColumns: number): Excel.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 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.

Retours

Excel.Range

Remarques

[Jeu d’API : ExcelApi 1.2]

getRow(row)

Obtient une ligne contenue dans la plage.

getRow(row: number): Excel.Range;

Paramètres

row: number

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

Retours

Excel.Range

Remarques

[Jeu d’API : ExcelApi 1.1]

getRowProperties(rowPropertiesLoadOptions)

Renvoie une plage à dimension unique , qui comprend les données de police, de remplissage, de bordures, d’alignement, etc. de la plage. Pour les propriétés qui ne sont pas cohérentes dans chaque cellule d’une ligne donnée, null sont retournées.

getRowProperties(rowPropertiesLoadOptions: RowPropertiesLoadOptions): OfficeExtension.ClientResult<RowProperties[]>;

Paramètres

rowPropertiesLoadOptions: Excel.RowPropertiesLoadOptions

Objet qui représente les propriétés de la ligne à charger.

Retours

OfficeExtension.ClientResult<Excel.RowProperties[]>

Un tableau où chaque élément représente les propriétés demandées de la ligne correspondante.

Remarques

[Jeu d’API : ExcelApi 1.9]

getRowsAbove(count)

Récupère un certain nombre de lignes au-dessus de l’objet actuel Range .

getRowsAbove(count?: number): Excel.Range;

Paramètres

count: number

Facultatif. 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

Excel.Range

Remarques

[Jeu d’API : ExcelApi 1.2]

getRowsBelow(count)

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

getRowsBelow(count?: number): Excel.Range;

Paramètres

count: number

Facultatif. 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

Excel.Range

Remarques

[Jeu d’API : ExcelApi 1.2]

getSpecialCells(cellType, cellValueType)

Obtient l’objet RangeAreas , comprenant une ou plusieurs plages rectangulaires, qui représente toutes les cellules correspondant au type et à la valeur spécifiés. Si aucune cellule spéciale n’est trouvée, une ItemNotFound erreur est générée.

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

Paramètres

cellType: Excel.SpecialCellType

Type de cellules à inclure.

cellValueType: Excel.SpecialCellValueType

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

Retours

Excel.RangeAreas

Remarques

[Jeu d’API : ExcelApi 1.9]

getSpecialCells(cellType, cellValueType)

Obtient l’objet RangeAreas , comprenant une ou plusieurs plages rectangulaires, qui représente toutes les cellules correspondant au type et à la valeur spécifiés. Si aucune cellule spéciale n’est trouvée, une ItemNotFound erreur est générée.

getSpecialCells(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

Paramètres

cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

Type de cellules à inclure.

cellValueType: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

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

Retours

Excel.RangeAreas

Remarques

[Jeu d’API : ExcelApi 1.9]

getSpecialCellsOrNullObject(cellType, cellValueType)

Récupère l’objet RangeAreas , comprenant une ou plusieurs plages, qui représente toutes les cellules correspondant au type et à la valeur spécifiés. Si aucune cellule spéciale n’est trouvée, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getSpecialCellsOrNullObject(cellType: Excel.SpecialCellType, cellValueType?: Excel.SpecialCellValueType): Excel.RangeAreas;

Paramètres

cellType: Excel.SpecialCellType

Type de cellules à inclure.

cellValueType: Excel.SpecialCellValueType

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

Retours

Excel.RangeAreas

Remarques

[Jeu d’API : ExcelApi 1.9]

getSpecialCellsOrNullObject(cellType, cellValueType)

Récupère l’objet RangeAreas , comprenant une ou plusieurs plages, qui représente toutes les cellules correspondant au type et à la valeur spécifiés. Si aucune cellule spéciale n’est trouvée, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getSpecialCellsOrNullObject(cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible", cellValueType?: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"): Excel.RangeAreas;

Paramètres

cellType: "ConditionalFormats" | "DataValidations" | "Blanks" | "Constants" | "Formulas" | "SameConditionalFormat" | "SameDataValidation" | "Visible"

Type de cellules à inclure.

cellValueType: "All" | "Errors" | "ErrorsLogical" | "ErrorsNumbers" | "ErrorsText" | "ErrorsLogicalNumber" | "ErrorsLogicalText" | "ErrorsNumberText" | "Logical" | "LogicalNumbers" | "LogicalText" | "LogicalNumbersText" | "Numbers" | "NumbersText" | "Text"

getTables(fullyContained?: boolean): Excel.TableScopedCollection;

Paramètres

fullyContained: boolean

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

Retours

Excel.TableScopedCollection

Remarques

[Jeu d’API : ExcelApi 1.9]

getUsedRange(valuesOnly)

Renvoie la plage utilisée d’un objet de plage donné. Si aucune cellule n’est utilisée dans la plage, cette fonction renvoie une ItemNotFound erreur.

getUsedRange(valuesOnly?: boolean): Excel.Range;

Paramètres

valuesOnly: boolean

Prend uniquement en compte les cellules avec des valeurs sous forme de cellules utilisées. [Jeu d’API : ExcelApi 1.2]

Retours

Excel.Range

Remarques

[Jeu d’API : ExcelApi 1.1]

getUsedRangeOrNullObject(valuesOnly)

Renvoie la plage utilisée d’un objet de plage donné. S’il n’y a pas de cellules utilisées dans la plage, cette méthode renvoie un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getUsedRangeOrNullObject(valuesOnly?: boolean): Excel.Range;

Paramètres

valuesOnly: boolean

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

Retours

Excel.Range

Remarques

[Jeu d’API : ExcelApi 1.4]

getVisibleView()

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

getVisibleView(): Excel.RangeView;

Retours

Excel.RangeView

Remarques

[Jeu d’API : ExcelApi 1.3]

group(groupOption)

Regroupe des colonnes et des lignes pour établir un plan.

group(groupOption: Excel.GroupOption): void;

Paramètres

groupOption: Excel.GroupOption

Spécifie la manière dont 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 isEntireColumn de isEntireRow la plage (c’est-à-dire qu’elle range.isEntireRow est vraie et groupOption qu’elle correspond à « ByColumns » ou range.isEntireColumn à true et groupOption qu’elle est « ByRows »).

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.10]

group(groupOption)

Regroupe des colonnes et des lignes pour établir un plan.

group(groupOption: "ByRows" | "ByColumns"): void;

Paramètres

groupOption: "ByRows" | "ByColumns"

Spécifie la manière dont 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 isEntireColumn de isEntireRow la plage (c’est-à-dire qu’elle range.isEntireRow est vraie et groupOption qu’elle correspond à « ByColumns » ou range.isEntireColumn à true et groupOption qu’elle est « ByRows »).

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.10]

hideGroupDetails(groupOption)

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

hideGroupDetails(groupOption: Excel.GroupOption): void;

Paramètres

groupOption: Excel.GroupOption

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

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.10]

hideGroupDetails(groupOption)

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

hideGroupDetails(groupOption: "ByRows" | "ByColumns"): void;

Paramètres

groupOption: "ByRows" | "ByColumns"

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

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.10]

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. Renvoie un nouvel Range objet à l’espace vide.

insert(shift: Excel.InsertShiftDirection): Excel.Range;

Paramètres

shift: Excel.InsertShiftDirection

Indique la façon dont les cellules doivent être décalées. Pour Excel.InsertShiftDirection plus de détails.

Retours

Excel.Range

Remarques

[Jeu d’API : ExcelApi 1.1]

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. Renvoie un nouvel Range objet à l’espace vide.

insert(shift: "Down" | "Right"): Excel.Range;

Paramètres

shift: "Down" | "Right"

Indique la façon dont les cellules doivent être décalées. Pour Excel.InsertShiftDirection plus de détails.

Retours

Excel.Range

Remarques

[Jeu d’API : ExcelApi 1.1]

load(options)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: Excel.Interfaces.RangeLoadOptions): Excel.Range;

Paramètres

options: Excel.Interfaces.RangeLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.Range

load(propertyNames)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): Excel.Range;

Paramètres

propertyNames: string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes spécifiant les propriétés à charger.

Retours

Excel.Range

load(propertyNamesAndPaths)

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Range;

Paramètres

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

Excel.Range

merge(across)

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

merge(across?: boolean): void;

Paramètres

across: boolean

Facultatif. Définir 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

Remarques

[Jeu d’API : ExcelApi 1.2]

moveTo(destinationRange)

Déplacement des valeurs de cellule, de la mise en forme et des formules de la plage actuelle vers la plage de destination, en remplaçant les anciennes informations de ces cellules. La plage de destination est développée automatiquement si elle est inférieure à la plage actuelle. Toutes 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. Remarque : lorsqu’une plage est déplacée vers une nouvelle adresse à l’aide de cette API, le nouvel objet de plage doit être récupéré à l’aide de la nouvelle adresse.

moveTo(destinationRange: Range | string): void;

Paramètres

destinationRange: Excel.Range | string

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

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.11]

removeDuplicates(columns, includesHeader)

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

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

Paramètres

columns: number[]

Colonnes à l’intérieur de la plage pouvant 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

Excel.RemoveDuplicatesResult

Objet résultant qui contient le nombre de lignes supprimées et le nombre de lignes uniques restantes.

Remarques

[Jeu d’API : ExcelApi 1.9]

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: Excel.ReplaceCriteria): OfficeExtension.ClientResult<number>;

Paramètres

text: string

Chaîne à trouver.

replacement: string

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

criteria: Excel.ReplaceCriteria

Critères de remplacement supplémentaires.

Retours

OfficeExtension.ClientResult<number>

Nombre de remplacements effectués.

Remarques

[Jeu d’API : ExcelApi 1.9]

select()

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

select(): void;

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.1]

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties: Interfaces.RangeUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties: Excel.Interfaces.RangeUpdateData

Objet JavaScript dont les propriétés sont structurées de façon isomorphe par rapport aux propriétés de l’objet sur lequel la méthode est appelée.

options: OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet de propriétés tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.Range): void;

Paramètres

properties: Excel.Range

Retours

void

setCellProperties(cellPropertiesData)

Mises à jour de la plage sur la base d’un tableau 2D de propriétés de cellule, encapsulant des éléments tels que la police, le remplissage, les bordures et l’alignement.

setCellProperties(cellPropertiesData: SettableCellProperties[][]): void;

Paramètres

cellPropertiesData: Excel.SettableCellProperties[][]

Tableau 2D qui représente les propriétés à définir dans chaque cellule.

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.9]

setColumnProperties(columnPropertiesData)

Mises à jour de la plage sur la base d’un tableau unidimensionnel de propriétés de colonne, encapsulant des éléments tels que la police, le remplissage, les bordures et l’alignement.

setColumnProperties(columnPropertiesData: SettableColumnProperties[]): void;

Paramètres

columnPropertiesData: Excel.SettableColumnProperties[]

Tableau qui représente les propriétés à définir dans chaque colonne.

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.9]

setDirty()

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

setDirty(): void;

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.9]

setRowProperties(rowPropertiesData)

Mises à jour de la plage sur la base d’un tableau unidimensionnel de propriétés de ligne, encapsulant des éléments tels que la police, le remplissage, les bordures et l’alignement.

setRowProperties(rowPropertiesData: SettableRowProperties[]): void;

Paramètres

rowPropertiesData: Excel.SettableRowProperties[]

Tableau qui représente les propriétés à définir dans chaque ligne.

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.9]

showCard()

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

showCard(): void;

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.7]

showGroupDetails(groupOption)

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

showGroupDetails(groupOption: Excel.GroupOption): void;

Paramètres

groupOption: Excel.GroupOption

Indique si les détails des lignes ou des colonnes groupées doivent être affichés.

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.10]

showGroupDetails(groupOption)

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

showGroupDetails(groupOption: "ByRows" | "ByColumns"): void;

Paramètres

groupOption: "ByRows" | "ByColumns"

Indique si les détails des lignes ou des colonnes groupées doivent être affichés.

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.10]

toJSON()

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.Range est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.RangeDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.RangeData;

Retours

Excel.Interfaces.RangeData

track()

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet entre des .sync appels et en dehors de l’exécution séquentielle d’un lot « .run » et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous devez ajouter l’objet à la collection d’objets suivis lors de la création initiale de l’objet.

track(): Excel.Range;

Retours

Excel.Range

ungroup(groupOption)

Dissocie les colonnes et les lignes d’un plan.

ungroup(groupOption: Excel.GroupOption): void;

Paramètres

groupOption: Excel.GroupOption

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

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.10]

ungroup(groupOption)

Dissocie les colonnes et les lignes d’un plan.

ungroup(groupOption: "ByRows" | "ByColumns"): void;

Paramètres

groupOption: "ByRows" | "ByColumns"

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

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.10]

unmerge()

Annule la fusion de la plage de cellules.

unmerge(): void;

Retours

void

Remarques

[Jeu d’API : ExcelApi 1.2]

untrack()

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la libération de mémoire prenne effet.

untrack(): Excel.Range;

Retours

Excel.Range

Remarques

Propriétés

Méthodes

Détails de la propriété

address

Valeur de propriété

Remarques

addressLocal

Valeur de propriété

Remarques

cellCount

Valeur de propriété

Remarques

columnCount

Valeur de propriété

Remarques

columnHidden

Valeur de propriété

Remarques

columnIndex

Valeur de propriété

Remarques

conditionalFormats

Valeur de propriété

Remarques

context

Valeur de propriété

control

Valeur de propriété

Remarques

dataValidation

Valeur de propriété

Remarques

format

Valeur de propriété

Remarques

formulas

Valeur de propriété

Remarques

formulasLocal

Valeur de propriété

Remarques

formulasR1C1

Valeur de propriété

Remarques

hasSpill

Valeur de propriété

Remarques

height

Valeur de propriété

Remarques

hidden

Valeur de propriété

Remarques

hyperlink

Valeur de propriété

Remarques

isEntireColumn

Valeur de propriété

Remarques

isEntireRow

Valeur de propriété

Remarques

left

Valeur de propriété

Remarques

linkedDataTypeState

Valeur de propriété

Remarques

numberFormat

Valeur de propriété

Remarques

numberFormatCategories

Valeur de propriété

Remarques

numberFormatLocal

Valeur de propriété

Remarques

rowCount