Visio.Page class
表示 Page 类。
属性
| all |
页面中的所有形状,包括子形状。 |
| comments | 返回注释集合。 |
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| height | 返回页面的高度。 |
| index | 页面的索引。 |
| is |
页面是否为背景页。 |
| name | 页面名称。 |
| shapes | 页面中的所有顶层形状。 |
| view | 返回页面的视图。 |
| width | 返回页面的宽度。 |
方法
| activate() | 将页面设置为文档的活动页面。 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象,也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象,同时在对象上设置多个属性。 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
allShapes
comments
context
height
index
isBackground
name
shapes
view
width
方法详细信息
activate()
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Visio.Interfaces.PageLoadOptions): Visio.Page;
参数
- options
- Visio.Interfaces.PageLoadOptions
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Visio.Page;
参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Visio.Page;
参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串,以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象,也可以传递另一个相同类型的 API 对象。
set(properties: Interfaces.PageUpdateData, options?: OfficeExtension.UpdateOptions): void;
参数
- properties
- Visio.Interfaces.PageUpdateData
一个 JavaScript 对象,其属性与调用该方法的对象的属性同构结构。
- options
- OfficeExtension.UpdateOptions
提供一个选项,用于在 properties 对象尝试设置任何只读属性时禁止错误。
返回
void
set(properties)
toJSON()
覆盖 JavaScript toJSON() 方法,以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify,反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Visio.Page 对象是 API 对象, toJSON 但该方法返回一个纯 JavaScript 对象, (类型化为 Visio.Interfaces.PageData) ,其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Visio.Interfaces.PageData;