OneNote.SectionGroupCollection class
Represents a collection of section groups.
- Extends
Remarks
Properties
| context | The request context associated with the object. This connects the add-in's process to the Office host application's process. |
| count | Returns the number of section groups in the collection. |
| items | Gets the loaded child items in this collection. |
Methods
| get |
Gets the collection of section groups with the specified name. |
| get |
Gets a section group by ID or by its index in the collection. Read-only. |
| get |
Gets a section group on its position in the collection. |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| toJSON() | Overrides the JavaScript |
| track() | Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across |
| untrack() | Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call |
Property Details
context
The request context associated with the object. This connects the add-in's process to the Office host application's process.
context: RequestContext;Property Value
count
Returns the number of section groups in the collection.
readonly count: number;Property Value
number
Remarks
items
Gets the loaded child items in this collection.
readonly items: OneNote.SectionGroup[];Property Value
Method Details
getByName(name)
Gets the collection of section groups with the specified name.
getByName(name: string): OneNote.SectionGroupCollection;Parameters
- name
-
string
The name of the section group.
Returns
Remarks
Examples
await OneNote.run(async (context) => {
// Get the section groups that are direct children of the current notebook.
const sectionGroups = context.application.getActiveNotebook().sectionGroups;
// Queue a command to load the section groups.
// For best performance, request specific properties.
sectionGroups.load("id");
// Get the section groups with the specified name.
const labsSectionGroups = sectionGroups.getByName("Labs");
// Queue a command to load the section groups with the specified properties.
labsSectionGroups.load("id,name");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Iterate through the collection or access items individually by index.
if (labsSectionGroups.items.length > 0) {
console.log("Section group name: " + labsSectionGroups.items[0].name);
console.log("Section group ID: " + labsSectionGroups.items[0].id);
}
});
getItem(index)
Gets a section group by ID or by its index in the collection. Read-only.
getItem(index: number | string): OneNote.SectionGroup;Parameters
- index
-
number | string
The ID of the section group, or the index location of the section group in the collection.
Returns
Remarks
getItemAt(index)
Gets a section group on its position in the collection.
getItemAt(index: number): OneNote.SectionGroup;Parameters
- index
-
number
Index value of the object to be retrieved. Zero-indexed.
Returns
Remarks
load(options)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(options?: OneNote.Interfaces.SectionGroupCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions): OneNote.SectionGroupCollection;Parameters
- options
-
OneNote.Interfaces.SectionGroupCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions
Provides options for which properties of the object to load.
Returns
load(propertyNames)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames?: string | string[]): OneNote.SectionGroupCollection;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
Examples
await OneNote.run(async (context) => {
// Get the section groups that are direct children of the current notebook.
const sectionGroups = context.application.getActiveNotebook().sectionGroups;
// Queue a command to load the section groups.
// For best performance, request specific properties.
sectionGroups.load("name");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Iterate through the collection or access items individually by index.
// For example: sectionGroups.items[0]
$.each(sectionGroups.items, function(index, sectionGroup) {
console.log("Section group name: " + sectionGroup.name);
console.log("Section group ID: " + sectionGroup.id);
});
});
load(propertyNamesAndPaths)
Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.SectionGroupCollection;Parameters
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.
Returns
toJSON()
Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that's passed to it.) Whereas the original OneNote.SectionGroupCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as OneNote.Interfaces.SectionGroupCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.
toJSON(): OneNote.Interfaces.SectionGroupCollectionData;Returns
track()
Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created.
track(): OneNote.SectionGroupCollection;Returns
untrack()
Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.
untrack(): OneNote.SectionGroupCollection;Returns
Office Add-ins