Visio.Selection class

包:

visio

表示页面中的 Selection 对象。

扩展

OfficeExtension.ClientObject

注解

API 集：1.1

使用方

• Visio.PageView： getSelection

属性

context	与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。
shapes	获取选区的形状。

方法

load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
toJSON()	覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Visio.Selection 对象是 API 对象，但该 toJSON 方法返回 (类型化为 Visio.Interfaces.SelectionData) 的纯 JavaScript 对象，其中包含从原始对象加载的任何子属性的浅层副本。

属性详细信息

context

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

context: RequestContext;

属性值

Visio.RequestContext

shapes

获取选区的形状。

readonly shapes: Visio.ShapeCollection;

属性值

Visio.ShapeCollection

注解

API 集：1.1

方法详细信息

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Visio.Selection

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

Visio.Selection

toJSON()

覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Visio.Selection 对象是 API 对象，但该 toJSON 方法返回 (类型化为 Visio.Interfaces.SelectionData) 的纯 JavaScript 对象，其中包含从原始对象加载的任何子属性的浅层副本。

toJSON(): Visio.Interfaces.SelectionData;

返回

Visio.Interfaces.SelectionData