Partager via

Excel.NamedItem class

  • Référence
Paquet:
excel

Représente un nom défini pour une plage de cellules ou une valeur. Les noms peuvent être des objets nommés primitifs (comme indiqué 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.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/34-named-item/create-and-remove-named-item.yaml

await Excel.run(async (context) => {
    // Log all the named items in the active worksheet.
    const namedItems = context.workbook.worksheets.getActiveWorksheet().names.load();
    await context.sync();

    console.log("This worksheet contains " + namedItems.items.length + " named items.");

    for (let i = 0; i < namedItems.items.length; i++) {
        const namedItem : Excel.NamedItem = namedItems.items[i];
        console.log(JSON.stringify(namedItem)) + "\n";
    }

    await context.sync();
});

Propriétés

arrayValues

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

Spécifie le commentaire associé à ce nom.
context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
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 retournée par la formule du nom. Pour plus d’informations, consultez Excel.NamedItemType .
value

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

Spécifie 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

Retourne la feuille de calcul dans 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.

Méthodes

delete()

Supprime le nom donné.
getRange()

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

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 retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.
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.
set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
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.NamedItem est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant Excel.Interfaces.NamedItemDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

Détails de la propriété

arrayValues

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

readonly arrayValues: Excel.NamedItemArrayValues;

Valeur de propriété

Excel.NamedItemArrayValues

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

comment

Spécifie le commentaire associé à ce nom.

comment: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.4 ]

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

formula

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

formula: any;

Valeur de propriété

any

Remarques

[ Ensemble d’API : ExcelApi 1.7 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/34-named-item/update-named-item.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");

    // Get the named item
    const myNamedItem = sheet.names.getItemOrNullObject("MyRange");
    myNamedItem.load("name, formula");
    await context.sync();

    if (myNamedItem.isNullObject) {
        console.log(`There is no named item. Create it with "Add named item for a range" first.`);
    } else {                    
        // Update named item to point to the second range
        myNamedItem.formula = "=Sample!$B$10:$D$14";
        sheet.getRange("B10:D14").select();
        await context.sync();

        console.log(`Just updated the named item "${myNamedItem.name}" -- it's now located here: ${myNamedItem.formula}`);
    }
});

name

Nom de l’objet.

readonly name: string;

Valeur de propriété

string

Remarques

[ Ensemble 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.

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

Valeur de propriété

Excel.NamedItemScope | "Worksheet" | "Workbook"

Remarques

[ Ensemble d’API : ExcelApi 1.4 ]

type

Spécifie le type de la valeur retournée par la formule du nom. Pour plus d’informations, consultez Excel.NamedItemType .

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

Valeur de propriété

Excel.NamedItemType | "String" | "Integer" | "Double" | "Boolean" | "Range" | "Error" | "Array"

Remarques

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

value

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.

readonly value: any;

Valeur de propriété

any

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

visible

Spécifie si l’objet est visible.

visible: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble 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.

readonly worksheet: Excel.Worksheet;

Valeur de propriété

Excel.Worksheet

Remarques

[ Ensemble d’API : ExcelApi 1.4 ]

worksheetOrNullObject

Retourne la feuille de calcul dans 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.

readonly worksheetOrNullObject: Excel.Worksheet;

Valeur de propriété

Excel.Worksheet

Remarques

[ Ensemble d’API : ExcelApi 1.4 ]

Détails de la méthode

delete()

Supprime le nom donné.

delete(): void;

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.4 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/34-named-item/create-and-remove-named-item.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Sample");
    const totalName = sheet.names.getItemOrNullObject("TotalAmount");
    totalName.load();
    await context.sync();

    if (totalName.value) {
        totalName.delete();

        // Replace the named item (TotalAmount) with the actual formula for TotalAmount to avoid displaying #NAME in the cell.
        sheet.getRange("D11").values = [["=SUM(ExpensesTable[AMOUNT])"]];
    } else {
        console.log("No named item created for the formula.");
    }

    await context.sync();
});

getRange()

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

Excel.Range

Remarques

[ Ensemble d’API : ExcelApi 1.1 ]

Exemples

// Returns the Range object that is associated with the name.
// Returns `null` if the name is not of type Range.
// Note: This API currently supports only the Workbook scoped items.
await Excel.run(async (context) => { 
    const names = context.workbook.names;
    const range = names.getItem('MyRange').getRange();
    range.load('address');
    await context.sync();

    console.log(range.address);
});

getRangeOrNullObject()

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 retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getRangeOrNullObject(): Excel.Range;

Retours

Excel.Range

Remarques

[ Ensemble d’API : ExcelApi 1.4 ]

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

Paramètres

options
Excel.Interfaces.NamedItemLoadOptions

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

Retours

Excel.NamedItem

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

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

Exemples

await Excel.run(async (context) => { 
    const names = context.workbook.names;
    const namedItem = names.getItem('MyRange');
    namedItem.load('type');
    await context.sync();
    
    console.log(namedItem.type);
});

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

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

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

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

Paramètres

properties
Excel.Interfaces.NamedItemUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

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

properties
Excel.NamedItem

Retours

void

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

toJSON(): Excel.Interfaces.NamedItemData;

Retours

Excel.Interfaces.NamedItemData