Excel.DocumentTask class
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Represents a task.
- Extends
[ API set: ExcelApi BETA (PREVIEW ONLY) ]
assignees | Returns a collection of assignees of the task. |
changes | Gets the change records of the task. |
comment | Gets the comment associated with the task. |
completed |
Gets the most recent user to have completed the task. |
completed |
Gets the date and time that the task was completed. All dates are in UTC. |
context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
created |
Gets the user who created the task. |
created |
Gets the date and time that the task was created. All dates are in UTC. |
id | Gets the ID of the task. |
percent |
Specifies the completion percentage of the task. This is a value between 0 and 100, where 100 represents a completed task. |
priority | Specifies the priority of the task. This is a value between 0 and 10, where 0 represents the highest priority. |
start |
Gets or sets the date and time the task should start and is due. |
title | Specifies title of the task. |
assign(assignee) | Adds the given user to the list of assignees attached to the task. |
load(options) | Queues up a command to load the specified properties of the object. You must call |
load(property |
Queues up a command to load the specified properties of the object. You must call |
load(property |
Queues up a command to load the specified properties of the object. You must call |
toJSON() | Overrides the JavaScript |
unassign(assignee) | Removes the given user from the list of assignees attached to the task. |
unassign |
Removes all users from the list of assignees attached to the task. |
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Returns a collection of assignees of the task.
readonly assignees: Excel.EmailIdentity[];
Property Value
Remarks
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Gets the change records of the task.
readonly changes: Excel.DocumentTaskChangeCollection;
Property Value
Remarks
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Gets the comment associated with the task.
readonly comment: Excel.Comment;
Property Value
Remarks
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Gets the most recent user to have completed the task.
readonly completedBy: Excel.EmailIdentity;
Property Value
Remarks
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Gets the date and time that the task was completed. All dates are in UTC.
readonly completedDateTime: Date;
Property Value
Date
Remarks
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;
Property Value
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Gets the user who created the task.
readonly createdBy: Excel.EmailIdentity;
Property Value
Remarks
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Gets the date and time that the task was created. All dates are in UTC.
readonly createdDateTime: Date;
Property Value
Date
Remarks
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Gets the ID of the task.
readonly id: string;
Property Value
string
Remarks
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies the completion percentage of the task. This is a value between 0 and 100, where 100 represents a completed task.
percentComplete: number;
Property Value
number
Remarks
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies the priority of the task. This is a value between 0 and 10, where 0 represents the highest priority.
priority: number;
Property Value
number
Remarks
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Gets or sets the date and time the task should start and is due.
startAndDueDateTime: Excel.DocumentTaskSchedule;
Property Value
Remarks
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Specifies title of the task.
title: string;
Property Value
string
Remarks
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Adds the given user to the list of assignees attached to the task.
assign(assignee: Excel.EmailIdentity): void;
Parameters
- assignee
- Excel.EmailIdentity
The identity of the user to add to the assignee list.
Returns
void
Remarks
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Queues up a command to load the specified properties of the object. You must call context.sync()
before reading the properties.
load(options?: Excel.Interfaces.DocumentTaskLoadOptions): Excel.DocumentTask;
Parameters
Provides options for which properties of the object to load.
Returns
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Queues up a command to load the specified properties of the object. You must call context.sync()
before reading the properties.
load(propertyNames?: string | string[]): Excel.DocumentTask;
Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Queues up a command to load the specified properties of the object. You must call context.sync()
before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.DocumentTask;
Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select
is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand
is a comma-delimited string that specifies the navigation properties to load.
Returns
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Overrides the JavaScript toJSON()
method in order to provide more useful output when an API object is passed to JSON.stringify()
. (JSON.stringify
, in turn, calls the toJSON
method of the object that is passed to it.) Whereas the original Excel.DocumentTask
object is an API object, the toJSON
method returns a plain JavaScript object (typed as Excel.Interfaces.DocumentTaskData
) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Excel.Interfaces.DocumentTaskData;
Returns
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Removes the given user from the list of assignees attached to the task.
unassign(assignee: Excel.EmailIdentity): void;
Parameters
- assignee
- Excel.EmailIdentity
The identity of the user to remove from the assignee list.
Returns
void
Remarks
Note
This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
Removes all users from the list of assignees attached to the task.
unassignAll(): void;
Returns
void
Remarks
Office Add-ins feedback
Office Add-ins is an open source project. Select a link to provide feedback: