Excel.Interfaces.RangeCollectionLoadOptions interface

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

Pour CHAQUE ÉLÉMENT DE la collection : 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

Pour CHAQUE ÉLÉMENT de la collection : Représente la référence de plage pour la plage spécifiée dans la langue de l’utilisateur.

cellCount

Pour CHAQUE ÉLÉMENT de la collection : Spécifie le nombre de cellules de la plage. Cette API renvoie -1 si le nombre de cellules est supérieur à 2^31-1 (2 147 483 647).

columnCount

Pour CHAQUE ÉLÉMENT de la collection : Spécifie le nombre total de colonnes de la plage.

columnHidden

Pour CHAQUE ÉLÉMENT de la collection : 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

Pour CHAQUE ÉLÉMENT de la collection : Spécifie le numéro de colonne de la première cellule de la plage. Avec indice zéro.

control

Pour CHAQUE ÉLÉMENT de la collection : Accède au contrôle de cellule appliqué à cette plage. Si la plage comporte plusieurs contrôles de cellule, .EmptyCellControl

dataValidation

Pour CHAQUE ÉLÉMENT de la collection : Renvoie un objet de validation des données.

format

Pour CHAQUE ÉLÉMENT de la collection : 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.

formulaArray

Pour CHAQUE ÉLÉMENT de la collection : Spécifie la formule de tableau d’une plage. Si la plage spécifiée ne contient pas de formule de tableau, cette propriété renvoie null.

formulas

Pour CHAQUE ÉLÉMENT de la collection : Représente la formule en notation de style A1. Si une cellule n’a pas de formule, sa valeur est renvoyée à la place.

formulasLocal

Pour CHAQUE ÉLÉMENT de la collection : Représente la formule en notation de style A1, dans la langue de l’utilisateur et les paramètres régionaux de mise en forme du nombre. 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

Pour CHAQUE ÉLÉMENT de la collection : Représente la formule en notation de style R1C1. Si une cellule n’a pas de formule, sa valeur est renvoyée à la place.

hasSpill

Pour CHAQUE ÉLÉMENT de la collection : Indique si toutes les cellules ont une bordure de débordement. 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

Pour CHAQUE ÉLÉMENT de la collection : 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

Pour CHAQUE ÉLÉMENT de la collection : 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

Pour CHAQUE ÉLÉMENT de la collection : représente le lien hypertexte de la plage actuelle.

isEntireColumn

Pour CHAQUE ÉLÉMENT de la collection : Indique si la plage actuelle est une colonne entière.

isEntireRow

Pour CHAQUE ÉLÉMENT de la collection : indique si la plage actuelle est une ligne entière.

left

Pour CHAQUE ÉLÉMENT de la collection : 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

Pour CHAQUE ÉLÉMENT de la collection : Représente l’état de type de données de chaque cellule.

numberFormat

Pour CHAQUE ÉLÉMENT de la collection : 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

Pour CHAQUE ÉLÉMENT de la collection : Représente la catégorie de format de nombre de chaque cellule.

numberFormatLocal

Pour CHAQUE ÉLÉMENT de la collection : Représente le code de format de nombre d’Excel pour la 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

Pour CHAQUE ÉLÉMENT de la collection : renvoie le nombre total de lignes de la plage.

rowHidden

Pour CHAQUE ÉLÉMENT de la collection : 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

Pour CHAQUE ÉLÉMENT de la collection : renvoie le numéro de ligne de la première cellule de la plage. Avec indice zéro.

savedAsArray

Pour CHAQUE ÉLÉMENT de la collection : Indique si toutes les cellules sont enregistrées sous forme de 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.

style

Pour CHAQUE ARTICLE de la collection : Représente le style de la gamme 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

Pour CHAQUE ÉLÉMENT de la collection : 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

Pour CHAQUE ÉLÉMENT de la collection : 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

Pour CHAQUE ÉLÉMENT de la collection : 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.

valuesAsJson

Pour CHAQUE ÉLÉMENT de la collection : 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

Pour CHAQUE ÉLÉMENT de la collection : 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

Pour CHAQUE ÉLÉMENT de la collection : Spécifie le type de données dans chaque cellule.

width

Pour CHAQUE ÉLÉMENT de la collection : renvoie la distance en points, pour un zoom de 100 %, du bord gauche de la plage au bord droit de la plage.

worksheet

Pour CHAQUE ÉLÉMENT de la collection : feuille de calcul contenant la plage actuelle.

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

Pour CHAQUE ÉLÉMENT DE la collection : 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

Pour CHAQUE ÉLÉMENT de la collection : 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

Pour CHAQUE ÉLÉMENT de la collection : Spécifie le nombre de cellules de 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

Pour CHAQUE ÉLÉMENT de la collection : Spécifie le nombre total de colonnes de la plage.

columnCount?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.1

columnHidden

Pour CHAQUE ÉLÉMENT de la collection : 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

Pour CHAQUE ÉLÉMENT de la collection : 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

control

Pour CHAQUE ÉLÉMENT de la collection : Accède au contrôle de cellule appliqué à cette plage. Si la plage comporte plusieurs contrôles de cellule, .EmptyCellControl

control?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.18

dataValidation

Pour CHAQUE ÉLÉMENT de la collection : Renvoie un objet de validation des données.

dataValidation?: Excel.Interfaces.DataValidationLoadOptions;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9

format

Pour CHAQUE ÉLÉMENT de la collection : 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.9

formulaArray

Pour CHAQUE ÉLÉMENT de la collection : Spécifie la formule de tableau d’une plage. Si la plage spécifiée ne contient pas de formule de tableau, cette propriété renvoie null.

formulaArray?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApiDesktop 1.1

formulas

Pour CHAQUE ÉLÉMENT de la collection : Représente la formule en notation de style 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

Pour CHAQUE ÉLÉMENT de la collection : Représente la formule en notation de style A1, dans la langue de l’utilisateur et les paramètres régionaux de mise en forme du nombre. 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

Pour CHAQUE ÉLÉMENT de la collection : Représente la formule en notation de style 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

hasSpill

Pour CHAQUE ÉLÉMENT de la collection : Indique si toutes les cellules ont une bordure de débordement. 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.

hasSpill?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.12

height

Pour CHAQUE ÉLÉMENT de la collection : renvoie la distance en points, pour un zoom de 100 %, du bord supérieur de la plage au bord inférieur de la plage.

height?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.10

hidden

Pour CHAQUE ÉLÉMENT de la collection : 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

Pour CHAQUE ÉLÉMENT de la collection : représente le lien hypertexte de la plage actuelle.

hyperlink?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.7

isEntireColumn

Pour CHAQUE ÉLÉMENT de la collection : Indique si la plage actuelle est une colonne entière.

isEntireColumn?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.7

isEntireRow

Pour CHAQUE ÉLÉMENT de la collection : indique si la plage actuelle est une ligne entière.

isEntireRow?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.7

left

Pour CHAQUE ÉLÉMENT de la collection : renvoie la distance en points, pour un zoom de 100 %, du bord gauche de la feuille de calcul au bord gauche de la plage.

left?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.10

linkedDataTypeState

Pour CHAQUE ÉLÉMENT de la collection : Représente l’état de type de données de chaque cellule.

linkedDataTypeState?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.9

numberFormat

Pour CHAQUE ÉLÉMENT de la collection : 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

numberFormatCategories

Pour CHAQUE ÉLÉMENT de la collection : Représente la catégorie de format de nombre de chaque cellule.

numberFormatCategories?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.12

numberFormatLocal

Pour CHAQUE ÉLÉMENT de la collection : Représente le code de format de nombre d’Excel pour la 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

Pour CHAQUE ÉLÉMENT de la collection : renvoie le nombre total de lignes de la plage.

rowCount?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.1

rowHidden

Pour CHAQUE ÉLÉMENT de la collection : 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

Pour CHAQUE ÉLÉMENT de la collection : 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

savedAsArray

Pour CHAQUE ÉLÉMENT de la collection : Indique si toutes les cellules sont enregistrées sous forme de 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.

savedAsArray?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.12

style

Pour CHAQUE ARTICLE de la collection : Représente le style de la gamme 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

Pour CHAQUE ÉLÉMENT de la collection : 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

top

Pour CHAQUE ÉLÉMENT de la collection : 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.

top?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.10

values

Pour CHAQUE ÉLÉMENT de la collection : 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.

values?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.1

valuesAsJson

Pour CHAQUE ÉLÉMENT de la collection : 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?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.16

valuesAsJsonLocal

Pour CHAQUE ÉLÉMENT de la collection : 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?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.16

valueTypes

Pour CHAQUE ÉLÉMENT de la collection : Spécifie le type de données dans chaque cellule.

valueTypes?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.1

width

Pour CHAQUE ÉLÉMENT de la collection : renvoie la distance en points, pour un zoom de 100 %, du bord gauche de la plage au bord droit de la plage.

width?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.10

worksheet

Pour CHAQUE ÉLÉMENT de la collection : feuille de calcul contenant la plage actuelle.

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.9