Freigeben über


Excel.NamedItemCollection class

Eine Auflistung aller Objekte, die NamedItem Teil der Arbeitsmappe oder des Arbeitsblatts sind, je nachdem, wie sie erreicht wurde.

Extends

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Eigenschaften

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

items

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

Methoden

add(name, reference, comment)

Fügt einen neuen Namen zur Auflistung des angegebenen Bereichs hinzu.

addFormulaLocal(name, formula, comment)

Fügt einen neuen Namen zu der Auflistung des angegebenen Bereichs unter Verwendung des Gebietsschemas des Benutzers für die Formel hinzu.

getCount()

Ruft die Anzahl von benannten Elementen in der Auflistung ab.

getItem(name)

Ruft ein NamedItem -Objekt unter Verwendung seines Namens ab.

getItemOrNullObject(name)

Ruft ein NamedItem -Objekt unter Verwendung seines Namens ab. Wenn das Objekt nicht vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.NamedItemCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.NamedItemCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

Details zur Eigenschaft

context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

items

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: Excel.NamedItem[];

Eigenschaftswert

Details zur Methode

add(name, reference, comment)

Fügt einen neuen Namen zur Auflistung des angegebenen Bereichs hinzu.

add(name: string, reference: Range | string, comment?: string): Excel.NamedItem;

Parameter

name

string

Der Name des benannten Elements.

reference

Excel.Range | string

Die Formel oder der Bereich, auf die bzw. den der Name verweist.

comment

string

Optional. Der Kommentar, der dem benannten Element zugeordnet ist.

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.4 ]

Beispiele

// 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 headerRange = sheet.getRange("A1:D1");

    sheet.names.add("ExpensesHeader", headerRange);
    const namedItems = sheet.names.load("name, type");

    await context.sync();
});

addFormulaLocal(name, formula, comment)

Fügt einen neuen Namen zu der Auflistung des angegebenen Bereichs unter Verwendung des Gebietsschemas des Benutzers für die Formel hinzu.

addFormulaLocal(name: string, formula: string, comment?: string): Excel.NamedItem;

Parameter

name

string

Der Name des benannten Elements.

formula

string

Die Formel im Gebietsschema des Benutzers, auf die der Name verweist.

comment

string

Optional. Der Kommentar, der dem benannten Element zugeordnet ist.

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.4 ]

getCount()

Ruft die Anzahl von benannten Elementen in der Auflistung ab.

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.4 ]

getItem(name)

Ruft ein NamedItem -Objekt unter Verwendung seines Namens ab.

getItem(name: string): Excel.NamedItem;

Parameter

name

string

Name des benannten Elements.

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

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

getItemOrNullObject(name)

Ruft ein NamedItem -Objekt unter Verwendung seines Namens ab. Wenn das Objekt nicht vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getItemOrNullObject(name: string): Excel.NamedItem;

Parameter

name

string

Name des benannten Elements.

Gibt zurück

Hinweise

[ API-Satz: ExcelApi 1.4 ]

load(options)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: Excel.Interfaces.NamedItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NamedItemCollection;

Parameter

options

Excel.Interfaces.NamedItemCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

load(propertyNames)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): Excel.NamedItemCollection;

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

Beispiele

await Excel.run(async (context) => { 
    const nameditems = context.workbook.names;
    nameditems.load('items');
    await context.sync();

    for (let i = 0; i < nameditems.items.length; i++) {
        console.log(nameditems.items[i].name);
    }
});

load(propertyNamesAndPaths)

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Excel.NamedItemCollection;

Parameter

propertyNamesAndPaths
OfficeExtension.LoadOption

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

toJSON()

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche Excel.NamedItemCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.NamedItemCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

toJSON(): Excel.Interfaces.NamedItemCollectionData;

Gibt zurück