Excel.DocumentTaskChange class

  • 参考
包:
excel

注意

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

表示对任务的记录更改。

Extends
OfficeExtension.ClientObject

注解

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

属性

assignee

表示为更改操作分配给任务 assign 的用户，或取消为更改操作分配任务 unassign 的用户。
changedBy

表示执行任务更改的用户的标识。
commentId

表示任务更改已定位到的 或 commentReply 的 IDcomment。
context

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

表示任务更改记录的创建日期和时间。 所有日期均采用 UTC 格式。
dueDateTime

表示任务的截止日期和时间。 它用于 setSchedule 更改操作。 它采用 UTC 时区。 可以将其设置为 null 以删除截止日期和时间。 应将其设置为一起 startDateTime 以避免冲突。
id

任务更改的唯一 GUID。
percentComplete

表示任务的完成百分比。 它用于 setPercentComplete 更改操作。 这是一个介于 0 和 100 之间的值，其中 100 表示已完成的任务。 将此值更改为 100 也会完成关联的注释。 将完成值从 100 更改为较低的值会重新激活关联的注释。
priority

表示任务的优先级。 它用于 setPriority 更改操作。 这是一个介于 0 和 10 之间的值，如果未设置，则 5 为默认优先级，其中 0 表示最高优先级。
startDateTime

表示任务的开始日期和时间。 它用于 setSchedule 更改操作。 它采用 UTC 时区。 可以将其设置为 null 以删除开始日期和时间。 应将其设置为一起 dueDateTime 以避免冲突。
title

表示任务的标题。 它用于 setTitle 更改操作。
type

表示任务更改记录的操作类型。 操作类型的一些示例包括 assign、 undo和 setPriority。
undoChangeId

表示为 DocumentTaskChange.id 更改操作撤消 undo 的属性。

方法

load(options)

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

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

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

创建 Excel.DocumentTaskChange 对象的新实例
toJSON()

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

属性详细信息

assignee

注意

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

表示为更改操作分配给任务 assign 的用户，或取消为更改操作分配任务 unassign 的用户。

readonly assignee: Excel.EmailIdentity;

属性值

Excel.EmailIdentity

注解

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

changedBy

注意

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

表示执行任务更改的用户的标识。

readonly changedBy: Excel.EmailIdentity;

属性值

Excel.EmailIdentity

注解

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

commentId

注意

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

表示任务更改已定位到的 或 commentReply 的 IDcomment。

readonly commentId: string;

属性值

string

注解

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

context

注意

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

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

context: RequestContext;

属性值

Excel.RequestContext

createdDateTime

注意

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

表示任务更改记录的创建日期和时间。 所有日期均采用 UTC 格式。

readonly createdDateTime: Date;

属性值

Date

注解

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

dueDateTime

注意

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

表示任务的截止日期和时间。 它用于 setSchedule 更改操作。 它采用 UTC 时区。 可以将其设置为 null 以删除截止日期和时间。 应将其设置为一起 startDateTime 以避免冲突。

readonly dueDateTime: Date;

属性值

Date

注解

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

id

注意

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

任务更改的唯一 GUID。

readonly id: string;

属性值

string

注解

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

percentComplete

注意

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

表示任务的完成百分比。 它用于 setPercentComplete 更改操作。 这是一个介于 0 和 100 之间的值，其中 100 表示已完成的任务。 将此值更改为 100 也会完成关联的注释。 将完成值从 100 更改为较低的值会重新激活关联的注释。

readonly percentComplete: number;

属性值

number

注解

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

priority

注意

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

表示任务的优先级。 它用于 setPriority 更改操作。 这是一个介于 0 和 10 之间的值，如果未设置，则 5 为默认优先级，其中 0 表示最高优先级。

readonly priority: number;

属性值

number

注解

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

startDateTime

注意

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

表示任务的开始日期和时间。 它用于 setSchedule 更改操作。 它采用 UTC 时区。 可以将其设置为 null 以删除开始日期和时间。 应将其设置为一起 dueDateTime 以避免冲突。

readonly startDateTime: Date;

属性值

Date

注解

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

title

注意

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

表示任务的标题。 它用于 setTitle 更改操作。

readonly title: string;

属性值

string

注解

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

type

注意

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

表示任务更改记录的操作类型。 操作类型的一些示例包括 assign、 undo和 setPriority。

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"

注解

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

undoChangeId

注意

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

表示为 DocumentTaskChange.id 更改操作撤消 undo 的属性。

readonly undoChangeId: string;

属性值

string

注解

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

方法详细信息

load(options)

注意

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

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

load(options?: Excel.Interfaces.DocumentTaskChangeLoadOptions): Excel.DocumentTaskChange;

参数

options
Excel.Interfaces.DocumentTaskChangeLoadOptions

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

返回

Excel.DocumentTaskChange

load(propertyNames)

注意

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

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

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

参数

propertyNames

string | string[]

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

返回

Excel.DocumentTaskChange

load(propertyNamesAndPaths)

注意

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

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

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

参数

propertyNamesAndPaths

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

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

返回

Excel.DocumentTaskChange

newObject(context)

注意

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

创建 Excel.DocumentTaskChange 对象的新实例

static newObject(context: OfficeExtension.ClientRequestContext): Excel.DocumentTaskChange;

参数

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;

返回

Excel.Interfaces.DocumentTaskChangeData