Excel.Interfaces.DocumentTaskData interface
An interface describing the data returned by calling documentTask.toJSON().
Properties
| assignees | Returns a collection of assignees of 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. |
| 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. |
Property Details
assignees
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.
assignees?: Excel.EmailIdentity[];Property Value
Remarks
completedBy
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.
completedBy?: Excel.EmailIdentity;Property Value
Remarks
completedDateTime
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.
completedDateTime?: Date;Property Value
Date
Remarks
createdBy
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.
createdBy?: Excel.EmailIdentity;Property Value
Remarks
createdDateTime
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.
createdDateTime?: Date;Property Value
Date
Remarks
id
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.
id?: string;Property Value
string
Remarks
percentComplete
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
priority
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
startAndDueDateTime
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
title
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
Office Add-ins
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for