Visio.Application class

包:

visio

表示 Application。

Extends

OfficeExtension.ClientObject

注解

[ API 集： 1.1 ]

属性

context	与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
showBorders	显示或隐藏 iframe 应用程序边框。
showToolbars	显示或隐藏标准工具栏。

方法

load(options)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
set(properties, options)	同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties)	基于现有的已加载对象，同时对对象设置多个属性。
setMockData(data)	设置模拟数据
showToolbar(id, show)	设置应用程序中特定工具栏的可见性。
showToolbar(idString, show)	设置应用程序中特定工具栏的可见性。
toJSON()	重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，依次调用toJSON传递给它的 对象的 方法。) 而原始 Visio.Application 对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 Visio.Interfaces.ApplicationData) ，其中包含原始对象中加载的任何子属性的浅表副本。

属性详细信息

context

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

context: RequestContext;

属性值

Visio.RequestContext

showBorders

显示或隐藏 iframe 应用程序边框。

showBorders: boolean;

属性值

boolean

注解

[ API 集： 1.1 ]

示例

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

showToolbars

显示或隐藏标准工具栏。

showToolbars: boolean;

属性值

boolean

注解

[ API 集： 1.1 ]

方法详细信息

load(options)

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

load(options?: Visio.Interfaces.ApplicationLoadOptions): Visio.Application;

参数

options

Visio.Interfaces.ApplicationLoadOptions

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

返回

Visio.Application

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Visio.Application

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

Visio.Application

set(properties, options)

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

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

参数

properties

Visio.Interfaces.ApplicationUpdateData

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

options

OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Visio.Application): void;

参数

properties

Visio.Application

返回

void

setMockData(data)

设置模拟数据

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

参数

data

Visio.Interfaces.ApplicationData

返回

void

showToolbar(id, show)

设置应用程序中特定工具栏的可见性。

showToolbar(id: Visio.ToolBarType, show: boolean): void;

参数

id

Visio.ToolBarType

工具栏的类型。

show

boolean

工具栏是否可见。

返回

void

注解

[ API 集： 1.1 ]

showToolbar(idString, show)

设置应用程序中特定工具栏的可见性。

showToolbar(idString: "CommandBar" | "PageNavigationBar" | "StatusBar", show: boolean): void;

参数

idString

"CommandBar" | "PageNavigationBar" | "StatusBar"

工具栏的类型。

show

boolean

工具栏是否可见。

返回

void

注解

[ API 集： 1.1 ]

toJSON()

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

toJSON(): Visio.Interfaces.ApplicationData;

返回

Visio.Interfaces.ApplicationData