OneNote.Interfaces.PageLoadOptions interface

Package:

onenote

Represents a OneNote page.

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

Gets the ClassNotebookPageSource to the page.

classNotebookPageSource?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

clientUrl

The client URL of the page. Read-only.

clientUrl?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

contents

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

Gets the ID of the page. Read-only.

id?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

inkAnalysisOrNull

Text interpretation for the ink on the page. Returns null if there is no ink analysis information.

inkAnalysisOrNull?: OneNote.Interfaces.InkAnalysisLoadOptions;

Property Value

OneNote.Interfaces.InkAnalysisLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

pageLevel

Gets or sets the indentation level of the page.

pageLevel?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

parentSection

Gets the section that contains the page.

parentSection?: OneNote.Interfaces.SectionLoadOptions;

Property Value

OneNote.Interfaces.SectionLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

title

Gets or sets the title of the page.

title?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

webUrl

The web URL of the page. Read-only.

webUrl?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]