Visio.Application class

Represents the Application.

[ API set: 1.1 ]

Extends

Properties

showBorders

Show or hide the iFrame application borders.

[ API set: 1.1 ]

showToolbars

Show or hide the standard toolbars.

[ API set: 1.1 ]

Methods

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

showToolbar(id, show)

Sets the visibility of a specific toolbar in the application.

[ API set: 1.1 ]

toJSON()

Property Details

showBorders

Show or hide the iFrame application borders.

[ API set: 1.1 ]

showBorders: boolean;

Property Value

boolean

showToolbars

Show or hide the standard toolbars.

[ API set: 1.1 ]

showToolbars: boolean;

Property Value

boolean

Method Details

load(option)

Queues up a command to load the specified properties of the object. You must call "context.sync()" before reading the properties.

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

Parameters

option
string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

Visio.Application

Remarks

In addition to this signature, this method has the following signatures:

load(option?: { select?: string; expand?: string; }): Visio.Application - Where option.select is a comma-delimited string that specifies the properties to load, and options.expand is a comma-delimited string that specifies the navigation properties to load.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): Visio.Application - Only available on collection types. It is similar to the preceding signature. Option.top specifies the maximum number of collection items that can be included in the result. Option.skip specifies the number of items that are to be skipped and not included in the result. If option.top is specified, the result set will start after skipping the specified number of items.

Examples

Visio.run(session, function (ctx) {
    var 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));
    }
});

showToolbar(id, show)

Sets the visibility of a specific toolbar in the application.

[ API set: 1.1 ]

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

Parameters

id
Visio.ToolBarType

The type of the Toolbar

show
boolean

Whether the toolbar is visibile or not.

Returns

void

toJSON()

toJSON(): Visio.Interfaces.ApplicationData;

Returns

Visio.Interfaces.ApplicationData