Excel.DocumentTaskCollection class

Paket:

excel

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Stellt eine Auflistung von Aufgaben dar.

Extends

OfficeExtension.ClientObject

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

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.

Methoden

getCount()	Ruft die Anzahl der Aufgaben in der Auflistung ab.
getItem(key)	Ruft einen Task mithilfe seiner ID ab.
getItemAt(index)	Ruft einen Task anhand seines Indexes in der Auflistung ab.
getItemOrNullObject(key)	Ruft einen Task mithilfe seiner ID ab.
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.DocumentTaskCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.DocumentTaskCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

Details zur Eigenschaft

context

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

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

items

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: Excel.DocumentTask[];

Eigenschaftswert

Excel.DocumentTask[]

Details zur Methode

getCount()

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft die Anzahl der Aufgaben in der Auflistung ab.

getCount(): OfficeExtension.ClientResult<number>;

Gibt zurück

OfficeExtension.ClientResult<number>

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

getItem(key)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft einen Task mithilfe seiner ID ab.

getItem(key: string): Excel.DocumentTask;

Parameter

key

string

Die ID der Aufgabe.

Gibt zurück

Excel.DocumentTask

Die Aufgabe mit der angegebenen ID. Wenn keine Aufgabe mit der angegebenen ID vorhanden ist, wird eine ItemNotFound Ausnahme ausgelöst.

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

getItemAt(index)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft einen Task anhand seines Indexes in der Auflistung ab.

getItemAt(index: number): Excel.DocumentTask;

Parameter

index

number

Der Index der Aufgabe in der Auflistung.

Gibt zurück

Excel.DocumentTask

Die Aufgabe mit dem angegebenen Index.

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

getItemOrNullObject(key)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

Ruft einen Task mithilfe seiner ID ab.

getItemOrNullObject(key: string): Excel.DocumentTask;

Parameter

key

string

Die ID der Aufgabe.

Gibt zurück

Excel.DocumentTask

Die Aufgabe mit der angegebenen ID. Wenn keine Aufgabe mit der angegebenen ID vorhanden ist, gibt diese Methode ein Objekt zurück, dessen isNullObject -Eigenschaft auf truefestgelegt ist. Weitere Informationen finden Sie unter *OrNullObject-Methoden und -Eigenschaften.

Hinweise

[ API-Satz: ExcelApi BETA (NUR VORSCHAU) ]

load(options)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

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

Parameter

options

Excel.Interfaces.DocumentTaskCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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

Gibt zurück

Excel.DocumentTaskCollection

load(propertyNames)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

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

Parameter

propertyNames

string | string[]

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

Gibt zurück

Excel.DocumentTaskCollection

load(propertyNamesAndPaths)

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

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

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

Excel.DocumentTaskCollection

toJSON()

Hinweis

Diese API wird als Vorschau für Entwickler bereitgestellt. Je nachdem, welches Feedback wir dazu erhalten, werden möglicherweise Änderungen vorgenommen. Verwenden Sie diese API nicht in einer Produktionsumgebung.

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

toJSON(): Excel.Interfaces.DocumentTaskCollectionData;

Gibt zurück

Excel.Interfaces.DocumentTaskCollectionData