Excel.Interfaces.DocumentTaskCollectionLoadOptions interface

Package:

excel

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 collection of tasks.

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Properties

$all	Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
assignees	For EACH ITEM in the collection: Returns a collection of assignees of the task.
comment	For EACH ITEM in the collection: Gets the comment associated with the task.
completedBy	For EACH ITEM in the collection: Gets the most recent user to have completed the task.
completedDateTime	For EACH ITEM in the collection: Gets the date and time that the task was completed. All dates are in UTC.
createdBy	For EACH ITEM in the collection: Gets the user who created the task.
createdDateTime	For EACH ITEM in the collection: Gets the date and time that the task was created. All dates are in UTC.
id	For EACH ITEM in the collection: Gets the ID of the task.
percentComplete	For EACH ITEM in the collection: Specifies the completion percentage of the task. This is a value between 0 and 100, where 100 represents a completed task.
priority	For EACH ITEM in the collection: Specifies the priority of the task. This is a value between 0 and 10, where 0 represents the highest priority.
startAndDueDateTime	For EACH ITEM in the collection: Gets or sets the date and time the task should start and is due.
title	For EACH ITEM in the collection: Specifies title of the task.

Property Details

$all

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.

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

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.

For EACH ITEM in the collection: Returns a collection of assignees of the task.

assignees?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

comment

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.

For EACH ITEM in the collection: Gets the comment associated with the task.

comment?: Excel.Interfaces.CommentLoadOptions;

Property Value

Excel.Interfaces.CommentLoadOptions

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

For EACH ITEM in the collection: Gets the most recent user to have completed the task.

completedBy?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

For EACH ITEM in the collection: Gets the date and time that the task was completed. All dates are in UTC.

completedDateTime?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

For EACH ITEM in the collection: Gets the user who created the task.

createdBy?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

For EACH ITEM in the collection: Gets the date and time that the task was created. All dates are in UTC.

createdDateTime?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

For EACH ITEM in the collection: Gets the ID of the task.

id?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

For EACH ITEM in the collection: Specifies the completion percentage of the task. This is a value between 0 and 100, where 100 represents a completed task.

percentComplete?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

For EACH ITEM in the collection: Specifies the priority of the task. This is a value between 0 and 10, where 0 represents the highest priority.

priority?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

For EACH ITEM in the collection: Gets or sets the date and time the task should start and is due.

startAndDueDateTime?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

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.

For EACH ITEM in the collection: Specifies title of the task.

title?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]