OneNote.Interfaces.PageCollectionLoadOptions interface

Package:

onenote

Represents a collection of pages.

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).
classNotebookPageSource	For EACH ITEM in the collection: Gets the ClassNotebookPageSource to the page.
clientUrl	For EACH ITEM in the collection: The client URL of the page. Read-only.
contents	For EACH ITEM in the collection: The collection of PageContent objects on the page. Read only
id	For EACH ITEM in the collection: Gets the ID of the page. Read-only.
inkAnalysisOrNull	For EACH ITEM in the collection: Text interpretation for the ink on the page. Returns null if there is no ink analysis information. Read-only.
pageLevel	For EACH ITEM in the collection: Gets or sets the indentation level of the page.
parentSection	For EACH ITEM in the collection: Gets the section that contains the page.
title	For EACH ITEM in the collection: Gets or sets the title of the page.
webUrl	For EACH ITEM in the collection: The web url of the page. 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

classNotebookPageSource

For EACH ITEM in the collection: Gets the ClassNotebookPageSource to the page.

classNotebookPageSource?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

clientUrl

For EACH ITEM in the collection: The client URL of the page. Read-only.

clientUrl?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

contents

For EACH ITEM in the collection: The collection of PageContent objects on the page. Read only

contents?: OneNote.Interfaces.PageContentCollectionLoadOptions;

Property Value

OneNote.Interfaces.PageContentCollectionLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

id

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

id?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

inkAnalysisOrNull

For EACH ITEM in the collection: Text interpretation for the ink on the page. Returns null if there is no ink analysis information. Read-only.

inkAnalysisOrNull?: OneNote.Interfaces.InkAnalysisLoadOptions;

Property Value

OneNote.Interfaces.InkAnalysisLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

pageLevel

For EACH ITEM in the collection: Gets or sets the indentation level of the page.

pageLevel?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

parentSection

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

parentSection?: OneNote.Interfaces.SectionLoadOptions;

Property Value

OneNote.Interfaces.SectionLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

title

For EACH ITEM in the collection: Gets or sets the title of the page.

title?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

webUrl

For EACH ITEM in the collection: The web url of the page. Read only

webUrl?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]