Excel.Interfaces.NamedItemData interface
Interface décrivant les données renvoyées en appelant namedItem.toJSON().
Propriétés
| array |
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 renvoyée par la formule du nom. Pour |
| value | Représente la valeur calculée par la formule du nom. Pour une plage nommée, l’adresse de la plage est renvoyée. Cette API renvoie la #VALUE ! dans l’interface utilisateur Excel s’il fait référence à une fonction définie par l’utilisateur. |
| value |
Représentation JSON des valeurs de cet élément nommé. Contrairement à |
| value |
Représentation JSON des valeurs de cet élément nommé. Contrairement à |
| visible | Indique 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
comment
Spécifie le commentaire associé à ce nom.
comment?: string;Valeur de propriété
string
Remarques
formula
Formule de l’élément nommé. Les formules commencent toujours par un signe égal (« = »).
formula?: any;Valeur de propriété
any
Remarques
name
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
type
Spécifie le type de la valeur renvoyée par la formule du nom. Pour Excel.NamedItemType plus de détails.
type?: Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array";Valeur de propriété
Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array"
Remarques
Jeu d’API : ExcelApi 1.1 pour chaîne, entier, double, booléen, plage, erreur ; 1.7 pour Array
value
Représente la valeur calculée par la formule du nom. Pour une plage nommée, l’adresse de la plage est renvoyée. Cette API renvoie la #VALUE ! dans l’interface utilisateur Excel s’il fait référence à une fonction définie par l’utilisateur.
value?: any;Valeur de propriété
any
Remarques
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 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 NamedItem.valueAsJsonLocal.
valueAsJson?: CellValue | string;Valeur de propriété
Excel.CellValue | string
Remarques
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 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 NamedItem.valueAsJson.
valueAsJsonLocal?: CellValue | string;Valeur de propriété
Excel.CellValue | string
Remarques
visible
Indique si l’objet est visible.
visible?: boolean;Valeur de propriété
boolean