Excel.DocumentTask class

  • Referenz
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 einen Vorgang dar.

Extends
OfficeExtension.ClientObject

Hinweise

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

Eigenschaften

assignees

Gibt eine Auflistung von Zugewiesenen der Aufgabe zurück.
changes

Ruft die Änderungsdatensätze des Vorgangs ab.
comment

Ruft den Kommentar ab, der der Aufgabe zugeordnet ist.
completedBy

Ruft den letzten Benutzer ab, der die Aufgabe abgeschlossen hat.
completedDateTime

Ruft das Datum und die Uhrzeit ab, zu dem die Aufgabe abgeschlossen wurde. Alle Datumsangaben sind in UTC angegeben.
context

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.
createdBy

Ruft den Benutzer ab, der die Aufgabe erstellt hat.
createdDateTime

Ruft das Datum und die Uhrzeit der Erstellung der Aufgabe ab. Alle Datumsangaben sind in UTC angegeben.
id

Ruft die ID des Tasks ab.
percentComplete

Gibt den Abschlussprozentsatz der Aufgabe an. Dies ist ein Wert zwischen 0 und 100, wobei 100 eine abgeschlossene Aufgabe darstellt.
priority

Gibt die Priorität der Aufgabe an. Dies ist ein Wert zwischen 0 und 10, wobei 0 die höchste Priorität darstellt.
startAndDueDateTime

Ruft das Datum und die Uhrzeit ab, zu der der Vorgang gestartet werden soll und fällig ist, oder legt diese fest.
title

Gibt den Titel der Aufgabe an.

Methoden

assign(assignee)

Fügt den angegebenen Benutzer der Liste der zugewiesenen Benutzer hinzu, die an die Aufgabe angefügt sind.
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.DocumentTask-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.DocumentTaskData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
unassign(assignee)

Entfernt den angegebenen Benutzer aus der Liste der zugewiesenen Empfänger, die an die Aufgabe angefügt sind.
unassignAll()

Entfernt alle Benutzer aus der Liste der zugewiesenen Empfänger, die an die Aufgabe angefügt sind.

Details zur Eigenschaft

assignees

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.

Gibt eine Auflistung von Zugewiesenen der Aufgabe zurück.

readonly assignees: Excel.EmailIdentity[];

Eigenschaftswert

Excel.EmailIdentity[]

Hinweise

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

changes

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 Änderungsdatensätze des Vorgangs ab.

readonly changes: Excel.DocumentTaskChangeCollection;

Eigenschaftswert

Excel.DocumentTaskChangeCollection

Hinweise

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

comment

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 den Kommentar ab, der der Aufgabe zugeordnet ist.

readonly comment: Excel.Comment;

Eigenschaftswert

Excel.Comment

Hinweise

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

completedBy

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 den letzten Benutzer ab, der die Aufgabe abgeschlossen hat.

readonly completedBy: Excel.EmailIdentity;

Eigenschaftswert

Excel.EmailIdentity

Hinweise

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

completedDateTime

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 das Datum und die Uhrzeit ab, zu dem die Aufgabe abgeschlossen wurde. Alle Datumsangaben sind in UTC angegeben.

readonly completedDateTime: Date;

Eigenschaftswert

Date

Hinweise

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

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

createdBy

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 den Benutzer ab, der die Aufgabe erstellt hat.

readonly createdBy: Excel.EmailIdentity;

Eigenschaftswert

Excel.EmailIdentity

Hinweise

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

createdDateTime

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 das Datum und die Uhrzeit der Erstellung der Aufgabe ab. Alle Datumsangaben sind in UTC angegeben.

readonly createdDateTime: Date;

Eigenschaftswert

Date

Hinweise

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

id

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 ID des Tasks ab.

readonly id: string;

Eigenschaftswert

string

Hinweise

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

percentComplete

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.

Gibt den Abschlussprozentsatz der Aufgabe an. Dies ist ein Wert zwischen 0 und 100, wobei 100 eine abgeschlossene Aufgabe darstellt.

percentComplete: number;

Eigenschaftswert

number

Hinweise

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

priority

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.

Gibt die Priorität der Aufgabe an. Dies ist ein Wert zwischen 0 und 10, wobei 0 die höchste Priorität darstellt.

priority: number;

Eigenschaftswert

number

Hinweise

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

startAndDueDateTime

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 das Datum und die Uhrzeit ab, zu der der Vorgang gestartet werden soll und fällig ist, oder legt diese fest.

startAndDueDateTime: Excel.DocumentTaskSchedule;

Eigenschaftswert

Excel.DocumentTaskSchedule

Hinweise

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

title

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.

Gibt den Titel der Aufgabe an.

title: string;

Eigenschaftswert

string

Hinweise

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

Details zur Methode

assign(assignee)

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.

Fügt den angegebenen Benutzer der Liste der zugewiesenen Benutzer hinzu, die an die Aufgabe angefügt sind.

assign(assignee: Excel.EmailIdentity): void;

Parameter

assignee
Excel.EmailIdentity

Die Identität des Benutzers, der der Liste der Zugewiesenen hinzugefügt werden soll.

Gibt zurück

void

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.DocumentTaskLoadOptions): Excel.DocumentTask;

Parameter

options
Excel.Interfaces.DocumentTaskLoadOptions

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

Gibt zurück

Excel.DocumentTask

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

Parameter

propertyNames

string | string[]

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

Gibt zurück

Excel.DocumentTask

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?: {
            select?: string;
            expand?: string;
        }): Excel.DocumentTask;

Parameter

propertyNamesAndPaths

{ select?: string; expand?: string; }

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.DocumentTask

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.DocumentTask-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als Excel.Interfaces.DocumentTaskData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): Excel.Interfaces.DocumentTaskData;

Gibt zurück

Excel.Interfaces.DocumentTaskData

unassign(assignee)

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.

Entfernt den angegebenen Benutzer aus der Liste der zugewiesenen Empfänger, die an die Aufgabe angefügt sind.

unassign(assignee: Excel.EmailIdentity): void;

Parameter

assignee
Excel.EmailIdentity

Die Identität des Benutzers, der aus der Liste der Zugewiesenen entfernt werden soll.

Gibt zurück

void

Hinweise

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

unassignAll()

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.

Entfernt alle Benutzer aus der Liste der zugewiesenen Empfänger, die an die Aufgabe angefügt sind.

unassignAll(): void;

Gibt zurück

void

Hinweise

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