Excel.NamedItem class

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

readonly arrayValues: Excel.NamedItemArrayValues;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.7]

Spécifie le commentaire associé à ce nom.

comment: string;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.4]

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

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

formula: any;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.7]

Nom de l’objet.

readonly name: string;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.1]

Spécifie si le nom est limité au classeur ou à une feuille de calcul spécifique. Les valeurs possibles sont : Feuille de calcul, Classeur.

readonly scope: Excel.NamedItemScope | "Worksheet" | "Workbook";

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.4]

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

readonly type: Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array";

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.1 pour chaîne, entier, double, booléen, plage, erreur ; 1.7 pour le tableau]

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.

readonly value: any;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.1]

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.

readonly valueAsJson: CellValue | string;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.16]

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.

readonly valueAsJsonLocal: CellValue | string;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.16]

Indique si l’objet est visible.

visible: boolean;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.1]

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.

readonly worksheet: Excel.Worksheet;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.4]

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.

readonly worksheetOrNullObject: Excel.Worksheet;

Valeur de propriété

Remarques

[Jeu d’API : ExcelApi 1.4]

Supprime le nom donné.

delete(): void;

Retours

Remarques

[Jeu d’API : ExcelApi 1.4]

Renvoie l’objet de plage qui est associé au nom. Renvoie une erreur si le type de l’élément nommé n’est pas une plage.

getRange(): Excel.Range;

Retours

Remarques

[Jeu d’API : ExcelApi 1.1]

Renvoie l’objet de plage qui est associé au nom. Si le type de l’élément nommé n’est pas une plage, 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.

getRangeOrNullObject(): Excel.Range;

Retours

Remarques

[Jeu d’API : ExcelApi 1.4]

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.NamedItemLoadOptions): Excel.NamedItem;

Paramètres

Retours

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.NamedItem;

Paramètres

Retours

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.NamedItem;

Paramètres

Retours

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties: Interfaces.NamedItemUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

Retours

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.NamedItem): void;

Paramètres

Retours

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine Excel.NamedItem est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) Excel.Interfaces.NamedItemDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.NamedItemData;

Retours