OneNote.Interfaces.PageCollectionLoadOptions interface
Represents a collection of pages.
Remarks
Properties
| $all | Specifying |
| class |
For EACH ITEM in the collection: Gets the ClassNotebookPageSource to the page. |
| client |
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. |
| ink |
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. |
| page |
For EACH ITEM in the collection: Gets or sets the indentation level of the page. |
| parent |
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. |
| web |
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
clientUrl
For EACH ITEM in the collection: The client URL of the page. Read-only.
clientUrl?: boolean;
Property Value
boolean
Remarks
contents
For EACH ITEM in the collection: The collection of PageContent objects on the page. Read only
contents?: OneNote.Interfaces.PageContentCollectionLoadOptions;
Property Value
Remarks
id
For EACH ITEM in the collection: Gets the ID of the page. Read-only.
id?: boolean;
Property Value
boolean
Remarks
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
Remarks
pageLevel
For EACH ITEM in the collection: Gets or sets the indentation level of the page.
pageLevel?: boolean;
Property Value
boolean
Remarks
parentSection
For EACH ITEM in the collection: Gets the section that contains the page.
parentSection?: OneNote.Interfaces.SectionLoadOptions;
Property Value
Remarks
title
For EACH ITEM in the collection: Gets or sets the title of the page.
title?: boolean;
Property Value
boolean
Remarks
webUrl
For EACH ITEM in the collection: The web url of the page. Read only
webUrl?: boolean;
Property Value
boolean