Excel.NamedItemArrayValues class
Représente un objet contenant des valeurs et des types d’un élément nommé.
- Extends
Remarques
[ Ensemble d’API : ExcelApi 1.7 ]
Propriétés
| context | Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office. |
| types | Représente les types de chaque élément dans le tableau d’éléments nommés |
| values | Représente les valeurs de chaque élément dans le tableau élément nommé. |
| values |
Représentation JSON des valeurs de ce tableau d’éléments nommés. Contrairement à |
| values |
Représentation JSON des valeurs de ce tableau d’éléments nommés. Contrairement à |
Méthodes
| load(options) | Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| load(property |
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter |
| toJSON() | Remplace la méthode JavaScript |
Détails de la propriété
context
Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
context: RequestContext;Valeur de propriété
types
Représente les types de chaque élément dans le tableau d’éléments nommés
readonly types: Excel.RangeValueType[][];Valeur de propriété
Remarques
values
Représente les valeurs de chaque élément dans le tableau élément nommé.
readonly values: any[][];Valeur de propriété
any[][]
Remarques
valuesAsJson
Représentation JSON des valeurs de ce tableau d’éléments nommés. Contrairement à NamedItemArrayValues.values, NamedItemArrayValues.valuesAsJson 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 NamedItemArrayValues.valuesAsJsonLocal.
readonly valuesAsJson: CellValue[][];Valeur de propriété
Excel.CellValue[][]
Remarques
valuesAsJsonLocal
Représentation JSON des valeurs de ce tableau d’éléments nommés. Contrairement à NamedItemArrayValues.values, NamedItemArrayValues.valuesAsJsonLocal 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 NamedItemArrayValues.valuesAsJson.
readonly valuesAsJsonLocal: CellValue[][];Valeur de propriété
Excel.CellValue[][]
Remarques
Détails de la méthode
load(options)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(options?: Excel.Interfaces.NamedItemArrayValuesLoadOptions): Excel.NamedItemArrayValues;Paramètres
Fournit des options pour les propriétés de l’objet à charger.
Retours
load(propertyNames)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNames?: string | string[]): Excel.NamedItemArrayValues;Paramètres
- propertyNames
-
string | string[]
Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.
Retours
load(propertyNamesAndPaths)
Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.NamedItemArrayValues;Paramètres
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.
Retours
toJSON()
Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.NamedItemArrayValues est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.NamedItemArrayValuesDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
toJSON(): Excel.Interfaces.NamedItemArrayValuesData;