Visio.ShapeCollection class

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

context: RequestContext;

属性值

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

readonly items: Visio.Shape[];

属性值

获取集合中的形状数量。

getCount(): OfficeExtension.ClientResult<number>;

返回

注解

[ API 集： 1.1 ]

示例

Visio.run(session, function (ctx) {
    const activePage = ctx.document.getActivePage();
    const numShapesActivePage = activePage.shapes.getCount();
    return ctx.sync().then(function () {
        console.log("Shapes Count: " + numShapesActivePage.value);
    });
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

按键（名称或索引）获取形状。

getItem(key: number | string): Visio.Shape;

参数

返回

注解

[ API 集： 1.1 ]

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

load(options?: Visio.Interfaces.ShapeCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.ShapeCollection;

参数

返回

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

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

参数

返回

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

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

参数

返回

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

toJSON(): Visio.Interfaces.ShapeCollectionData;

返回