Visio.PageCollection class

Stellt eine Auflistung von Page-Objekten dar, die Teil des Dokuments sind.

[API-Satz: 1.1 ]

Extends

Eigenschaften

context

Der dem Objekt zugeordnete Anforderungskontext. 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

getCount()

Ruft die Anzahl von Seiten in der Auflistung ab.

[API-Satz: 1.1 ]

getItem(key)

Ruft einen Hyperlink mithilfe des Schlüssels ab (Name oder ID).

[API-Satz: 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(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.

setMockData(data)

Festlegen simulierter Daten

toJSON()

Überschreibt die toJSON() JavaScript-Methode, um eine hilfreichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify(). (JSON.stringifyruft wiederum die Methode des Objekts auf, toJSON das an das Objekt übergeben wird.) Während das ursprüngliche Visio.PageCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt zurück (eingegeben als Visio.Interfaces.PageCollectionData), die ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

Details zur Eigenschaft

context

Der dem Objekt zugeordnete Anforderungskontext. 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: Visio.Page[];

Eigenschaftswert

Details zur Methode

getCount()

Ruft die Anzahl von Seiten in der Auflistung ab.

[API-Satz: 1.1 ]

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

getItem(key)

Ruft einen Hyperlink mithilfe des Schlüssels ab (Name oder ID).

[API-Satz: 1.1 ]

getItem(key: number | string): Visio.Page;

Parameter

key

number | string

Der Schlüssel ist der Name oder die ID der abzurufenden Seite.

Gibt zurück

Beispiele

Visio.run(session, function (ctx) {
    var pageName = 'Page-1';
    var page = ctx.document.pages.getItem(pageName);
    page.activate();
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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?: Visio.Interfaces.PageCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.PageCollection;

Parameter

options

Visio.Interfaces.PageCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions

Stellt Optionen bereit, für welche Eigenschaften des Objekts geladen werden soll.

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[]): Visio.PageCollection;

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): Visio.PageCollection;

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

setMockData(data)

Festlegen simulierter Daten

setMockData(data: Visio.Interfaces.PageCollectionData): void;

Parameter

Gibt zurück

void

toJSON()

Überschreibt die toJSON() JavaScript-Methode, um eine hilfreichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify(). (JSON.stringifyruft wiederum die Methode des Objekts auf, toJSON das an das Objekt übergeben wird.) Während das ursprüngliche Visio.PageCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt zurück (eingegeben als Visio.Interfaces.PageCollectionData), die ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

toJSON(): Visio.Interfaces.PageCollectionData;

Gibt zurück