Excel.DocumentTaskChange class
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
表示对任务的记录更改。
属性
| assignee | 表示为更改操作的 |
| changed |
表示进行任务更改的用户的标识。 |
| comment |
表示任务更改所锚定到的批注或批注回复的 ID。 |
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| created |
表示任务变更记录的创建日期和时间。 所有日期均以 UTC 表示。 |
| due |
表示任务的截止日期和时间。 它用于 |
| id | 任务更改的唯一 GUID。 |
| percent |
表示任务的完成百分比。 它用于 |
| priority | 表示任务的优先级。 它用于 |
| start |
表示任务的开始日期和时间。 它用于 |
| title | 表示任务的标题。 它用于 |
| type | 表示任务变更记录的操作类型。 操作类型的一些示例包括 |
| undo |
表示 |
方法
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| new |
创建对象的新 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
assignee
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
表示为更改操作的 assign 任务分配的用户，或从更改操作的 unassign 任务中取消分配的用户。
readonly assignee: Excel.EmailIdentity;属性值
注解
changedBy
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
表示进行任务更改的用户的标识。
readonly changedBy: Excel.EmailIdentity;属性值
注解
commentId
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
表示任务更改所锚定到的批注或批注回复的 ID。
readonly commentId: string;属性值
string
注解
context
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。
context: RequestContext;属性值
createdDateTime
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
表示任务变更记录的创建日期和时间。 所有日期均以 UTC 表示。
readonly createdDateTime: Date;属性值
Date
注解
dueDateTime
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
表示任务的截止日期和时间。 它用于 setSchedule 更改操作。 它在 UTC 时区。 可以设置为 null 删除截止日期和时间。 它应该一起 startDateTime 设置以避免冲突。
readonly dueDateTime: Date;属性值
Date
注解
id
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
任务更改的唯一 GUID。
readonly id: string;属性值
string
注解
percentComplete
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
表示任务的完成百分比。 它用于 setPercentComplete 更改操作。 这是介于 0 和 100 之间的值，其中 100 表示已完成的任务。 将此值更改为 100 也可完成关联的注释。 将完成从 100 更改为较低的值将重新激活关联的注释。
readonly percentComplete: number;属性值
number
注解
priority
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
表示任务的优先级。 它用于 setPriority 更改操作。 这是一个介于 0 和 10 之间的值，如果未设置，则 5 为默认优先级，其中 0 表示最高优先级。
readonly priority: number;属性值
number
注解
startDateTime
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
表示任务的开始日期和时间。 它用于 setSchedule 更改操作。 它在 UTC 时区。 可以将其设置为 null 删除开始日期和时间。 它应该一起 dueDateTime 设置以避免冲突。
readonly startDateTime: Date;属性值
Date
注解
title
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
表示任务的标题。 它用于 setTitle 更改操作。
readonly title: string;属性值
string
注解
type
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
表示任务变更记录的操作类型。 操作类型的一些示例包括 assign、 和 setPriorityundo。
readonly type: Excel.DocumentTaskChangeAction | "unknown" | "create" | "assign" | "unassign" | "unassignAll" | "setSchedule" | "setPercentComplete" | "setPriority" | "remove" | "restore" | "setTitle" | "undo";属性值
Excel.DocumentTaskChangeAction | "unknown" | "create" | "assign" | "unassign" | "unassignAll" | "setSchedule" | "setPercentComplete" | "setPriority" | "remove" | "restore" | "setTitle" | "undo"
注解
undoChangeId
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
表示 DocumentTaskChange.id 针对更改操作撤 undo 消的属性。
readonly undoChangeId: string;属性值
string
注解
方法详细信息
load(options)
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Excel.Interfaces.DocumentTaskChangeLoadOptions): Excel.DocumentTaskChange;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Excel.DocumentTaskChange;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.DocumentTaskChange;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
newObject(context)
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
创建对象的新 Excel.DocumentTaskChange 实例。
static newObject(context: OfficeExtension.ClientRequestContext): Excel.DocumentTaskChange;参数
返回
toJSON()
注意
此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。 请勿在生产环境中使用此 API。
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Excel.DocumentTaskChange 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Excel.Interfaces.DocumentTaskChangeData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Excel.Interfaces.DocumentTaskChangeData;