OneNote.Interfaces.SectionGroupCollectionLoadOptions interface

Package:

onenote

Represents a collection of section groups.

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 group. Read only
id	For EACH ITEM in the collection: Gets the ID of the section group. Read-only.
name	For EACH ITEM in the collection: Gets the name of the section group. Read-only.
notebook	For EACH ITEM in the collection: Gets the notebook that contains the section group.
parentSectionGroup	For EACH ITEM in the collection: Gets the section group that contains the section group. Throws ItemNotFound if the section group is a direct child of the notebook.
parentSectionGroupOrNull	For EACH ITEM in the collection: Gets the section group that contains the section group. Returns null if the section group is a direct child of the notebook.
sectionGroups	For EACH ITEM in the collection: The collection of section groups in the section group. Read-only.
sections	For EACH ITEM in the collection: The collection of sections in the section group. 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 group. 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 group. Read-only.

id?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

name

For EACH ITEM in the collection: Gets the name of the section group. 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 group.

notebook?: OneNote.Interfaces.NotebookLoadOptions;

Property Value

OneNote.Interfaces.NotebookLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

parentSectionGroup

For EACH ITEM in the collection: Gets the section group that contains the section group. Throws ItemNotFound if the section group 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 group. Returns null if the section group is a direct child of the notebook.

parentSectionGroupOrNull?: OneNote.Interfaces.SectionGroupLoadOptions;

Property Value

OneNote.Interfaces.SectionGroupLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

sectionGroups

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

sections?: OneNote.Interfaces.SectionCollectionLoadOptions;

Property Value

OneNote.Interfaces.SectionCollectionLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]