Excel.DocumentTaskCollection class

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.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

Properties

context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
items	Gets the loaded child items in this collection.

Methods

getCount()	Gets the number of tasks in the collection.
getItem(key)	Gets a task using its ID.
getItemAt(index)	Gets a task by its index in the collection.
getItemOrNullObject(key)	Gets a task using its ID.
load(options)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
toJSON()	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.DocumentTaskCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.DocumentTaskCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

Property Details

context

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

Excel.RequestContext

items

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 loaded child items in this collection.

readonly items: Excel.DocumentTask[];

Property Value

Excel.DocumentTask[]

Method Details

getCount()

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

getCount(): OfficeExtension.ClientResult<number>;

Returns

OfficeExtension.ClientResult<number>

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

getItem(key)

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 a task using its ID.

getItem(key: string): Excel.DocumentTask;

Parameters

key

string

The ID of the task.

Returns

Excel.DocumentTask

The task with the given ID. If there is no task with the given ID, then an ItemNotFound exception is thrown.

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

getItemAt(index)

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 a task by its index in the collection.

getItemAt(index: number): Excel.DocumentTask;

Parameters

index

number

The index of the task in the collection.

Returns

Excel.DocumentTask

The task with the given index.

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

getItemOrNullObject(key)

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 a task using its ID.

getItemOrNullObject(key: string): Excel.DocumentTask;

Parameters

key

string

The ID of the task.

Returns

Excel.DocumentTask

The task with the given ID. If there is no task with the given ID, then this method returns an object with its isNullObject property set to true. For further information, see *OrNullObject methods and properties.

Remarks

[ API set: ExcelApi BETA (PREVIEW ONLY) ]

load(options)

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

Parameters

options

Excel.Interfaces.DocumentTaskCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.DocumentTaskCollection

load(propertyNames)

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

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

Excel.DocumentTaskCollection

load(propertyNamesAndPaths)

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?: OfficeExtension.LoadOption): Excel.DocumentTaskCollection;

Parameters

propertyNamesAndPaths

OfficeExtension.LoadOption

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

Excel.DocumentTaskCollection

toJSON()

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.DocumentTaskCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.DocumentTaskCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): Excel.Interfaces.DocumentTaskCollectionData;

Returns

Excel.Interfaces.DocumentTaskCollectionData