OneNote.Page class

Gets the ClassNotebookPageSource to the page.

readonly classNotebookPageSource: string;

Property Value

Remarks

[ API set: OneNoteApi 1.1 ]

The client url of the page.

readonly clientUrl: string;

Property Value

Remarks

[ API set: OneNoteApi 1.1 ]

The collection of PageContent objects on the page. Read only

readonly contents: OneNote.PageContentCollection;

Property Value

Remarks

[ API set: OneNoteApi 1.1 ]

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

Gets the ID of the page.

readonly id: string;

Property Value

Remarks

[ API set: OneNoteApi 1.1 ]

Text interpretation for the ink on the page. Returns null if there is no ink analysis information.

readonly inkAnalysisOrNull: OneNote.InkAnalysis;

Property Value

Remarks

[ API set: OneNoteApi 1.1 ]

Gets or sets the indentation level of the page.

pageLevel: number;

Property Value

Remarks

[ API set: OneNoteApi 1.1 ]

Gets the section that contains the page.

readonly parentSection: OneNote.Section;

Property Value

Remarks

[ API set: OneNoteApi 1.1 ]

Gets or sets the title of the page.

title: string;

Property Value

Remarks

[ API set: OneNoteApi 1.1 ]

The web url of the page.

readonly webUrl: string;

Property Value

Remarks

[ API set: OneNoteApi 1.1 ]

Adds an Outline to the page at the specified position.

addOutline(left: number, top: number, html: string): OneNote.Outline;

Parameters

Returns

Remarks

[ API set: OneNoteApi 1.1 ]

Examples

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

    // Gets the active page.
    const page = context.application.getActivePage();

    // Queue a command to add an outline with given html.
    const outline = page.addOutline(200, 200,
"<p>Images and a table below:</p> \
 <img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==\"> \
 <img src=\"http://imagenes.es.sftcdn.net/es/scrn/6653000/6653659/microsoft-onenote-2013-01-535x535.png\"> \
 <table> \
   <tr> \
     <td>Jill</td> \
     <td>Smith</td> \
     <td>50</td> \
   </tr> \
   <tr> \
     <td>Eve</td> \
     <td>Jackson</td> \
     <td>94</td> \
   </tr> \
 </table>"     
        );

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
});

Return a JSON string with node ID and content in HTML format.

analyzePage(): OfficeExtension.ClientResult<string>;

Returns

Remarks

[ API set: OneNoteApi 1.1 ]

Inserts a new page with translated content.

applyTranslation(translatedContent: string): void;

Parameters

Returns

Remarks

[ API set: OneNoteApi 1.1 ]

Copies this page to specified section.

copyToSection(destinationSection: OneNote.Section): OneNote.Page;

Parameters

Returns

Remarks

[ API set: OneNoteApi 1.1 ]

Examples

await OneNote.run(async (context) => {
    const app = context.application;
    
    // Gets the active notebook.
    const notebook = app.getActiveNotebook();
    
    // Gets the active page.
    const page = app.getActivePage();
    
    // Queue a command to load sections under the notebook.
    notebook.load('sections');
    
    let newPage;
    
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();

    const section = notebook.sections.items[0];
    
    // Copy page to the section.
    newPage = page.copyToSection(section);
    newPage.load('id');
    await context.sync();
    
    console.log(newPage.id);
});

Copies this page to specified section and sets ClassNotebookPageSource.

copyToSectionAndSetClassNotebookPageSource(destinationSection: OneNote.Section): OneNote.Page;

Parameters

Returns

Remarks

[ API set: OneNoteApi 1.1 ]

Gets the REST API ID.

getRestApiId(): OfficeExtension.ClientResult<string>;

Returns

Remarks

[ API set: OneNoteApi 1.1 ]

Examples

await OneNote.run(async (context) => {
    // Get the current page.
    const page = context.application.getActivePage();
    const restApiId = page.getRestApiId();

    await context.sync();
    console.log("The REST API ID is " + restApiId.value);
    // Note that the REST API ID isn't all you need to interact with the OneNote REST API.
    // This is only required for SharePoint notebooks. baseUrl will be null for OneDrive notebooks.
    // For SharePoint notebooks, the notebook baseUrl should be used to talk to the OneNote REST API
    // according to the OneNote Development Blog.
    // https://learn.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
});

Does the page has content title.

hasTitleContent(): OfficeExtension.ClientResult<boolean>;

Returns

Remarks

[ API set: OneNoteApi 1.1 ]

Inserts a new page before or after the current page.

insertPageAsSibling(location: OneNote.InsertLocation, title: string): OneNote.Page;

Parameters

Returns

Remarks

[ API set: OneNoteApi 1.1 ]

Inserts a new page before or after the current page.

insertPageAsSibling(locationString: "Before" | "After", title: string): OneNote.Page;

Parameters

Returns

Remarks

[ API set: OneNoteApi 1.1 ]

Examples

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

    // Gets the active page.
    const activePage = context.application.getActivePage();

    // Queue a command to add a new page after the active page.
    const newPage = activePage.insertPageAsSibling("After", "Next Page");

    // Queue a command to load the newPage to access its data.
    context.load(newPage);

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    console.log("page is created with title: " + newPage.title);
});

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.PageLoadOptions): OneNote.Page;

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

Parameters

Returns

Examples

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

    // Gets the active page.
    const activePage = context.application.getActivePage();

    // Queue a command to add a new page after the active page.
    const pageContents = activePage.contents;

    // Queue a command to load the pageContents to access its data.
    context.load(pageContents);

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync()
    for(let i=0; i < pageContents.items.length; i++) {
        const pageContent = pageContents.items[i];
        if (pageContent.type == "Outline") {
            console.log("Found an outline");
        } else if (pageContent.type == "Image") {
            console.log("Found an image");
        } else if (pageContent.type == "Other") {
            console.log("Found a type not supported yet.");
        }
    }
});

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): OneNote.Page;

Parameters

Returns

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.PageUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

Returns

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: OneNote.Page): void;

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.Page object is an API object, the toJSON method returns a plain JavaScript object (typed as OneNote.Interfaces.PageData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): OneNote.Interfaces.PageData;

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

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

Returns