Excel.LinkedWorkbookCollection class

Stellt eine Sammlung verknüpfter Arbeitsmappenobjekte dar.

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.

workbookLinksRefreshMode

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

Methoden

breakAllLinks()

Bricht alle Verknüpfungen zu den verknüpften Arbeitsmappen auf. Sobald die Verknüpfungen aufgehoben sind, werden alle Formeln, die auf Arbeitsmappenverknüpfungen verweisen, vollständig entfernt und durch die zuletzt abgerufenen Werte ersetzt.

getItem(key)

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

getItemOrNullObject(key)

Ruft Informationen zu einer verknüpften Arbeitsmappe anhand der URL ab. Wenn die Arbeitsmappe nicht vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist 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 Arbeitsmappenverknüpfungen.

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 sie übergeben wird.) Während das ursprüngliche Excel.LinkedWorkbookCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.LinkedWorkbookCollectionData) zurück, das ein "items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Sammlung 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 Arbeitsmappenverknüpfungen 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

Bricht alle Verknüpfungen zu den verknüpften Arbeitsmappen auf. Sobald die Verknüpfungen aufgehoben sind, werden alle Formeln, die auf Arbeitsmappenverknüpfungen 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 der 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 der URL ab. Wenn die Arbeitsmappe nicht vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject Eigenschaft auf festgelegt ist 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 für die zu ladenden Eigenschaften des Objekts bereit.

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 Kommas getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Kommas getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

refreshAll()

Stellt eine Anforderung zum Aktualisieren aller Arbeitsmappenverknüpfungen.

refreshAll(): void;

Gibt zurück

void

Hinweise

API-Satz: ExcelApiOnline 1.1

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 sie übergeben wird.) Während das ursprüngliche Excel.LinkedWorkbookCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.LinkedWorkbookCollectionData) zurück, das ein "items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Sammlung enthält.

toJSON(): Excel.Interfaces.LinkedWorkbookCollectionData;

Gibt zurück