Edit

Visio.Interfaces.PageCollectionLoadOptions interface

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

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

$all?: boolean;

Property Value

boolean

height

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

height?: boolean;

Property Value

boolean

Remarks

API set: 1.1

index

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

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.

isBackground?: boolean;

Property Value

boolean

Remarks

API set: 1.1

name

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

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

Remarks

API set: 1.1

width

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

width?: boolean;

Property Value

boolean

Remarks

API set: 1.1