Edit

Share via

OneNote.Interfaces.SectionLoadOptions interface

  • Reference
Package:
onenote

Represents a OneNote section. Sections can contain pages.

Remarks

[ API set: OneNoteApi 1.1 ]

Properties

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).
clientUrl

The client url of the section. Read only
id

Gets the ID of the section. Read-only.
isEncrypted

True if this section is encrypted with a password. Read only
isLocked

True if this section is locked. Read only
name

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

Gets the notebook that contains the section.
pages

The collection of pages in the section. Read only
parentSectionGroup

Gets the section group that contains the section. Throws ItemNotFound if the section is a direct child of the notebook.
parentSectionGroupOrNull

Gets the section group that contains the section. Returns null if the section is a direct child of the notebook.
webUrl

The web url of the page. Read only

Property Details

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

$all?: boolean;

Property Value

boolean

clientUrl

The client url of the section. Read only

clientUrl?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

id

Gets the ID of the section. Read-only.

id?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

isEncrypted

True if this section is encrypted with a password. Read only

isEncrypted?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.2 ]

isLocked

True if this section is locked. Read only

isLocked?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.2 ]

name

Gets the name of the section. Read-only.

name?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

notebook

Gets the notebook that contains the section.

notebook?: OneNote.Interfaces.NotebookLoadOptions;

Property Value

OneNote.Interfaces.NotebookLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

pages

The collection of pages in the section. Read only

pages?: OneNote.Interfaces.PageCollectionLoadOptions;

Property Value

OneNote.Interfaces.PageCollectionLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

parentSectionGroup

Gets the section group that contains the section. Throws ItemNotFound if the section is a direct child of the notebook.

parentSectionGroup?: OneNote.Interfaces.SectionGroupLoadOptions;

Property Value

OneNote.Interfaces.SectionGroupLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

parentSectionGroupOrNull

Gets the section group that contains the section. Returns null if the section is a direct child of the notebook.

parentSectionGroupOrNull?: OneNote.Interfaces.SectionGroupLoadOptions;

Property Value

OneNote.Interfaces.SectionGroupLoadOptions

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 ]