通过

Visio.Page class

  • 参考
包:
visio

表示 Page 类。

Extends
OfficeExtension.ClientObject

注解

[ API 集： 1.1 ]

属性

allShapes

Page 中的所有形状，包括子图形。
comments

返回注释集合。
context

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

返回页面的高度。
index

页面的索引。
isBackground

页面是否为背景页。
name

页面名称。
shapes

Page 中的所有顶级形状。
view

返回页面的视图。
width

返回页面的宽度。

方法

activate()

将页面设置为文档的活动页。
load(options)

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

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

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

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties)

基于现有的已加载对象，同时对对象设置多个属性。
setMockData(data)

设置模拟数据
toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始 Visio.Page 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Visio.Interfaces.PageData) ，该对象包含原始对象中加载的任何子属性的浅表副本。

属性详细信息

allShapes

Page 中的所有形状，包括子图形。

readonly allShapes: Visio.ShapeCollection;

属性值

Visio.ShapeCollection

注解

[ API 集： 1.1 ]

comments

返回注释集合。

readonly comments: Visio.CommentCollection;

属性值

Visio.CommentCollection

注解

[ API 集： 1.1 ]

context

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

context: RequestContext;

属性值

Visio.RequestContext

height

返回页面的高度。

readonly height: number;

属性值

number

注解

[ API 集： 1.1 ]

index

页面的索引。

readonly index: number;

属性值

number

注解

[ API 集： 1.1 ]

isBackground

页面是否为背景页。

readonly isBackground: boolean;

属性值

boolean

注解

[ API 集： 1.1 ]

name

页面名称。

readonly name: string;

属性值

string

注解

[ API 集： 1.1 ]

shapes

Page 中的所有顶级形状。

readonly shapes: Visio.ShapeCollection;

属性值

Visio.ShapeCollection

注解

[ API 集： 1.1 ]

view

返回页面的视图。

readonly view: Visio.PageView;

属性值

Visio.PageView

注解

[ API 集： 1.1 ]

width

返回页面的宽度。

readonly width: number;

属性值

number

注解

[ API 集： 1.1 ]

方法详细信息

activate()

将页面设置为文档的活动页。

activate(): void;

返回

void

注解

[ API 集： 1.1 ]

load(options)

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

load(options?: Visio.Interfaces.PageLoadOptions): Visio.Page;

参数

options
Visio.Interfaces.PageLoadOptions

提供要加载对象的属性的选项。

返回

Visio.Page

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Visio.Page

load(propertyNamesAndPaths)

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

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Visio.Page;

参数

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

返回

Visio.Page

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

set(properties: Interfaces.PageUpdateData, options?: OfficeExtension.UpdateOptions): void;

参数

properties
Visio.Interfaces.PageUpdateData

一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。

options
OfficeExtension.UpdateOptions

提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

void

set(properties)

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: Visio.Page): void;

参数

properties
Visio.Page

返回

void

setMockData(data)

设置模拟数据

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

参数

data
Visio.Interfaces.PageData

返回

void

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始 Visio.Page 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Visio.Interfaces.PageData) ，该对象包含原始对象中加载的任何子属性的浅表副本。

toJSON(): Visio.Interfaces.PageData;

返回

Visio.Interfaces.PageData