Excel.LinkedWorkbookCollection class
Stellt eine Auflistung verknüpfter Arbeitsmappenobjekte 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. |
workbook |
Stellt den Aktualisierungsmodus der Arbeitsmappenlinks dar. Der Modus ist für alle Arbeitsmappenlinks in der Arbeitsmappe identisch. |
Methoden
break |
Unterbricht alle Links zu den verknüpften Arbeitsmappen. Sobald die Verknüpfungen unterbrochen sind, werden alle Formeln, die auf Arbeitsmappenverknüpfungen verweisen, vollständig entfernt und durch die zuletzt abgerufenen Werte ersetzt. |
get |
Ruft Informationen zu einer verknüpften Arbeitsmappe anhand ihrer URL ab. |
get |
Ruft Informationen zu einer verknüpften Arbeitsmappe anhand ihrer URL ab. Wenn die Arbeitsmappe 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 " |
refresh |
Sendet eine Anforderung zum Aktualisieren aller Arbeitsmappenlinks. |
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.LinkedWorkbook[];
Eigenschaftswert
workbookLinksRefreshMode
Stellt den Aktualisierungsmodus der Arbeitsmappenlinks dar. Der Modus ist für alle Arbeitsmappenlinks in der Arbeitsmappe identisch.
workbookLinksRefreshMode: Excel.WorkbookLinksRefreshMode | "Manual" | "Automatic";
Eigenschaftswert
Excel.WorkbookLinksRefreshMode | "Manual" | "Automatic"
Hinweise
Details zur Methode
breakAllLinks()
Unterbricht alle Links zu den verknüpften Arbeitsmappen. Sobald die Verknüpfungen unterbrochen 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
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
getItemOrNullObject(key)
Ruft Informationen zu einer verknüpften Arbeitsmappe anhand ihrer 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
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 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.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()
Sendet eine Anforderung zum Aktualisieren aller Arbeitsmappenlinks.
refreshAll(): void;
Gibt zurück
void
Hinweise
toJSON()
Überschreibt die JavaScript-Methode toJSON()
, um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()
übergeben wird. (JSON.stringify
ruft wiederum die toJSON
-Methode des Objekts auf, 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 (typisiert als Excel.Interfaces.LinkedWorkbookCollectionData
) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.
toJSON(): Excel.Interfaces.LinkedWorkbookCollectionData;
Gibt zurück
Office Add-ins