Excel.NamedSheetView class

  • Referenz
Paket:
excel

Stellt eine benannte Blattansicht eines Arbeitsblatts dar. In einer Blattansicht werden die Sortier- und Filterregeln für ein bestimmtes Arbeitsblatt gespeichert. Jede Blattansicht (auch eine temporäre Blattansicht) verfügt über einen eindeutigen, arbeitsblattbezogenen Namen, der für den Zugriff auf die Ansicht verwendet wird.

Extends
OfficeExtension.ClientObject

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.
name

Ruft den Namen der Blattansicht ab oder legt den Namen fest. Der Name der temporären Blattansicht ist die leere Zeichenfolge (""). Das Benennen der Ansicht mithilfe der name-Eigenschaft bewirkt, dass die Blattansicht gespeichert wird.

Methoden

activate()

Aktiviert diese Blattansicht. Dies entspricht der Verwendung von "Wechseln zu" in der Excel-Benutzeroberfläche.
delete()

Entfernt die Blattansicht aus dem Arbeitsblatt.
duplicate(name)

Erstellt eine Kopie dieser Blattansicht.
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.NamedSheetView-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.NamedSheetViewData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt 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

Excel.RequestContext

name

Ruft den Namen der Blattansicht ab oder legt den Namen fest. Der Name der temporären Blattansicht ist die leere Zeichenfolge (""). Das Benennen der Ansicht mithilfe der name-Eigenschaft bewirkt, dass die Blattansicht gespeichert wird.

name: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: ExcelApiOnline 1.1 ]

Details zur Methode

activate()

Aktiviert diese Blattansicht. Dies entspricht der Verwendung von "Wechseln zu" in der Excel-Benutzeroberfläche.

activate(): void;

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApiOnline 1.1 ]

delete()

Entfernt die Blattansicht aus dem Arbeitsblatt.

delete(): void;

Gibt zurück

void

Hinweise

[ API-Satz: ExcelApiOnline 1.1 ]

duplicate(name)

Erstellt eine Kopie dieser Blattansicht.

duplicate(name?: string): Excel.NamedSheetView;

Parameter

name

string

Der Name der duplizierten Blattansicht. Wenn kein Name angegeben wird, wird einer generiert.

Gibt zurück

Excel.NamedSheetView

Die neue, duplizierte Blattansicht.

Hinweise

[ API-Satz: ExcelApiOnline 1.1 ]

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.NamedSheetViewLoadOptions): Excel.NamedSheetView;

Parameter

options
Excel.Interfaces.NamedSheetViewLoadOptions

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

Gibt zurück

Excel.NamedSheetView

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

Parameter

propertyNames

string | string[]

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

Gibt zurück

Excel.NamedSheetView

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

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.NamedSheetView

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

toJSON(): Excel.Interfaces.NamedSheetViewData;

Gibt zurück

Excel.Interfaces.NamedSheetViewData