OneNote.Interfaces.PageContentCollectionLoadOptions interface

Package:

onenote

Represents the contents of a page, as a collection of PageContent objects.

Remarks

[ API set: OneNoteApi 1.1 ]

Properties

$all	Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
id	For EACH ITEM in the collection: Gets the ID of the PageContent object. Read-only.
image	For EACH ITEM in the collection: Gets the Image in the PageContent object. Throws an exception if PageContentType isn't Image.
ink	For EACH ITEM in the collection: Gets the ink in the PageContent object. Throws an exception if PageContentType isn't Ink.
left	For EACH ITEM in the collection: Gets or sets the left (X-axis) position of the PageContent object.
outline	For EACH ITEM in the collection: Gets the Outline in the PageContent object. Throws an exception if PageContentType isn't Outline.
parentPage	For EACH ITEM in the collection: Gets the page that contains the PageContent object.
top	For EACH ITEM in the collection: Gets or sets the top (Y-axis) position of the PageContent object.
type	For EACH ITEM in the collection: Gets the type of the PageContent object. Read-only.

Property Details

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

id

For EACH ITEM in the collection: Gets the ID of the PageContent object. Read-only.

id?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

image

For EACH ITEM in the collection: Gets the Image in the PageContent object. Throws an exception if PageContentType isn't Image.

image?: OneNote.Interfaces.ImageLoadOptions;

Property Value

OneNote.Interfaces.ImageLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

ink

For EACH ITEM in the collection: Gets the ink in the PageContent object. Throws an exception if PageContentType isn't Ink.

ink?: OneNote.Interfaces.FloatingInkLoadOptions;

Property Value

OneNote.Interfaces.FloatingInkLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

left

For EACH ITEM in the collection: Gets or sets the left (X-axis) position of the PageContent object.

left?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

outline

For EACH ITEM in the collection: Gets the Outline in the PageContent object. Throws an exception if PageContentType isn't Outline.

outline?: OneNote.Interfaces.OutlineLoadOptions;

Property Value

OneNote.Interfaces.OutlineLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

parentPage

For EACH ITEM in the collection: Gets the page that contains the PageContent object.

parentPage?: OneNote.Interfaces.PageLoadOptions;

Property Value

OneNote.Interfaces.PageLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

top

For EACH ITEM in the collection: Gets or sets the top (Y-axis) position of the PageContent object.

top?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

type

For EACH ITEM in the collection: Gets the type of the PageContent object. Read-only.

type?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]