Visio.Application class
表示 Application。
属性
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| show |
显示或隐藏 iframe 应用程序边框。 |
| show |
显示或隐藏标准工具栏。 |
方法
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| show |
设置应用程序中特定工具栏的可见性。 |
| show |
设置应用程序中特定工具栏的可见性。 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
context
showBorders
显示或隐藏 iframe 应用程序边框。
showBorders: boolean;属性值
boolean
注解
示例
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
方法详细信息
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Visio.Interfaces.ApplicationLoadOptions): Visio.Application;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Visio.Application;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Visio.Application;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
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
showToolbar(id, show)
设置应用程序中特定工具栏的可见性。
showToolbar(id: Visio.ToolBarType, show: boolean): void;参数
工具栏的类型。
- show
-
boolean
工具栏是否可见。
返回
void
注解
showToolbar(id, show)
设置应用程序中特定工具栏的可见性。
showToolbar(id: "CommandBar" | "PageNavigationBar" | "StatusBar", show: boolean): void;参数
- id
-
"CommandBar" | "PageNavigationBar" | "StatusBar"
工具栏的类型。
- show
-
boolean
工具栏是否可见。
返回
void
注解
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来 toJSON 调用传递给它的对象的方法。) 虽然原始 Visio.Application 对象是一个 API 对象，但该 toJSON 方法返回一个纯 JavaScript 对象， (类型化为 Visio.Interfaces.ApplicationData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Visio.Interfaces.ApplicationData;