Visio.CommentCollection class

  • 参考
包:
visio

表示给定形状的 CommentCollection 对象。

Extends
OfficeExtension.ClientObject

注解

[ API 集： 1.1 ]

属性

context

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

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

方法

getCount()

获取 Comment 对象的数量。
getItem(key)

按 Comment 对象的名称获取此对象。
load(options)

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

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

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

设置模拟数据
toJSON()

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

属性详细信息

context

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

context: RequestContext;

属性值

Visio.RequestContext

items

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

readonly items: Visio.Comment[];

属性值

Visio.Comment[]

方法详细信息

getCount()

获取 Comment 对象的数量。

getCount(): OfficeExtension.ClientResult<number>;

返回

OfficeExtension.ClientResult<number>

注解

[ API 集： 1.1 ]

getItem(key)

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

getItem(key: string): Visio.Comment;

参数

key

string

键是要检索的 Comment 的名称。

返回

Visio.Comment

注解

[ API 集： 1.1 ]

load(options)

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

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

参数

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));
    }
});

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Visio.CommentCollection

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths
OfficeExtension.LoadOption

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

返回

Visio.CommentCollection

setMockData(data)

设置模拟数据

setMockData(data: Visio.Interfaces.CommentCollectionData): void;

参数

data
Visio.Interfaces.CommentCollectionData

返回

void

toJSON()

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

toJSON(): Visio.Interfaces.CommentCollectionData;

返回

Visio.Interfaces.CommentCollectionData