Visio.ShapeCollection class
表示 Shape 集合。
- 扩展
注解
[ API 集: 1.1 ]
属性
context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
items | 获取此集合中已加载的子项。 |
方法
get |
获取集合中的形状数量。 |
get |
按键(名称或索引)获取形状。 |
load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
set |
设置模拟数据 |
toJSON() | 重写 JavaScript |
属性详细信息
context
items
方法详细信息
getCount()
获取集合中的形状数量。
getCount(): OfficeExtension.ClientResult<number>;
返回
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)
按键(名称或索引)获取形状。
getItem(key: number | string): Visio.Shape;
参数
- key
-
number | string
键是要检索的形状的名称或索引。
返回
注解
[ API 集: 1.1 ]
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()
。
load(options?: Visio.Interfaces.ShapeCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.ShapeCollection;
参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()
。
load(propertyNames?: string | string[]): Visio.ShapeCollection;
参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()
。
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Visio.ShapeCollection;
参数
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select
是一个逗号分隔的字符串,指定要加载的属性,是 propertyNamesAndPaths.expand
一个逗号分隔的字符串,指定要加载的导航属性。
返回
setMockData(data)
设置模拟数据
setMockData(data: Visio.Interfaces.ShapeCollectionData): void;
参数
返回
void
toJSON()
重写 JavaScript toJSON()
方法,以便在将 API 对象传递给 JSON.stringify()
时提供更有用的输出。
JSON.stringify
(,反过来,调用toJSON
传递给它的 对象的 方法。) 虽然原始Visio.ShapeCollection
对象是 API 对象,toJSON
但该方法返回一个纯 JavaScript 对象, (类型为 Visio.Interfaces.ShapeCollectionData
) ,其中包含一个“items”数组,其中包含集合项中任何已加载属性的浅表副本。
toJSON(): Visio.Interfaces.ShapeCollectionData;