Excel.NamedItem class

  • Referenz
Paket:
excel

Stellt einen definierten Namen für einen Zellbereich oder einen Wert dar. Namen können primitive benannte Objekte (wie im folgenden Typ zu sehen), Bereichsobjekte oder ein Verweis auf einen Bereich sein. Dieses Objekt kann zum Abrufen des mit Namen verknüpften Bereichsobjekts verwendet werden.

Extends
OfficeExtension.ClientObject

Hinweise

[ API-Satz: ExcelApi 1.1 ]

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) => {
    // 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();
});

Eigenschaften

arrayValues

Gibt ein Objekt mit Werten und Typen des benannten Elements zurück.
comment

Gibt den Kommentar an, der diesem Namen zugeordnet ist.
context

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

Die Formel des benannten Elements. Formeln beginnen immer mit einem Gleichheitszeichen ("=").
name

Der Name des Objekts.
scope

Gibt an, ob der Name auf die Arbeitsmappe oder ein bestimmtes Arbeitsblatt festgelegt ist. Mögliche Werte sind: Worksheet, Workbook.
type

Gibt den Typ des Werts an, der von der Formel des Namens zurückgegeben wird. Weitere Informationen finden Sie unter Excel.NamedItemType .
value

Stellt den Wert dar, der von der Formel des Namens berechnet wurde. Für einen benannten Bereich wird die Bereichsadresse zurückgegeben. Diese API gibt die #VALUE! Fehler in der Excel-Benutzeroberfläche, wenn er auf eine benutzerdefinierte Funktion verweist.
visible

Gibt an, ob das Objekt sichtbar ist.
worksheet

Gibt das Arbeitsblatt zurück, auf dessen Bereich das benannte Element beschränkt ist. Löst einen Fehler aus, wenn das Element stattdessen auf die Arbeitsmappe ausgerichtet ist.
worksheetOrNullObject

Gibt das Arbeitsblatt zurück, für das das benannte Element gültig ist. Wenn das Element stattdessen auf die Arbeitsmappe ausgerichtet ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

Methoden

delete()

Löscht den angegebenen Namen.
getRange()

Ruft das Bereichsobjekt ab, das mit dem Namen verknüpft ist. Gibt einen Fehler zurück, wenn der Typ des benannten Elements kein Bereich ist.
getRangeOrNullObject()

Ruft das Bereichsobjekt ab, das mit dem Namen verknüpft ist. Wenn der Typ des benannten Elements kein Bereich ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. 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.
set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.
set(properties)

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.
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.NamedItem Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.NamedItemData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

Details zur Eigenschaft

arrayValues

Gibt ein Objekt mit Werten und Typen des benannten Elements zurück.

readonly arrayValues: Excel.NamedItemArrayValues;

Eigenschaftswert

Excel.NamedItemArrayValues

Hinweise

[ API-Satz: ExcelApi 1.7 ]

comment

Gibt den Kommentar an, der diesem Namen zugeordnet ist.

comment: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.4 ]

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

Excel.RequestContext

formula

Die Formel des benannten Elements. Formeln beginnen immer mit einem Gleichheitszeichen ("=").

formula: any;

Eigenschaftswert

any

Hinweise

[ API-Satz: ExcelApi 1.7 ]

Beispiele

// 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

Der Name des Objekts.

readonly name: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApi 1.1 ]

scope

Gibt an, ob der Name auf die Arbeitsmappe oder ein bestimmtes Arbeitsblatt festgelegt ist. Mögliche Werte sind: Worksheet, Workbook.

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

Eigenschaftswert

Excel.NamedItemScope | "Worksheet" | "Workbook"

Hinweise

[ API-Satz: ExcelApi 1.4 ]

type

Gibt den Typ des Werts an, der von der Formel des Namens zurückgegeben wird. Weitere Informationen finden Sie unter Excel.NamedItemType .

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

Eigenschaftswert

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

Hinweise

[ API-Satz: ExcelApi 1.1 für String,Integer,Double,Boolean,Range,Error; 1.7 für Array ]

value

Stellt den Wert dar, der von der Formel des Namens berechnet wurde. Für einen benannten Bereich wird die Bereichsadresse zurückgegeben. Diese API gibt die #VALUE! Fehler in der Excel-Benutzeroberfläche, wenn er auf eine benutzerdefinierte Funktion verweist.

readonly value: any;

Eigenschaftswert

any

Hinweise

[ API-Satz: ExcelApi 1.1 ]

visible

Gibt an, ob das Objekt sichtbar ist.

visible: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.1 ]

worksheet

Gibt das Arbeitsblatt zurück, auf dessen Bereich das benannte Element beschränkt ist. Löst einen Fehler aus, wenn das Element stattdessen auf die Arbeitsmappe ausgerichtet ist.

readonly worksheet: Excel.Worksheet;

Eigenschaftswert

Excel.Worksheet

Hinweise

[ API-Satz: ExcelApi 1.4 ]

worksheetOrNullObject

Gibt das Arbeitsblatt zurück, für das das benannte Element gültig ist. Wenn das Element stattdessen auf die Arbeitsmappe ausgerichtet ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

readonly worksheetOrNullObject: Excel.Worksheet;

Eigenschaftswert

Excel.Worksheet

Hinweise

[ API-Satz: ExcelApi 1.4 ]

Details zur Methode

delete()

Löscht den angegebenen Namen.

delete(): void;

Gibt zurück

void

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

Ruft das Bereichsobjekt ab, das mit dem Namen verknüpft ist. Gibt einen Fehler zurück, wenn der Typ des benannten Elements kein Bereich ist.

getRange(): Excel.Range;

Gibt zurück

Excel.Range

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Beispiele

// 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()

Ruft das Bereichsobjekt ab, das mit dem Namen verknüpft ist. Wenn der Typ des benannten Elements kein Bereich ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

getRangeOrNullObject(): Excel.Range;

Gibt zurück

Excel.Range

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

Parameter

options
Excel.Interfaces.NamedItemLoadOptions

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

Gibt zurück

Excel.NamedItem

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

Parameter

propertyNames

string | string[]

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

Gibt zurück

Excel.NamedItem

Beispiele

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)

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?: {
            select?: string;
            expand?: string;
        }): Excel.NamedItem;

Parameter

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

Excel.NamedItem

set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

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

Parameter

properties
Excel.Interfaces.NamedItemUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options
OfficeExtension.UpdateOptions

Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.

Gibt zurück

void

set(properties)

Legt mehrere Eigenschaften für das -Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: Excel.NamedItem): void;

Parameter

properties
Excel.NamedItem

Gibt zurück

void

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.NamedItem Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.NamedItemData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.NamedItemData;

Gibt zurück

Excel.Interfaces.NamedItemData