Visio.CommentCollection class

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

context: RequestContext;

属性值

获取此集合中已加载的子项。

readonly items: Visio.Comment[];

属性值

获取 Comment 对象的数量。

getCount(): OfficeExtension.ClientResult<number>;

返回

注解

[ API 集： 1.1 ]

按 Comment 对象的名称获取此对象。

getItem(key: string): Visio.Comment;

参数

返回

注解

[ API 集： 1.1 ]

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

load(options?: Visio.Interfaces.CommentCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.CommentCollection;

参数

返回

示例

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const shapeName = "Position Belt.41";
    const shape = activePage.shapes.getItem(shapeName);
    const shapeComments= shape.comments;
    shapeComments.load(["author", "text"]);
    return ctx.sync().then(function () {
        for (let i = 0; i < shapeComments.items.length; i++)
        {
            const comment = shapeComments.items[i];
            console.log("comment Author: " + comment.author);
            console.log("Comment Text: " + comment.text);
            console.log("Date " + comment.date);
        }
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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

load(propertyNames?: string | string[]): Visio.CommentCollection;

参数

返回

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Visio.CommentCollection;

参数

返回

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来，调用toJSON传递给它的 对象的 方法。) 虽然原始Visio.CommentCollection对象是 API 对象，toJSON但该方法返回一个纯 JavaScript 对象， (类型为 Visio.Interfaces.CommentCollectionData) ，其中包含一个“items”数组，其中包含集合项中任何已加载属性的浅表副本。

toJSON(): Visio.Interfaces.CommentCollectionData;

返回