Excel.NamedItemArrayValues class

  • Référence
Paquet:
excel

Représente un objet contenant des valeurs et des types d’un élément nommé.

Extends
OfficeExtension.ClientObject

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

Méthodes

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(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(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.
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 Excel.NamedItemArrayValues d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Excel.Interfaces.NamedItemArrayValuesDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

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é

Excel.RequestContext

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é

Excel.RangeValueType[][]

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

values

Représente les valeurs de chaque élément dans le tableau élément nommé.

readonly values: any[][];

Valeur de propriété

any[][]

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

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

[ Ensemble d’API : ExcelApi 1.16 ]

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

[ Ensemble d’API : ExcelApi 1.16 ]

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

options
Excel.Interfaces.NamedItemArrayValuesLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

Excel.NamedItemArrayValues

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

Excel.NamedItemArrayValues

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

Excel.NamedItemArrayValues

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 Excel.NamedItemArrayValues d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant Excel.Interfaces.NamedItemArrayValuesDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.NamedItemArrayValuesData;

Retours

Excel.Interfaces.NamedItemArrayValuesData