Excel.NamedSheetViewCollection class
Stellt die Auflistung der Blattansichten im Arbeitsblatt dar.
- Extends
Hinweise
[ API-Satz: ExcelApiOnline 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) | Erstellt eine neue Blattansicht mit dem angegebenen Namen. |
| enter |
Erstellt und aktiviert eine neue temporäre Blattansicht. Temporäre Ansichten werden entfernt, wenn Sie die Anwendung schließen, die temporäre Ansicht mit der Exitmethode beenden oder zu einer anderen Blattansicht wechseln. Auf die temporäre Blattansicht kann auch mit der leeren Zeichenfolge ("") zugegriffen werden, wenn die temporäre Ansicht vorhanden ist. |
| exit() | Beendet die aktuell aktive Blattansicht. |
| get |
Ruft die aktuell aktive Blattansicht des Arbeitsblatts ab. |
| get |
Ruft die Anzahl der Blattansichten in diesem Arbeitsblatt ab. Schließt die temporäre Blattansicht ein, sofern vorhanden. |
| get |
Ruft eine Blattansicht unter Verwendung ihres Namens ab. |
| get |
Ruft eine Blattansicht anhand ihres Indexes in der Auflistung ab. |
| get |
Ruft eine Blattansicht unter Verwendung ihres Namens ab. Wenn das Blattansichtsobjekt nicht vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| toJSON() | Überschreibt die JavaScript-Methode |
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.NamedSheetView[];Eigenschaftswert
Details zur Methode
add(name)
Erstellt eine neue Blattansicht mit dem angegebenen Namen.
add(name: string): Excel.NamedSheetView;Parameter
- name
-
string
Der Name der zu erstellenden Blattansicht. Löst einen Fehler aus, wenn der angegebene Name bereits vorhanden ist, leer ist oder ein vom Arbeitsblatt reservierter Name ist.
Gibt zurück
Das neu erstellte Blattansichtsobjekt.
Hinweise
enterTemporary()
Erstellt und aktiviert eine neue temporäre Blattansicht. Temporäre Ansichten werden entfernt, wenn Sie die Anwendung schließen, die temporäre Ansicht mit der Exitmethode beenden oder zu einer anderen Blattansicht wechseln. Auf die temporäre Blattansicht kann auch mit der leeren Zeichenfolge ("") zugegriffen werden, wenn die temporäre Ansicht vorhanden ist.
enterTemporary(): Excel.NamedSheetView;Gibt zurück
Das neu erstellte Blattansichtsobjekt.
Hinweise
exit()
Beendet die aktuell aktive Blattansicht.
exit(): void;Gibt zurück
void
Hinweise
getActive()
Ruft die aktuell aktive Blattansicht des Arbeitsblatts ab.
getActive(): Excel.NamedSheetView;Gibt zurück
Die derzeit aktive Blattansicht für dieses Arbeitsblatt.
Hinweise
getCount()
Ruft die Anzahl der Blattansichten in diesem Arbeitsblatt ab. Schließt die temporäre Blattansicht ein, sofern vorhanden.
getCount(): OfficeExtension.ClientResult<number>;Gibt zurück
OfficeExtension.ClientResult<number>
Hinweise
getItem(key)
Ruft eine Blattansicht unter Verwendung ihres Namens ab.
getItem(key: string): Excel.NamedSheetView;Parameter
- key
-
string
Der Name der Blattansicht, bei dem die Groß-/Kleinschreibung beachtet wird. Verwenden Sie die leere Zeichenfolge (""), um die temporäre Blattansicht abzurufen, wenn die temporäre Ansicht vorhanden ist.
Gibt zurück
Die Blattansicht mit dem angegebenen Namen oder die temporäre Ansicht, wenn eine leere Zeichenfolge angegeben wurde. Wenn keine aktuelle temporäre Ansicht vorhanden ist und eine leere Zeichenfolge angegeben wurde, wird ein ItemNotFound Fehler ausgelöst.
Hinweise
getItemAt(index)
Ruft eine Blattansicht anhand ihres Indexes in der Auflistung ab.
getItemAt(index: number): Excel.NamedSheetView;Parameter
- index
-
number
Der Index des Blattansichtsobjekts in der Auflistung.
Gibt zurück
Die Blattansicht am angegebenen Index.
Hinweise
getItemOrNullObject(key)
Hinweis
Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.
Ruft eine Blattansicht unter Verwendung ihres Namens ab. Wenn das Blattansichtsobjekt nicht vorhanden ist, gibt diese Methode ein -Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.
getItemOrNullObject(key: string): Excel.NamedSheetView;Parameter
- key
-
string
Der Name der Blattansicht, bei dem die Groß-/Kleinschreibung beachtet wird. Verwenden Sie die leere Zeichenfolge (""), um die temporäre Blattansicht abzurufen, wenn die temporäre Ansicht vorhanden ist.
Gibt zurück
Die Blattansicht mit dem angegebenen Namen oder die temporäre Ansicht, wenn eine leere Zeichenfolge angegeben wurde.
Hinweise
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.NamedSheetViewCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.NamedSheetViewCollection;Parameter
- options
-
Excel.Interfaces.NamedSheetViewCollectionLoadOptions & 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.NamedSheetViewCollection;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
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.NamedSheetViewCollection;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.NamedSheetViewCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.NamedSheetViewCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.
toJSON(): Excel.Interfaces.NamedSheetViewCollectionData;Gibt zurück
Office Add-ins