Visio.DocumentView class

表示 DocumentView 类。

扩展

注解

[ API 集: 1.1 ]

属性

context

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

disableHyperlinks

禁用超链接。

disablePan

禁用平移。

disablePanZoomWindow

禁用 PanZoomWindow。

disableZoom

禁用缩放。

hideDiagramBoundary

隐藏关系图边界。

方法

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.DocumentView 对象是 API 对象,但toJSON该方法返回一个纯 JavaScript 对象, (类型为 Visio.Interfaces.DocumentViewData) ,该对象包含从原始对象加载的任何子属性的浅表副本。

属性详细信息

context

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

context: RequestContext;

属性值

禁用超链接。

disableHyperlinks: boolean;

属性值

boolean

注解

[ API 集: 1.1 ]

示例

Visio.run(session, function (ctx) {
    const documentView = ctx.document.view;
    documentView.disableHyperlinks();
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

disablePan

禁用平移。

disablePan: boolean;

属性值

boolean

注解

[ API 集: 1.1 ]

disablePanZoomWindow

禁用 PanZoomWindow。

disablePanZoomWindow: boolean;

属性值

boolean

注解

[ API 集: 1.1 ]

disableZoom

禁用缩放。

disableZoom: boolean;

属性值

boolean

注解

[ API 集: 1.1 ]

hideDiagramBoundary

隐藏关系图边界。

hideDiagramBoundary: boolean;

属性值

boolean

注解

[ API 集: 1.1 ]

方法详细信息

load(options)

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

load(options?: Visio.Interfaces.DocumentViewLoadOptions): Visio.DocumentView;

参数

options
Visio.Interfaces.DocumentViewLoadOptions

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

返回

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

set(properties, options)

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

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

参数

properties
Visio.Interfaces.DocumentViewUpdateData

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

options
OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Visio.DocumentView): void;

参数

properties
Visio.DocumentView

返回

void

setMockData(data)

设置模拟数据

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

参数

返回

void

toJSON()

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

toJSON(): Visio.Interfaces.DocumentViewData;

返回