Visio.Interfaces.PageCollectionLoadOptions interface

Package:

visio

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

Remarks

[ API set: 1.1 ]

Properties

$all	Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).
height	For EACH ITEM in the collection: Returns the height of the page.
index	For EACH ITEM in the collection: Index of the Page.
isBackground	For EACH ITEM in the collection: Whether the page is a background page or not.
name	For EACH ITEM in the collection: Page name.
view	For EACH ITEM in the collection: Returns the view of the page.
width	For EACH ITEM in the collection: Returns the width of the page.

Property Details

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

$all?: boolean;

Property Value

boolean

height

For EACH ITEM in the collection: Returns the height of the page.

height?: boolean;

Property Value

boolean

Remarks

[ API set: 1.1 ]

index

For EACH ITEM in the collection: Index of the Page.

index?: boolean;

Property Value

boolean

Remarks

[ API set: 1.1 ]

isBackground

For EACH ITEM in the collection: Whether the page is a background page or not.

isBackground?: boolean;

Property Value

boolean

Remarks

[ API set: 1.1 ]

name

For EACH ITEM in the collection: Page name.

name?: boolean;

Property Value

boolean

Remarks

[ API set: 1.1 ]

view

For EACH ITEM in the collection: Returns the view of the page.

view?: Visio.Interfaces.PageViewLoadOptions;

Property Value

Visio.Interfaces.PageViewLoadOptions

Remarks

[ API set: 1.1 ]

width

For EACH ITEM in the collection: Returns the width of the page.

width?: boolean;

Property Value

boolean

Remarks

[ API set: 1.1 ]