Share via

Excel.Interfaces.NamedItemCollectionLoadOptions interface

  • Référence
Paquet:
excel

Collection de tous les NamedItem objets qui font partie du classeur ou de la feuille de calcul, selon la façon dont elle a été atteinte.

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Propriétés

$all

$all La spécification pour loadOptions charge toutes les propriétés scalaires (par exemple :Range.address ) mais pas les propriétés de navigation (par exemple : Range.format.fill.color).
arrayValues

Pour CHAQUE ÉLÉMENT de la collection : renvoie un objet contenant des valeurs et des types de l’élément nommé.
comment

Pour CHAQUE ÉLÉMENT de la collection : spécifie le commentaire associé à ce nom.
formula

Pour CHAQUE ÉLÉMENT de la collection : formule de l’élément nommé. Les formules commencent toujours par un signe égal (« = »).
name

Pour CHAQUE ÉLÉMENT de la collection : nom de l’objet.
scope

Pour CHAQUE ÉLÉMENT de la collection : 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

Pour CHAQUE ÉLÉMENT de la collection : spécifie le type de la valeur retournée par la formule du nom. Pour plus d’informations, consultez Excel.NamedItemType .
value

Pour CHAQUE ÉLÉMENT de la collection : 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

Pour CHAQUE ÉLÉMENT de la collection : 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

Pour CHAQUE ÉLÉMENT de la collection : 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

Pour CHAQUE ÉLÉMENT de la collection : spécifie si l’objet est visible.
worksheet

Pour CHAQUE ÉLÉMENT de la collection : retourne la feuille de calcul sur laquelle l’élément nommé est limité. Génère une erreur si l’élément est limité au classeur à la place.
worksheetOrNullObject

Pour CHAQUE ÉLÉMENT de la collection : retourne la feuille de calcul à laquelle l’élément nommé est limité. Si l’élément est limité au classeur à la place, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

Détails de la propriété

$all

$all La spécification pour loadOptions charge toutes les propriétés scalaires (par exemple :Range.address ) mais pas les propriétés de navigation (par exemple : Range.format.fill.color).

$all?: boolean;

Valeur de propriété

boolean

arrayValues

Pour CHAQUE ÉLÉMENT de la collection : renvoie un objet contenant des valeurs et des types de l’élément nommé.

arrayValues?: Excel.Interfaces.NamedItemArrayValuesLoadOptions;

Valeur de propriété

Excel.Interfaces.NamedItemArrayValuesLoadOptions

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

comment

Pour CHAQUE ÉLÉMENT de la collection : spécifie le commentaire associé à ce nom.

comment?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.4 ]

formula

Pour CHAQUE ÉLÉMENT de la collection : formule de l’élément nommé. Les formules commencent toujours par un signe égal (« = »).

formula?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

name

Pour CHAQUE ÉLÉMENT de la collection : nom de l’objet.

name?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

scope

Pour CHAQUE ÉLÉMENT de la collection : 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

[ Ensemble d’API : ExcelApi 1.4 ]

type

Pour CHAQUE ÉLÉMENT de la collection : spécifie le type de la valeur retournée par la formule du nom. Pour plus d’informations, consultez Excel.NamedItemType .

type?: boolean;

Valeur de propriété

boolean

Remarques

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

value

Pour CHAQUE ÉLÉMENT de la collection : 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?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

valueAsJson

Pour CHAQUE ÉLÉMENT de la collection : 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?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.16 ]

valueAsJsonLocal

Pour CHAQUE ÉLÉMENT de la collection : 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?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.16 ]

visible

Pour CHAQUE ÉLÉMENT de la collection : spécifie si l’objet est visible.

visible?: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

worksheet

Pour CHAQUE ÉLÉMENT de la collection : retourne la feuille de calcul sur laquelle l’élément nommé est limité. Génère une erreur si l’élément est limité au classeur à la place.

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Valeur de propriété

Excel.Interfaces.WorksheetLoadOptions

Remarques

[ Ensemble d’API : ExcelApi 1.4 ]

worksheetOrNullObject

Pour CHAQUE ÉLÉMENT de la collection : retourne la feuille de calcul à laquelle l’élément nommé est limité. Si l’élément est limité au classeur à la place, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

worksheetOrNullObject?: Excel.Interfaces.WorksheetLoadOptions;

Valeur de propriété

Excel.Interfaces.WorksheetLoadOptions

Remarques

[ Ensemble d’API : ExcelApi 1.4 ]