Edit

Share via

OneNote.Interfaces.SectionCollectionLoadOptions interface

  • Reference
Package:
onenote

Represents a collection of 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).
clientUrl

For EACH ITEM in the collection: The client url of the section. Read only
id

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

For EACH ITEM in the collection: True if this section is encrypted with a password. Read only
isLocked

For EACH ITEM in the collection: True if this section is locked. Read-only.
name

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

For EACH ITEM in the collection: Gets the notebook that contains the section.
pages

For EACH ITEM in the collection: The collection of pages in the section. Read only
parentSectionGroup

For EACH ITEM in the collection: Gets the section group that contains the section. Throws ItemNotFound if the section is a direct child of the notebook.
parentSectionGroupOrNull

For EACH ITEM in the collection: Gets the section group that contains the section. Returns null if the section is a direct child of the notebook.
webUrl

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

clientUrl

For EACH ITEM in the collection: The client url of the section. 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 section. Read-only.

id?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

isEncrypted

For EACH ITEM in the collection: True if this section is encrypted with a password. Read only

isEncrypted?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.2 ]

isLocked

For EACH ITEM in the collection: True if this section is locked. Read-only.

isLocked?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.2 ]

name

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

name?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

notebook

For EACH ITEM in the collection: Gets the notebook that contains the section.

notebook?: OneNote.Interfaces.NotebookLoadOptions;

Property Value

OneNote.Interfaces.NotebookLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

pages

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

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

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

For EACH ITEM in the collection: The web URL of the page. Read-only.

webUrl?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]