Edit

Share via

Visio.Interfaces.PageCollectionLoadOptions interface

  • Reference
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. Read-only.
index

For EACH ITEM in the collection: Index of the Page. Read-only.
isBackground

For EACH ITEM in the collection: Whether the page is a background page or not. Read-only.
name

For EACH ITEM in the collection: Page name. Read-only.
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. Read-only.

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).

TypeScript 
$all?: boolean;

Property Value

boolean

height

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

TypeScript 
height?: boolean;

Property Value

boolean

Remarks

[ API set: 1.1 ]

index

For EACH ITEM in the collection: Index of the Page. Read-only.

TypeScript 
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. Read-only.

TypeScript 
isBackground?: boolean;

Property Value

boolean

Remarks

[ API set: 1.1 ]

name

For EACH ITEM in the collection: Page name. Read-only.

TypeScript 
name?: boolean;

Property Value

boolean

Remarks

[ API set: 1.1 ]

view

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

TypeScript 
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. Read-only.

TypeScript 
width?: boolean;

Property Value

boolean

Remarks

[ API set: 1.1 ]