Excel.Interfaces.NamedItemLoadOptions interface

Représente un nom défini pour une plage de cellules ou une valeur. Les noms peuvent être des objets nommés primitifs (comme dans le type ci-dessous), un objet de plage ou une référence à une plage. Cet objet peut être utilisé pour obtenir l’objet de plage associé à des noms.

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

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 renvoyée par la formule du nom. Pour Excel.NamedItemType plus de détails.

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.

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.

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.

visible

Indique si l’objet est visible.

worksheet

Renvoie la feuille de calcul dans laquelle est inclus l’élément nommé. Génère une erreur si l’élément est limité au classeur à la place.

worksheetOrNullObject

Renvoie la feuille de calcul dans laquelle l’élément nommé est étendu. Si l’élément est plutôt limité au classeur, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

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

arrayValues

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

arrayValues?: Excel.Interfaces.NamedItemArrayValuesLoadOptions;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.7

comment

Spécifie le commentaire associé à ce nom.

comment?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.4

formula

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

formula?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.7

name

Nom de l’objet.

name?: boolean;

Valeur de propriété

boolean

Remarques

Jeu 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?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.4

type

Spécifie le type de la valeur renvoyée par la formule du nom. Pour Excel.NamedItemType plus de détails.

type?: boolean;

Valeur de propriété

boolean

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

Valeur de propriété

boolean

Remarques

Jeu 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 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?: boolean;

Valeur de propriété

boolean

Remarques

Jeu 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 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?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.16

visible

Indique si l’objet est visible.

visible?: boolean;

Valeur de propriété

boolean

Remarques

Jeu d’API : ExcelApi 1.1

worksheet

Renvoie la feuille de calcul dans laquelle est inclus l’élément nommé. Génère une erreur si l’élément est limité au classeur à la place.

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.4

worksheetOrNullObject

Renvoie la feuille de calcul dans laquelle l’élément nommé est étendu. Si l’élément est plutôt limité au classeur, cette méthode renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

worksheetOrNullObject?: Excel.Interfaces.WorksheetLoadOptions;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.4