OneNote.Interfaces.NotebookCollectionLoadOptions interface

Package:

onenote

Represents a collection of notebooks.

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	For EACH ITEM in the collection: The URL of the site where this notebook is located. Read-only.
clientUrl	For EACH ITEM in the collection: The client URL of the notebook. Read-only.
id	For EACH ITEM in the collection: Gets the ID of the notebook. Read-only.
isVirtual	For EACH ITEM in the collection: True if the notebook isn't created by the user (i.e., 'Misplaced Sections'). Read-only.
name	For EACH ITEM in the collection: Gets the name of the notebook. Read-only.
sectionGroups	For EACH ITEM in the collection: The section groups in the notebook. Read only
sections	For EACH ITEM in the collection: 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

For EACH ITEM in the collection: The URL of the site where this notebook is located. Read-only.

baseUrl?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

clientUrl

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

clientUrl?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

id

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

id?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

isVirtual

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Gets the name of the notebook. Read-only.

name?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

sectionGroups

For EACH ITEM in the collection: The section groups in the notebook. Read only

sectionGroups?: OneNote.Interfaces.SectionGroupCollectionLoadOptions;

Property Value

OneNote.Interfaces.SectionGroupCollectionLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

sections

For EACH ITEM in the collection: The sections of the notebook. Read-only.

sections?: OneNote.Interfaces.SectionCollectionLoadOptions;

Property Value

OneNote.Interfaces.SectionCollectionLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]