Excel.Interfaces.RangeData interface

Interface décrivant les données renvoyées en appelant range.toJSON().

Remarques

Utilisateur

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.

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.

formulaArray

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

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.

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.

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.

Détails de la propriété

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?: 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.

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

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.

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.

columnIndex?: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.1

conditionalFormats

La collection de ConditionalFormats qui recoupe la gamme.

conditionalFormats?: Excel.Interfaces.ConditionalFormatData[];

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.6

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é

Remarques

Jeu d’API : ExcelApi 1.18

dataValidation

Renvoie un objet de validation des données.

dataValidation?: Excel.Interfaces.DataValidationData;

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.RangeFormatData;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.1

formulaArray

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

Valeur de propriété

string

Remarques

Jeu d’API : ExcelApiDesktop 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.

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.

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.

hidden?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.2

Représente le lien hypertexte de la plage active.

hyperlink?: Excel.RangeHyperlink;

Valeur de propriété

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

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.

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.

linkedDataTypeState?: Excel.LinkedDataTypeState[][];

Valeur de propriété

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.

numberFormatCategories?: Excel.NumberFormatCategory[][];

Valeur de propriété

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.

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.

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.

savedAsArray?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.12

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.

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.

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.

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é

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é

Remarques

Jeu d’API : ExcelApi 1.16

valueTypes

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

valueTypes?: Excel.RangeValueType[][];

Valeur de propriété

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.

width?: number;

Valeur de propriété

number

Remarques

Jeu d’API : ExcelApi 1.10