Excel.LinkedWorkbookCollection class

Stellt eine Auflistung verknüpfter Arbeitsmappenobjekte dar.

Extends

Hinweise

[API-Satz: ExcelApiOnline 1.1 ]

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.

workbookLinksRefreshMode

Stellt den Aktualisierungsmodus der Arbeitsmappenlinks dar. Der Modus ist für alle in der Arbeitsmappe vorhandenen Arbeitsmappenlinks identisch.

Methoden

breakAllLinks()

Unterbricht alle Verknüpfungen zu den verknüpften Arbeitsmappen. Nachdem die Verknüpfungen unterbrochen wurden, werden alle Formeln, die auf Arbeitsmappenlinks verweisen, vollständig entfernt und durch die zuletzt abgerufenen Werte ersetzt.

getItem(key)

Ruft Informationen zu einer verknüpften Arbeitsmappe anhand ihrer URL ab.

getItemOrNullObject(key)

Ruft Informationen zu einer verknüpften Arbeitsmappe anhand ihrer URL ab. Wenn die Arbeitsmappe nicht vorhanden ist, gibt diese Funktion ein Objekt zurück, dessen isNullObject Eigenschaft auf true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften..

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.

refreshAll()

Stellt eine Anforderung zum Aktualisieren aller Arbeitsmappenlinks.

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 Excel.LinkedWorkbookCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt zurück (eingegeben als Excel.Interfaces.LinkedWorkbookCollectionData), 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: Excel.LinkedWorkbook[];

Eigenschaftswert

workbookLinksRefreshMode

Stellt den Aktualisierungsmodus der Arbeitsmappenlinks dar. Der Modus ist für alle in der Arbeitsmappe vorhandenen Arbeitsmappenlinks identisch.

workbookLinksRefreshMode: Excel.WorkbookLinksRefreshMode | "Manual" | "Automatic";

Eigenschaftswert

Excel.WorkbookLinksRefreshMode | "Manual" | "Automatic"

Hinweise

[API-Satz: ExcelApiOnline 1.1 ]

Details zur Methode

Unterbricht alle Verknüpfungen zu den verknüpften Arbeitsmappen. Nachdem die Verknüpfungen unterbrochen wurden, werden alle Formeln, die auf Arbeitsmappenlinks verweisen, vollständig entfernt und durch die zuletzt abgerufenen Werte ersetzt.

breakAllLinks(): void;

Gibt zurück

void

Hinweise

[API-Satz: ExcelApiOnline 1.1 ]

getItem(key)

Ruft Informationen zu einer verknüpften Arbeitsmappe anhand ihrer URL ab.

getItem(key: string): Excel.LinkedWorkbook;

Parameter

key

string

Die URL der verknüpften Arbeitsmappe.

Gibt zurück

Die verknüpfte Arbeitsmappe mit der angegebenen URL.

Hinweise

[API-Satz: ExcelApiOnline 1.1 ]

getItemOrNullObject(key)

Ruft Informationen zu einer verknüpften Arbeitsmappe anhand ihrer URL ab. Wenn die Arbeitsmappe nicht vorhanden ist, gibt diese Funktion ein Objekt zurück, dessen isNullObject Eigenschaft auf true. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften..

getItemOrNullObject(key: string): Excel.LinkedWorkbook;

Parameter

key

string

Die URL der verknüpften Arbeitsmappe.

Gibt zurück

Die verknüpfte Arbeitsmappe mit der angegebenen URL.

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.LinkedWorkbookCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.LinkedWorkbookCollection;

Parameter

options

Excel.Interfaces.LinkedWorkbookCollectionLoadOptions & Excel.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[]): Excel.LinkedWorkbookCollection;

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

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

refreshAll()

Stellt eine Anforderung zum Aktualisieren aller Arbeitsmappenlinks.

refreshAll(): void;

Gibt zurück

void

Hinweise

[API-Satz: ExcelApiOnline 1.1 ]

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 Excel.LinkedWorkbookCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt zurück (eingegeben als Excel.Interfaces.LinkedWorkbookCollectionData), die ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

toJSON(): Excel.Interfaces.LinkedWorkbookCollectionData;

Gibt zurück