OneNote.Interfaces.NotebookCollectionLoadOptions interface
Represents a collection of notebooks.
Remarks
Properties
$all | Specifying |
base |
For EACH ITEM in the collection: The url of the site where this notebook is located. Read only |
client |
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. |
is |
For EACH ITEM in the collection: True if the notebook is not 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. |
section |
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 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
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
clientUrl
For EACH ITEM in the collection: The client url of the notebook. Read only
clientUrl?: boolean;
Property Value
boolean
Remarks
id
For EACH ITEM in the collection: Gets the ID of the notebook. Read-only.
id?: boolean;
Property Value
boolean
Remarks
isVirtual
For EACH ITEM in the collection: True if the notebook is not created by the user (i.e., 'Misplaced Sections'). Read only
isVirtual?: boolean;
Property Value
boolean
Remarks
name
For EACH ITEM in the collection: Gets the name of the notebook. Read-only.
name?: boolean;
Property Value
boolean
Remarks
sectionGroups
For EACH ITEM in the collection: The section groups in the notebook. Read only
sectionGroups?: OneNote.Interfaces.SectionGroupCollectionLoadOptions;
Property Value
Remarks
sections
For EACH ITEM in the collection: The sections of the notebook. Read only
sections?: OneNote.Interfaces.SectionCollectionLoadOptions;
Property Value
Remarks
Office Add-ins