Visio.Application class
Represents the Application.
- Extends
Remarks
[ API set: 1.1 ]
Properties
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| show |
Shows or hides the iframe application borders. |
| show |
Shows or hides the standard toolbars. |
Methods
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| set(properties, options) | Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type. |
| set(properties) | Sets multiple properties on the object at the same time, based on an existing loaded object. |
| set |
Set mock data |
| show |
Sets the visibility of a specific toolbar in the application. |
| show |
Sets the visibility of a specific toolbar in the application. |
| toJSON() | Overrides the JavaScript |
Property Details
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
showBorders
Shows or hides the iframe application borders.
showBorders: boolean;Property Value
boolean
Remarks
[ API set: 1.1 ]
Examples
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
Shows or hides the standard toolbars.
showToolbars: boolean;Property Value
boolean
Remarks
[ API set: 1.1 ]
Method Details
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: Visio.Interfaces.ApplicationLoadOptions): Visio.Application;Parameters
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): Visio.Application;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Visio.Application;Parameters
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
set(properties, options)
Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties: Interfaces.ApplicationUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameters
- properties
- Visio.Interfaces.ApplicationUpdateData
A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.
- options
- OfficeExtension.UpdateOptions
Provides an option to suppress errors if the properties object tries to set any read-only properties.
Returns
void
set(properties)
Sets multiple properties on the object at the same time, based on an existing loaded object.
set(properties: Visio.Application): void;Parameters
- properties
- Visio.Application
Returns
void
setMockData(data)
Set mock data
setMockData(data: Visio.Interfaces.ApplicationData): void;Parameters
Returns
void
showToolbar(id, show)
Sets the visibility of a specific toolbar in the application.
showToolbar(id: Visio.ToolBarType, show: boolean): void;Parameters
The type of the Toolbar.
- show
-
boolean
Whether the toolbar is visible or not.
Returns
void
Remarks
[ API set: 1.1 ]
showToolbar(idString, show)
Sets the visibility of a specific toolbar in the application.
showToolbar(idString: "CommandBar" | "PageNavigationBar" | "StatusBar", show: boolean): void;Parameters
- idString
-
"CommandBar" | "PageNavigationBar" | "StatusBar"
The type of the Toolbar.
- show
-
boolean
Whether the toolbar is visible or not.
Returns
void
Remarks
[ API set: 1.1 ]
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Visio.Application object is an API object, the toJSON method returns a plain JavaScript object (typed as Visio.Interfaces.ApplicationData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Visio.Interfaces.ApplicationData;Returns
Office Add-ins