Edit

Share via

OneNote.Interfaces.NotebookLoadOptions interface

  • Reference
Package:
onenote

Represents a OneNote notebook. Notebooks contain section groups and sections.

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

The URL of the site where this notebook is located. Read-only.
clientUrl

The client URL of the notebook. Read-only.
id

Gets the ID of the notebook. Read-only.
isVirtual

True if the notebook isn't created by the user (i.e., 'Misplaced Sections'). Read-only.
name

Gets the name of the notebook. Read-only.
sectionGroups

The section groups in the notebook. Read-only.
sections

The sections of the notebook. 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

baseUrl

The URL of the site where this notebook is located. Read-only.

baseUrl?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

clientUrl

The client URL of the notebook. Read-only.

clientUrl?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

id

Gets the ID of the notebook. Read-only.

id?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

isVirtual

True if the notebook isn't created by the user (i.e., 'Misplaced Sections'). Read-only.

isVirtual?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.2 ]

name

Gets the name of the notebook. Read-only.

name?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

sectionGroups

The section groups in the notebook. Read-only.

sectionGroups?: OneNote.Interfaces.SectionGroupCollectionLoadOptions;

Property Value

OneNote.Interfaces.SectionGroupCollectionLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

sections

The sections of the notebook. Read-only.

sections?: OneNote.Interfaces.SectionCollectionLoadOptions;

Property Value

OneNote.Interfaces.SectionCollectionLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]