Document object (JavaScript API for Visio)

Applies to: Visio Online

Represents the Document class.

Properties

None

Relationships

Relationship	Type	Description
application	Application	Represents a Visio application instance that contains this document. Read-only.
pages	PageCollection	Represents a collection of pages associated with the document. Read-only.
view	DocumentView	Returns the DocumentView object. Read-only.

Methods

Method	Return Type	Description
getActivePage()	Page	Returns the Active Page of the document.
load(param: object)	void	Fills the proxy object created in JavaScript layer with property and object values specified in the parameter.
setActivePage(PageName: string)	void	Set the Active Page of the document.
startDataRefresh()	void	Triggers the refresh of the data in the Diagram, for all pages.

Method Details

getActivePage()

Returns the Active Page of the document.

Syntax

documentObject.getActivePage();

Parameters

None

Returns

Page

Examples

Visio.run(function (ctx) { 
    var document = ctx.document;
    var activePage = document.getActivePage();
    activePage.load();
    return ctx.sync().then(function () {
    console.log("pageName: " +activePage.name);
      });   
}).catch(function(error) {
        console.log("Error: " + error);
        if (error instanceof OfficeExtension.Error) {
            console.log("Debug info: " + JSON.stringify(error.debugInfo));
        }
});

load(param: object)

Fills the proxy object created in JavaScript layer with property and object values specified in the parameter.

Syntax

object.load(param);

Parameters

Parameter	Type	Description
param	object	Optional. Accepts parameter and relationship names as delimited string or an array. Or, provide loadOption object.

Returns

void

setActivePage(PageName: string)

Set the Active Page of the document.

Syntax

documentObject.setActivePage(PageName);

Parameters

Parameter	Type	Description
PageName	string	Name of the page

Returns

void

Examples

Visio.run(function (ctx) { 
    var document = ctx.document;
    var pageName = "Page-1";
    document.setActivePage(pageName);
    return ctx.sync();
}).catch(function(error) {
        console.log("Error: " + error);
        if (error instanceof OfficeExtension.Error) {
            console.log("Debug info: " + JSON.stringify(error.debugInfo));
        }
});

startDataRefresh()

Triggers the refresh of the data in the Diagram, for all pages.

Syntax

documentObject.startDataRefresh();

Parameters

None

Returns

void

Examples

js Visio.run(function (ctx) { var document = ctx.document; document.startDataRefresh(); return ctx.sync(); }).catch(function(error) { console.log("Error: " + error); if (error instanceof OfficeExtension.Error) { console.log("Debug info: " + JSON.stringify(error.debugInfo)); } });### Property access examples

Visio.run(function (ctx) { 
    var pages = ctx.document.pages;
    var pageCount = pages.getCount();
    return ctx.sync().then(function () {
        console.log("Pages Count: " +pageCount.value);
        });
}).catch(function(error) {
        console.log("Error: " + error);
        if (error instanceof OfficeExtension.Error) {
            console.log("Debug info: " + JSON.stringify(error.debugInfo));
        }
});

Property access examples

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

Property access examples

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