Partager via


Excel.Interfaces.NamedItemData interface

Interface décrivant les données retournées en appelant namedItem.toJSON().

Propriétés

arrayValues

Renvoie un objet contenant les valeurs et les types de l’élément nommé.

comment

Spécifie le commentaire associé à ce nom.

formula

Formule de l’élément nommé. Les formules commencent toujours par un signe égal (« = »).

name

Nom de l’objet.

scope

Spécifie si le nom est limité au classeur ou à une feuille de calcul spécifique. Les valeurs possibles sont : Feuille de calcul, Classeur.

type

Spécifie le type de la valeur retournée par la formule du nom. Pour plus d’informations, consultez Excel.NamedItemType .

value

Représente la valeur calculée par la formule du nom. Pour une plage nommée, elle renvoie l’adresse de la plage. Cette API retourne le #VALUE ! dans l’interface utilisateur Excel si elle fait référence à une fonction définie par l’utilisateur.

valueAsJson

Représentation JSON des valeurs de cet élément nommé. Contrairement à NamedItem.value, NamedItem.valueAsJson 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 NamedItem.valueAsJsonLocal.

valueAsJsonLocal

Représentation JSON des valeurs de cet élément nommé. Contrairement à NamedItem.value, NamedItem.valueAsJsonLocal 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 NamedItem.valueAsJson.

visible

Spécifie si l’objet est visible.

Détails de la propriété

arrayValues

Renvoie un objet contenant les valeurs et les types de l’élément nommé.

arrayValues?: Excel.Interfaces.NamedItemArrayValuesData;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

comment

Spécifie le commentaire associé à ce nom.

comment?: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.4 ]

formula

Formule de l’élément nommé. Les formules commencent toujours par un signe égal (« = »).

formula?: any;

Valeur de propriété

any

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

name

Nom de l’objet.

name?: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

scope

Spécifie si le nom est limité au classeur ou à une feuille de calcul spécifique. Les valeurs possibles sont : Feuille de calcul, Classeur.

scope?: Excel.NamedItemScope | "Worksheet" | "Workbook";

Valeur de propriété

Excel.NamedItemScope | "Worksheet" | "Workbook"

Remarques

[ Ensemble d’API : ExcelApi 1.4 ]

type

Spécifie le type de la valeur retournée par la formule du nom. Pour plus d’informations, consultez Excel.NamedItemType .

type?: Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array";

Valeur de propriété

Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array"

Remarques

[ Ensemble d’API : ExcelApi 1.1 for String,Integer,Double,Boolean,Range,Error ; 1.7 for Array ]

value

Représente la valeur calculée par la formule du nom. Pour une plage nommée, elle renvoie l’adresse de la plage. Cette API retourne le #VALUE ! dans l’interface utilisateur Excel si elle fait référence à une fonction définie par l’utilisateur.

value?: any;

Valeur de propriété

any

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

valueAsJson

Représentation JSON des valeurs de cet élément nommé. Contrairement à NamedItem.value, NamedItem.valueAsJson 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 NamedItem.valueAsJsonLocal.

valueAsJson?: CellValue | string;

Valeur de propriété

Excel.CellValue | string

Remarques

[ Ensemble d’API : ExcelApi 1.16 ]

valueAsJsonLocal

Représentation JSON des valeurs de cet élément nommé. Contrairement à NamedItem.value, NamedItem.valueAsJsonLocal 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 NamedItem.valueAsJson.

valueAsJsonLocal?: CellValue | string;

Valeur de propriété

Excel.CellValue | string

Remarques

[ Ensemble d’API : ExcelApi 1.16 ]

visible

Spécifie si l’objet est visible.

visible?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]