Excel.Interfaces.RangeLoadOptions interface

Paquet:

excel

Range représente un ensemble d’une ou plusieurs cellules contiguës telles qu’une cellule, une ligne, une colonne ou un bloc de cellules. Pour en savoir plus sur l’utilisation des plages dans l’ensemble de l’API, commencez par Plages dans l’API JavaScript Excel.

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Propriétés

$all	La spécification des options de $all 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 d’adresse contient la référence de la feuille (par exemple, « Sheet1 ! 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	Représente si toutes les colonnes de la plage actuelle sont masquées. La valeur est true lorsque toutes les colonnes d’une plage sont masquées. La valeur est quand aucune colonne de la plage n’est false masquée. La valeur est null lorsque certaines colonnes d’une plage sont masquées et que d’autres colonnes de la même plage ne sont pas masquées.
columnIndex	Spécifie le numéro de colonne de la première cellule de la plage. Avec indice zéro.
control	Accède au contrôle de cellule appliqué à cette plage. Si la plage a plusieurs contrôles de cellule, cette propriété retourne EmptyCellControl.
dataValidation	Renvoie un objet de validation des données.
format	Renvoie un objet de format, encapsulant 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 retourné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 retourné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 retourné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éversement, ou false si toutes les cellules n’ont pas de bordure de déversement. Retourne null s’il existe des cellules avec et sans bordures de déversement dans la plage.
height	Retourne la distance en points, pour un zoom à 100 %, entre le bord supérieur de la plage et le bord inférieur de la plage.
hidden	Représente si toutes les cellules de la plage actuelle sont masquées. La valeur est true lorsque toutes les cellules d’une plage sont masquées. La valeur est quand aucune cellule de la plage n’est false masquée. La valeur est null lorsque certaines cellules d’une plage sont masquées et que d’autres cellules de la même plage ne sont pas masquées.
hyperlink	Représente le lien hypertexte pour la plage actuelle.
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	Retourne la distance en points, pour un zoom à 100 %, entre le bord gauche de la feuille de calcul et le bord gauche de la plage.
linkedDataTypeState	Représente l’état du type de données de chaque cellule.
numberFormat	Représente le code de format numérique d’Excel pour la plage donnée. Pour plus d’informations sur la mise en forme des nombres Excel, consultez Codes de format de nombre.
numberFormatCategories	Représente la catégorie de format numérique de chaque cellule.
numberFormatLocal	Représente le code de format numérique d’Excel pour la plage donnée, en fonction des paramètres de langue de l’utilisateur. Excel n’effectue aucune contrainte de langage ou de mise en forme lors de l’obtention ou de la définition de la numberFormatLocal propriété. Tout texte retourné utilise les chaînes mises en forme localement en fonction de la langue spécifiée dans les paramètres système.
rowCount	Renvoie le nombre total de lignes de la plage.
rowHidden	Représente si toutes les lignes de la plage actuelle sont masquées. La valeur est true lorsque toutes les lignes d’une plage sont masquées. La valeur est quand aucune ligne de la plage n’est false masquée. La valeur est null lorsque certaines lignes d’une plage sont masquées et que d’autres lignes de la même plage ne sont pas masquées.
rowIndex	Renvoie le numéro de ligne de la première cellule de la plage. Avec indice zéro.
savedAsArray	Représente si toutes les cellules doivent être enregistrées sous forme de formule matricielle. Retourne true si toutes les cellules sont enregistrées en tant que formule matricielle, ou false si toutes les cellules ne sont pas enregistrées en tant que formule matricielle. Renvoie null si certaines cellules sont enregistrées en tant que formule matricielle et que d’autres ne le sont pas.
style	Représente le style de la plage actuelle. Si les styles des cellules sont incohérents, null est retourné. Pour les styles personnalisés, le nom du style est retourné. Pour les styles intégrés, une chaîne représentant une valeur dans l’énumération BuiltInStyle est retournée.
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 numérique (#) qui se produit dans l’interface utilisateur Excel n’affecte pas la valeur de texte retournée par l’API.
top	Retourne la distance en points, pour un zoom à 100 %, entre le bord supérieur de la feuille de calcul et le bord supérieur de la plage.
values	Représente les valeurs brutes de la plage spécifiée. Les données retournées peuvent être une chaîne, un nombre ou une valeur booléenne. Les cellules contenant une erreur renvoie la chaîne d’erreur. Si la valeur retournée commence par un signe plus (« + »), moins (« - ») ou égal (« = »), Excel interprète cette valeur comme une formule.
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 qui peuvent se trouver dans une cellule. Les exemples incluent les valeurs numériques mises en forme et les images web, en plus des valeurs booléennes, numériques et de chaînes standard. Les données retournées par cette API s’alignent toujours sur les paramètres régionaux en-US. 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 qui peuvent se trouver dans une cellule. Les exemples incluent les valeurs numériques mises en forme et les images web, en plus des valeurs booléennes, numériques et de chaînes standard. Les données retourné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	Retourne la distance en points, pour un zoom de 100 %, entre le bord gauche de la plage et le bord droit de la plage.
worksheet	Feuille de calcul contenant la plage.

Détails de la propriété

$all

La spécification des options de $all 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 d’adresse contient la référence de la feuille (par exemple, « Sheet1 ! A1 :B4").

address?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble 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

[ Ensemble 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

[ Ensemble d’API : ExcelApi 1.1 ]

columnCount

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

columnCount?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

columnHidden

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

columnHidden?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble 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

[ Ensemble d’API : ExcelApi 1.1 ]

control

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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

control?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

dataValidation

Renvoie un objet de validation des données.

dataValidation?: Excel.Interfaces.DataValidationLoadOptions;

Valeur de propriété

Excel.Interfaces.DataValidationLoadOptions

Remarques

[ Ensemble d’API : ExcelApi 1.8 ]

format

Renvoie un objet de format, encapsulant 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é

Excel.Interfaces.RangeFormatLoadOptions

Remarques

[ Ensemble 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 retournée à la place.

formulas?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble 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 retournée à la place.

formulasLocal?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble 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 retournée à la place.

formulasR1C1?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble 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éversement, ou false si toutes les cellules n’ont pas de bordure de déversement. Retourne null s’il existe des cellules avec et sans bordures de déversement dans la plage.

hasSpill?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.12 ]

height

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

height?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

hidden

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

hidden?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.2 ]

hyperlink

Représente le lien hypertexte pour la plage actuelle.

hyperlink?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble 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

[ Ensemble 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

[ Ensemble d’API : ExcelApi 1.7 ]

left

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

left?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

linkedDataTypeState

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

linkedDataTypeState?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.9 ]

numberFormat

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

numberFormat?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

numberFormatCategories

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

numberFormatCategories?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.12 ]

numberFormatLocal

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

numberFormatLocal?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

rowCount

Renvoie le nombre total de lignes de la plage.

rowCount?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

rowHidden

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

rowHidden?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble 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

[ Ensemble d’API : ExcelApi 1.1 ]

savedAsArray

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

savedAsArray?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.12 ]

style

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

style?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble 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 numérique (#) 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

[ Ensemble d’API : ExcelApi 1.1 ]

top

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

top?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

values

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

values?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble 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 qui peuvent se trouver dans une cellule. Les exemples incluent les valeurs numériques mises en forme et les images web, en plus des valeurs booléennes, numériques et de chaînes standard. Les données retournées par cette API s’alignent toujours sur les paramètres régionaux en-US. 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

[ Ensemble 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 qui peuvent se trouver dans une cellule. Les exemples incluent les valeurs numériques mises en forme et les images web, en plus des valeurs booléennes, numériques et de chaînes standard. Les données retourné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

[ Ensemble d’API : ExcelApi 1.16 ]

valueTypes

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

valueTypes?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

width

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

width?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

worksheet

Feuille de calcul contenant la plage.

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Valeur de propriété

Excel.Interfaces.WorksheetLoadOptions

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]