Excel.Interfaces.NamedItemLoadOptions interface

Stellt einen definierten Namen für einen Zellbereich oder einen Wert dar. Namen können einfache 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.

Hinweise

API-Satz: ExcelApi 1.1

Verwendet von

Eigenschaften

$all

Wenn Sie für die Ladeoptionen angeben $all , werden alle skalaren Eigenschaften (z. B Range.address. ) geladen, aber nicht die Navigationseigenschaften (z. B Range.format.fill.color. ).

arrayValues

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

comment

Gibt den mit diesem Namen verbundenen Kommentar an.

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 beschränkt ist. Mögliche Werte sind: Arbeitsblatt, Arbeitsmappe.

type

Gibt den Typ des Werts an, der von der Formel des Namens zurückgegeben wird. Weitere Informationen findest du hier 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 zurück! Fehler in der Excel-Benutzeroberfläche, wenn er auf eine benutzerdefinierte Funktion verweist.

valueAsJson

Eine JSON-Darstellung der Werte in diesem benannten Element. Im Gegensatz NamedItem.valuezu unterstützt unterstützt dies alle Datentypen, NamedItem.valueAsJson die sich in einer Zelle befinden können. Beispiele sind neben den standardmäßigen booleschen, numerischen und Zeichenfolgenwerten auch formatierte Zahlenwerte und Webbilder. Von dieser API zurückgegebene Daten stimmen immer mit dem Gebietsschema en-US überein. Um Daten im Anzeigegebietsschema des Benutzers abzurufen, verwenden Sie NamedItem.valueAsJsonLocal.

valueAsJsonLocal

Eine JSON-Darstellung der Werte in diesem benannten Element. Im Gegensatz NamedItem.valuezu unterstützt unterstützt dies alle Datentypen, NamedItem.valueAsJsonLocal die sich in einer Zelle befinden können. Beispiele sind neben den standardmäßigen booleschen, numerischen und Zeichenfolgenwerten auch formatierte Zahlenwerte und Webbilder. Die von dieser API zurückgegebenen Daten entsprechen immer dem Anzeigegebietsschema des Benutzers. Um Daten unabhängig vom Gebietsschema abzurufen, verwenden Sie NamedItem.valueAsJson.

visible

Gibt an, ob das Objekt sichtbar ist.

worksheet

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

worksheetOrNullObject

Gibt das Arbeitsblatt zurück, auf das das benannte Element eingegrenzt ist. Wenn das Element stattdessen auf die Arbeitsmappe beschränkt ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

Details zur Eigenschaft

$all

Wenn Sie für die Ladeoptionen angeben $all , werden alle skalaren Eigenschaften (z. B Range.address. ) geladen, aber nicht die Navigationseigenschaften (z. B Range.format.fill.color. ).

$all?: boolean;

Eigenschaftswert

boolean

arrayValues

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

arrayValues?: Excel.Interfaces.NamedItemArrayValuesLoadOptions;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.7

comment

Gibt den mit diesem Namen verbundenen Kommentar an.

comment?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.4

formula

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

formula?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.7

name

Der Name des Objekts.

name?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.1

scope

Gibt an, ob der Name auf die Arbeitsmappe oder ein bestimmtes Arbeitsblatt beschränkt ist. Mögliche Werte sind: Arbeitsblatt, Arbeitsmappe.

scope?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.4

type

Gibt den Typ des Werts an, der von der Formel des Namens zurückgegeben wird. Weitere Informationen findest du hier Excel.NamedItemType .

type?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.1 für Zeichenfolge,Ganzzahl,Double,Boolescher,Bereich,Fehler; 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 zurück! Fehler in der Excel-Benutzeroberfläche, wenn er auf eine benutzerdefinierte Funktion verweist.

value?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.1

valueAsJson

Eine JSON-Darstellung der Werte in diesem benannten Element. Im Gegensatz NamedItem.valuezu unterstützt unterstützt dies alle Datentypen, NamedItem.valueAsJson die sich in einer Zelle befinden können. Beispiele sind neben den standardmäßigen booleschen, numerischen und Zeichenfolgenwerten auch formatierte Zahlenwerte und Webbilder. Von dieser API zurückgegebene Daten stimmen immer mit dem Gebietsschema en-US überein. Um Daten im Anzeigegebietsschema des Benutzers abzurufen, verwenden Sie NamedItem.valueAsJsonLocal.

valueAsJson?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.16

valueAsJsonLocal

Eine JSON-Darstellung der Werte in diesem benannten Element. Im Gegensatz NamedItem.valuezu unterstützt unterstützt dies alle Datentypen, NamedItem.valueAsJsonLocal die sich in einer Zelle befinden können. Beispiele sind neben den standardmäßigen booleschen, numerischen und Zeichenfolgenwerten auch formatierte Zahlenwerte und Webbilder. Die von dieser API zurückgegebenen Daten entsprechen immer dem Anzeigegebietsschema des Benutzers. Um Daten unabhängig vom Gebietsschema abzurufen, verwenden Sie NamedItem.valueAsJson.

valueAsJsonLocal?: boolean;

Eigenschaftswert

boolean

Hinweise

API-Satz: ExcelApi 1.16

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. Gibt einen Fehler aus, wenn das Element stattdessen auf die Arbeitsmappe beschränkt ist.

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.4

worksheetOrNullObject

Gibt das Arbeitsblatt zurück, auf das das benannte Element eingegrenzt ist. Wenn das Element stattdessen auf die Arbeitsmappe beschränkt ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

worksheetOrNullObject?: Excel.Interfaces.WorksheetLoadOptions;

Eigenschaftswert

Hinweise

API-Satz: ExcelApi 1.4