Word.Coauthor class

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

context: RequestContext;

属性值

获取共同作者的电子邮件地址。

readonly emailAddress: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取 对象的唯一 Coauthor 标识符。

readonly id: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取此作者是否表示当前用户。

readonly isMe: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取一个 CoauthoringLockCollection 对象，该对象表示文档中与此共同创作者关联的锁。

readonly locks: Word.CoauthoringLockCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取共同创作者的显示名称。

readonly name: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

load(options?: Word.Interfaces.CoauthorLoadOptions): Word.Coauthor;

参数

返回

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

load(propertyNames?: string | string[]): Word.Coauthor;

参数

返回

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.Coauthor;

参数

返回

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 虽然原始Word.Coauthor对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Word.Interfaces.CoauthorData) ，其中包含从原始对象加载的任何子属性的浅表副本。

toJSON(): Word.Interfaces.CoauthorData;

返回

根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果跨 .sync 调用和“.run”批处理的顺序执行外部使用此对象，并在设置属性或调用对象方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将该对象添加到跟踪的对象集合。 如果此对象是集合的一部分，则还应跟踪父集合。

track(): Word.Coauthor;

返回

释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 在内存发布生效之前，需要调用 context.sync() 。

untrack(): Word.Coauthor;

返回