Excel.Interfaces.NamedItemLoadOptions interface

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.

Hinweise

[ API-Satz: ExcelApi 1.1 ]

Eigenschaften

$all	Wenn Sie $all für die Ladeoptionen angeben, werden alle skalaren Eigenschaften (zRange.address. B. ) geladen, aber nicht die Navigationseigenschaften (zRange.format.fill.color. B. ).
arrayValues	Gibt ein Objekt mit Werten und Typen des benannten Elements zurück.
comment	Gibt den Kommentar an, der diesem Namen zugeordnet ist.
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.
valueAsJson	Eine JSON-Darstellung der Werte in diesem benannten Element. Im Gegensatz zu NamedItem.valueunterstützt NamedItem.valueAsJson alle Datentypen, die sich in einer Zelle enthalten können. Beispiele hierfür sind formatierte Zahlenwerte und Webbilder sowie die booleschen Standard-, Zahlen- und Zeichenfolgenwerte. Von dieser API zurückgegebene Daten entsprechen immer dem Gebietsschema en-US. Verwenden Sie NamedItem.valueAsJsonLocal, um Daten im Anzeigegebietsschema des Benutzers abzurufen.
valueAsJsonLocal	Eine JSON-Darstellung der Werte in diesem benannten Element. Im Gegensatz zu NamedItem.valueunterstützt NamedItem.valueAsJsonLocal alle Datentypen, die sich in einer Zelle enthalten können. Beispiele hierfür sind formatierte Zahlenwerte und Webbilder sowie die booleschen Standard-, Zahlen- und Zeichenfolgenwerte. Von dieser API zurückgegebene Daten sind immer am Anzeigegebietsschema des Benutzers ausgerichtet. 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. 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.

Details zur Eigenschaft

$all

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

TypeScript

$all?: boolean;

Eigenschaftswert

boolean

arrayValues

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

TypeScript

arrayValues?: Excel.Interfaces.NamedItemArrayValuesLoadOptions;

Eigenschaftswert

Excel.Interfaces.NamedItemArrayValuesLoadOptions

Hinweise

[ API-Satz: ExcelApi 1.7 ]

comment

Gibt den Kommentar an, der diesem Namen zugeordnet ist.

TypeScript

comment?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.4 ]

formula

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

TypeScript

formula?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.7 ]

name

Der Name des Objekts.

TypeScript

name?: boolean;

Eigenschaftswert

boolean

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.

TypeScript

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 finden Sie unter Excel.NamedItemType .

TypeScript

type?: boolean;

Eigenschaftswert

boolean

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.

TypeScript

value?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.1 ]

valueAsJson

Eine JSON-Darstellung der Werte in diesem benannten Element. Im Gegensatz zu NamedItem.valueunterstützt NamedItem.valueAsJson alle Datentypen, die sich in einer Zelle enthalten können. Beispiele hierfür sind formatierte Zahlenwerte und Webbilder sowie die booleschen Standard-, Zahlen- und Zeichenfolgenwerte. Von dieser API zurückgegebene Daten entsprechen immer dem Gebietsschema en-US. Verwenden Sie NamedItem.valueAsJsonLocal, um Daten im Anzeigegebietsschema des Benutzers abzurufen.

TypeScript

valueAsJson?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.16 ]

valueAsJsonLocal

Eine JSON-Darstellung der Werte in diesem benannten Element. Im Gegensatz zu NamedItem.valueunterstützt NamedItem.valueAsJsonLocal alle Datentypen, die sich in einer Zelle enthalten können. Beispiele hierfür sind formatierte Zahlenwerte und Webbilder sowie die booleschen Standard-, Zahlen- und Zeichenfolgenwerte. Von dieser API zurückgegebene Daten sind immer am Anzeigegebietsschema des Benutzers ausgerichtet. Um Daten unabhängig vom Gebietsschema abzurufen, verwenden Sie NamedItem.valueAsJson.

TypeScript

valueAsJsonLocal?: boolean;

Eigenschaftswert

boolean

Hinweise

[ API-Satz: ExcelApi 1.16 ]

visible

Gibt an, ob das Objekt sichtbar ist.

TypeScript

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.

TypeScript

worksheet?: Excel.Interfaces.WorksheetLoadOptions;

Eigenschaftswert

Excel.Interfaces.WorksheetLoadOptions

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.

TypeScript

worksheetOrNullObject?: Excel.Interfaces.WorksheetLoadOptions;

Eigenschaftswert

Excel.Interfaces.WorksheetLoadOptions

Hinweise

[ API-Satz: ExcelApi 1.4 ]