Excel.DocumentTask class

包:

excel

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

代表一个任务。

扩展

OfficeExtension.ClientObject

注解

[ API 集：ExcelApi BETA (仅预览版) ]

属性

assignees	返回任务的被分配人的集合。
changes	获取任务的更改记录。
comment	获取与任务关联的注释。
completedBy	获取完成该任务的最新用户。
completedDateTime	获取任务的完成日期和时间。 所有日期均采用 UTC 格式。
context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
createdBy	获取创建任务的用户。
createdDateTime	获取任务的创建日期和时间。 所有日期均采用 UTC 格式。
id	获取任务的 ID。
percentComplete	指定任务的完成百分比。 这是一个介于 0 和 100 之间的值，其中 100 表示已完成的任务。
priority	指定任务的优先级。 这是一个介于 0 和 10 之间的值，其中 0 表示最高优先级。
startAndDueDateTime	获取或设置任务应开始和到期的日期和时间。
title	指定任务的标题。

方法

assign(assignee)	将给定用户添加到附加到任务的被分配者列表中。
load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始Excel.DocumentTask对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.DocumentTaskData) ，其中包含原始对象中任何已加载子属性的浅表副本。
unassign(assignee)	从附加到任务的被分配者列表中删除给定用户。
unassignAll()	从附加到任务的被分配者列表中删除所有用户。

属性详细信息

assignees

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

返回任务的被分配人的集合。

readonly assignees: Excel.EmailIdentity[];

属性值

Excel.EmailIdentity[]

注解

[ API 集：ExcelApi BETA (仅预览版) ]

changes

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取任务的更改记录。

readonly changes: Excel.DocumentTaskChangeCollection;

属性值

Excel.DocumentTaskChangeCollection

注解

[ API 集：ExcelApi BETA (仅预览版) ]

comment

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取与任务关联的注释。

readonly comment: Excel.Comment;

属性值

Excel.Comment

注解

[ API 集：ExcelApi BETA (仅预览版) ]

completedBy

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取完成该任务的最新用户。

readonly completedBy: Excel.EmailIdentity;

属性值

Excel.EmailIdentity

注解

[ API 集：ExcelApi BETA (仅预览版) ]

completedDateTime

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取任务的完成日期和时间。 所有日期均采用 UTC 格式。

readonly completedDateTime: Date;

属性值

Date

注解

[ API 集：ExcelApi BETA (仅预览版) ]

context

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Excel.RequestContext

createdBy

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取创建任务的用户。

readonly createdBy: Excel.EmailIdentity;

属性值

Excel.EmailIdentity

注解

[ API 集：ExcelApi BETA (仅预览版) ]

createdDateTime

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取任务的创建日期和时间。 所有日期均采用 UTC 格式。

readonly createdDateTime: Date;

属性值

Date

注解

[ API 集：ExcelApi BETA (仅预览版) ]

id

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取任务的 ID。

readonly id: string;

属性值

string

注解

[ API 集：ExcelApi BETA (仅预览版) ]

percentComplete

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

指定任务的完成百分比。 这是一个介于 0 和 100 之间的值，其中 100 表示已完成的任务。

percentComplete: number;

属性值

number

注解

[ API 集：ExcelApi BETA (仅预览版) ]

priority

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

指定任务的优先级。 这是一个介于 0 和 10 之间的值，其中 0 表示最高优先级。

priority: number;

属性值

number

注解

[ API 集：ExcelApi BETA (仅预览版) ]

startAndDueDateTime

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

获取或设置任务应开始和到期的日期和时间。

startAndDueDateTime: Excel.DocumentTaskSchedule;

属性值

Excel.DocumentTaskSchedule

注解

[ API 集：ExcelApi BETA (仅预览版) ]

title

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

指定任务的标题。

title: string;

属性值

string

注解

[ API 集：ExcelApi BETA (仅预览版) ]

方法详细信息

assign(assignee)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

将给定用户添加到附加到任务的被分配者列表中。

assign(assignee: Excel.EmailIdentity): void;

参数

assignee

Excel.EmailIdentity

要添加到被代理人列表的用户的标识。

返回

void

注解

[ API 集：ExcelApi BETA (仅预览版) ]

load(options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: Excel.Interfaces.DocumentTaskLoadOptions): Excel.DocumentTask;

参数

options

Excel.Interfaces.DocumentTaskLoadOptions

提供要加载对象的属性的选项。

返回

Excel.DocumentTask

load(propertyNames)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNames?: string | string[]): Excel.DocumentTask;

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

Excel.DocumentTask

load(propertyNamesAndPaths)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.DocumentTask;

参数

propertyNamesAndPaths

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

propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。

返回

Excel.DocumentTask

toJSON()

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始Excel.DocumentTask对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Excel.Interfaces.DocumentTaskData) ，其中包含原始对象中任何已加载子属性的浅表副本。

toJSON(): Excel.Interfaces.DocumentTaskData;

返回

Excel.Interfaces.DocumentTaskData

unassign(assignee)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

从附加到任务的被分配者列表中删除给定用户。

unassign(assignee: Excel.EmailIdentity): void;

参数

assignee

Excel.EmailIdentity

要从受托人列表中删除的用户的标识。

返回

void

注解

[ API 集：ExcelApi BETA (仅预览版) ]

unassignAll()

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。

从附加到任务的被分配者列表中删除所有用户。

unassignAll(): void;

返回

void

注解

[ API 集：ExcelApi BETA (仅预览版) ]