Visio.PageCollection class

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

[ API set: 1.1 ]

Extends
OfficeExtension.ClientObject

Properties

items

Gets the loaded child items in this collection.

Methods

getCount()

Gets the number of pages in the collection.

[ API set: 1.1 ]

getItem(key)

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

[ API set: 1.1 ]

load(option)

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

toJSON()

Property Details

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.

[ API set: 1.1 ]

getCount(): OfficeExtension.ClientResult<number>;

Returns

OfficeExtension.ClientResult<number>

getItem(key)

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

[ API set: 1.1 ]

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

Examples

Visio.run(session, function (ctx) {
    var pageName = 'Page-1';
    var 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(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.PageCollection;

Parameters

option
string | string[]

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

Returns

Visio.PageCollection

Remarks

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

load(option?: { select?: string; expand?: string; }): Visio.PageCollection - 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.PageCollection - 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.

toJSON()

toJSON(): Visio.Interfaces.PageCollectionData;

Returns

Visio.Interfaces.PageCollectionData