OneNote.NotebookCollection class

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

Returns the number of notebooks in the collection.

readonly count: number;

Property Value

Remarks

[ API set: OneNoteApi 1.1 ]

Gets the loaded child items in this collection.

readonly items: OneNote.Notebook[];

Property Value

Gets the collection of notebooks with the specified name that are open in the application instance.

getByName(name: string): OneNote.NotebookCollection;

Parameters

Returns

Remarks

[ API set: OneNoteApi 1.1 ]

Examples

await OneNote.run(async (context) => {

    // Get the notebooks that are open in the application instance and have the specified name.
    const notebooks = context.application.notebooks.getByName("Homework");

    // Queue a command to load the notebooks.
    // For best performance, request specific properties.
    notebooks.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.
    // For example: notebooks.items[0]
    if (notebooks.items.length > 0) {
        console.log("Notebook name: " + notebooks.items[0].name);
        console.log("Notebook ID: " + notebooks.items[0].id);
    }
});

Gets a notebook by ID or by its index in the collection. Read-only.

getItem(index: number | string): OneNote.Notebook;

Parameters

Returns

Remarks

[ API set: OneNoteApi 1.1 ]

Gets a notebook on its position in the collection.

getItemAt(index: number): OneNote.Notebook;

Parameters

Returns

Remarks

[ API set: OneNoteApi 1.1 ]

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.NotebookCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions): OneNote.NotebookCollection;

Parameters

Returns

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.NotebookCollection;

Parameters

Returns

Examples

await OneNote.run(async (context) => {

    // Get the notebooks that are open in the application instance and have the specified name.
    const notebooks = context.application.notebooks.getByName("Homework");

    // Queue a command to load the notebooks.
    // For best performance, request specific properties.
    notebooks.load("id");

    // 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: notebooks.items[0]
    $.each(notebooks.items, function(index, notebook) {
        notebook.addSection("Biology");
        notebook.addSection("Spanish");
        notebook.addSection("Computer Science");
    });
    
    await context.sync();
});

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.NotebookCollection;

Parameters

Returns

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.NotebookCollection object is an API object, the toJSON method returns a plain JavaScript object (typed as OneNote.Interfaces.NotebookCollectionData) that contains an "items" array with shallow copies of any loaded properties from the collection's items.

toJSON(): OneNote.Interfaces.NotebookCollectionData;

Returns

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.NotebookCollection;

Returns

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.NotebookCollection;

Returns