Edit

Share via

OneNote.Interfaces.SectionGroupLoadOptions interface

  • Reference
Package:
onenote

Represents a OneNote section group. Section groups can contain sections and other 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

The client URL of the section group. Read.only.
id

Gets the ID of the section group. Read-only.
name

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

Gets the notebook that contains the section group.
parentSectionGroup

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

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

The collection of section groups in the section group. Read-only.
sections

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

The client URL of the section group. Read.only.

clientUrl?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

id

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

id?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

name

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

name?: boolean;

Property Value

boolean

Remarks

[ API set: OneNoteApi 1.1 ]

notebook

Gets the notebook that contains the section group.

notebook?: OneNote.Interfaces.NotebookLoadOptions;

Property Value

OneNote.Interfaces.NotebookLoadOptions

Remarks

[ API set: OneNoteApi 1.1 ]

parentSectionGroup

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

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

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

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 ]