Excel.Interfaces.RangeLoadOptions interface

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

Utilisateur

Propriétés

$all

La spécification $all des options de chargement charge toutes les propriétés scalaires (telles que Range.address) mais pas les propriétés de navigation (telles que Range.format.fill.color).

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.

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.

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.

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.

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.

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.

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.

valueTypes

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

worksheet

Feuille de calcul contenant la plage.

Détails de la propriété

$all

La spécification $all des options de chargement charge toutes les propriétés scalaires (telles que Range.address) mais pas les propriétés de navigation (telles que Range.format.fill.color).

$all?: boolean;

Valeur de propriété

boolean

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

address?: boolean;

Valeur de propriété

boolean

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.

addressLocal?: boolean;

Valeur de propriété

boolean

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

cellCount?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.1

columnCount

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

columnCount?: boolean;

Valeur de propriété

boolean

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.

columnIndex?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.1

dataValidation

Renvoie un objet de validation des données.

dataValidation?: Excel.Interfaces.DataValidationLoadOptions;

Valeur de propriété

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.

format?: Excel.Interfaces.RangeFormatLoadOptions;

Valeur de propriété

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?: boolean;

Valeur de propriété

boolean

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?: boolean;

Valeur de propriété

boolean

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?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.2

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.

hidden?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.2

Représente le lien hypertexte de la plage active.

hyperlink?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.7

isEntireColumn

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

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.

isEntireRow?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.7

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?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.1

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?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.7

rowCount

Renvoie le nombre total de lignes de la plage.

rowCount?: boolean;

Valeur de propriété

boolean

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.

rowIndex?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.1

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?: boolean;

Valeur de propriété

boolean

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.

text?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.1

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?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.1

valueTypes

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

valueTypes?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.1

worksheet

Feuille de calcul contenant la plage.

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1