Type de ressource workbookRange
Espace de noms: microsoft.graph
Importante
Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .
Représente un ensemble d’une ou plusieurs cellules contiguës dans un classeur, comme une cellule, une ligne, une colonne ou un bloc de cellules.
Méthodes
| Méthode | Type renvoyé | Description |
|---|---|---|
| Obtenir | workbookRange | Lire les propriétés et les relations d’un objet de plage. |
| Mettre à jour | workbookRange | Mettre à jour un objet de plage. |
| Supprimer | Aucune | Supprimez les cellules associées à la plage. |
| Effacer | Aucun | Effacez les valeurs de plage, le format, le remplissage ou la bordure. |
| Get boundingrect | workbookRange | Obtient le plus petit objet de plage qui englobe les plages données. Par exemple, la valeur GetBoundingRect pour « B2:C5 » et « D10:E15 » est « B2:E16 ». |
| Obtenir une cellule | workbookRange | Obtient l’objet de plage contenant la cellule unique en fonction des numéros de ligne et de colonne. La cellule peut se trouver en dehors des limites de sa plage parente, tant qu’elle reste dans la grille de feuille de calcul. L’emplacement de la cellule renvoyée est déterminé à partir de la cellule supérieure gauche de la plage. |
| Obtenir la colonne | workbookRange | Obtient une colonne contenue dans la plage. |
| Obtenir des colonnes après | workbookRangeView | Obtenez des colonnes à droite de la plage donnée. |
| Obtenir des colonnes avant | workbookRangeView | Obtenez des colonnes à gauche de la plage donnée. |
| Obtenir la colonne entière | workbookRange | Obtient un objet qui représente la colonne entière de la plage. |
| Obtenir la ligne entière | workbookRange | Obtient un objet qui représente la ligne entière de la plage. |
| Obtenir l’intersection | workbookRange | Obtient l’objet de plage qui représente l’intersection rectangulaire des plages données. |
| Obtenir la dernière cellule | workbookRange | Obtenez la dernière cellule dans la plage. Par exemple, la dernière cellule de la plage « B2:D5 » est « D5 ». |
| Obtenir la dernière colonne | workbookRange | Obtenez la dernière colonne de la plage. Par exemple, la dernière colonne de la plage « B2:D5 » est « D2:D5 ». |
| Obtenir la dernière ligne | workbookRange | Obtient la dernière ligne de la plage. Par exemple, la dernière ligne de la plage « B2:D5 » est « B5:D5 ». |
| Obtenir la plage de décalages | workbookRange | Obtient un objet qui représente une plage décalée par rapport à la plage spécifiée. La dimension de la plage retournée correspond à cette plage. Si la plage obtenue se retrouve en dehors des limites de la grille de la feuille de calcul, une exception est déclenchée. |
| Obtenir une plage redimensionnée | workbookRangeView | Obtenez un objet de plage similaire à l’objet de plage actuel, mais avec son coin inférieur droit développé (ou contracté) par un certain nombre de lignes et de colonnes. |
| Obtenir une ligne | workbookRange | Obtenir une ligne contenue dans la plage. |
| Obtenir les lignes au-dessus | workbookRangeView | Obtenez des lignes au-dessus d’une plage donnée. |
| Obtenir les lignes ci-dessous | workbookRangeView | Obtenez des lignes sous une plage donnée. |
| Obtenir une plage utilisée | workbookRange | Retourne la plage utilisée de l’objet de plage donné. |
| Obtenir une vue visible | workbookRangeView | Obtient la plage visible à partir d’une plage filtrée. |
| Insérer la plage | workbookRange | Insérez une cellule ou une plage de cellules dans la feuille de calcul à la place de cette plage, puis déplacez les autres cellules pour faire de l’espace. Renvoie un nouvel objet Range dans l’espace vide qui s’est créé. |
| Fusionner | Aucun | Fusionne la plage de cellules dans une zone de la feuille de calcul. |
| Annuler la fusion | Aucun | Annule la fusion de la plage de cellules. |
Propriétés
| Propriété | Type | Description |
|---|---|---|
| address | string | Représente la référence de plage dans le style A1. La valeur d’adresse contient la référence de feuille (par exemple, Sheet1 ! A1 :B4). En lecture seule. |
| addressLocal | string | Représente la référence de la plage spécifiée dans le langage de l’utilisateur. En lecture seule. |
| cellCount | int | Nombre de cellules dans la plage. En lecture seule. |
| columnCount | int | Représente le nombre total de colonnes dans la plage. En lecture seule. |
| columnHidden | Valeur booléenne | Indique si toutes les colonnes de la plage actuelle sont masquées. |
| columnIndex | int | Représente le numéro de colonne de la première cellule de la plage. Avec indice zéro. En lecture seule. |
| formulas | Json | Représente la formule dans le style de notation A1. |
| formulasLocal | Json | 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. |
| formulasR1C1 | Json | Représente la formule dans le style de notation R1C1. |
| hidden | Valeur booléenne | Indique si toutes les cellules de la plage active sont masquées. En lecture seule. |
| numberFormat | Json | Représente le code de format de nombre d’Excel pour une cellule donnée. |
| rowCount | int | Renvoie le nombre total de lignes de la plage. En lecture seule. |
| rowHidden | Valeur booléenne | Indique si toutes les lignes de la plage actuelle sont masquées. |
| rowIndex | int | Renvoie le numéro de ligne de la première cellule de la plage. Avec indice zéro. En lecture seule. |
| text | Json | 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 # qui se produit dans l’interface utilisateur Excel n’affecte pas la valeur de texte retournée par l’API. En lecture seule. |
| valueTypes | string | Représente le type de données de chaque cellule. Les valeurs possibles sont Unknown, Empty, String, Integer, Double, Boolean, Error. En lecture seule. |
| values | Json | Représente les valeurs brutes de la plage spécifiée. Les données retournées peuvent être de type chaîne, nombre ou booléen. La cellule qui contient une erreur retourne la chaîne d’erreur. |
Relations
| Relation | Type | Description |
|---|---|---|
| format | WorkbookRangeFormat | Renvoie un objet de format, encapsulant la police, le remplissage, les bordures, l’alignement et d’autres propriétés de la plage. En lecture seule. |
| tri | WorkbookRangeSort | Feuille de calcul contenant la plage. En lecture seule. |
| worksheet | WorkbookWorksheet | Feuille de calcul contenant la plage. En lecture seule. |
Représentation JSON
La représentation JSON suivante montre le type de ressource.
{
"id": "string",
"address": "string",
"addressLocal": "string",
"cellCount": 1024,
"columnCount": 1024,
"columnHidden": true,
"columnIndex": 1024,
"formulas": "Json",
"formulasLocal": "Json",
"formulasR1C1": "Json",
"hidden": true,
"numberFormat": "Json",
"rowCount": 1024,
"rowHidden": true,
"rowIndex": 1024,
"text": "Json",
"valueTypes": "string",
"values": "json"
}