Visio.PageCollection class

Package:

visio

Represents a collection of Page objects that are part of the document.

Extends

OfficeExtension.ClientObject

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.
items	Gets the loaded child items in this collection.

Methods

getCount()	Gets the number of pages in the collection.
getItem(key)	Gets a page using its key (name or Id).
load(options)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
setMockData(data)	Set mock data
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.PageCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Visio.Interfaces.PageCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

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

Visio.RequestContext

items

Gets the loaded child items in this collection.

readonly items: Visio.Page[];

Property Value

Visio.Page[]

Method Details

getCount()

Gets the number of pages in the collection.

getCount(): OfficeExtension.ClientResult<number>;

Returns

OfficeExtension.ClientResult<number>

Remarks

[ API set: 1.1 ]

getItem(key)

Gets a page using its key (name or Id).

getItem(key: number | string): Visio.Page;

Parameters

key

number | string

Key is the name or Id of the page to be retrieved.

Returns

Visio.Page

Remarks

[ API set: 1.1 ]

Examples

Visio.run(session, function (ctx) {
    const pageName = 'Page-1';
    const page = ctx.document.pages.getItem(pageName);
    page.activate();
    return ctx.sync();
}).catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

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.PageCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions): Visio.PageCollection;

Parameters

options

Visio.Interfaces.PageCollectionLoadOptions & Visio.Interfaces.CollectionLoadOptions

Provides options for which properties of the object to load.

Returns

Visio.PageCollection

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.PageCollection;

Parameters

propertyNames

string | string[]

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

Returns

Visio.PageCollection

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?: OfficeExtension.LoadOption): Visio.PageCollection;

Parameters

propertyNamesAndPaths

OfficeExtension.LoadOption

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

Visio.PageCollection

setMockData(data)

Set mock data

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

Parameters

data

Visio.Interfaces.PageCollectionData

Returns

void

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.PageCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as Visio.Interfaces.PageCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): Visio.Interfaces.PageCollectionData;

Returns

Visio.Interfaces.PageCollectionData