OneNote.RichText 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

Gets the ID of the RichText object.

readonly id: string;

Property Value

Remarks

[ API set: OneNoteApi 1.1 ]

The language id of the text.

readonly languageId: string;

Property Value

Remarks

[ API set: OneNoteApi 1.1 ]

Gets the Paragraph object that contains the RichText object.

readonly paragraph: OneNote.Paragraph;

Property Value

Remarks

[ API set: OneNoteApi 1.1 ]

Gets the text style of the RichText object. Read-only.

readonly style: OneNote.ParagraphStyle;

Property Value

Remarks

[ API set: OneNoteApi 1.8 ]

Gets the text content of the RichText object. Read-only.

readonly text: string;

Property Value

Remarks

[ API set: OneNoteApi 1.1 ]

Gets the HTML of the rich text.

getHtml(): OfficeExtension.ClientResult<string>;

Returns

The html of the rich text

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.RichTextLoadOptions): OneNote.RichText;

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

Parameters

Returns

Examples

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

    // Get the collection of pageContent items from the page.
    const pageContents = context.application.getActivePage().contents;

    // Get the first PageContent on the page, and then get its outline's paragraphs.
    const outlinePageContents = pageContents.getItem(0);
    let paragraphs = outlinePageContents.outline.paragraphs;
    const richTextParagraphs = paragraphs.items;
    // Queue a command to load the id and type of each page content in the outline.
    pageContents.load("id,type");

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

    // Load all page contents of type Outline.
    $.each(pageContents.items, function(index, pageContent) {
        if(pageContent.type == 'Outline')
        {
            pageContent.load('outline,outline/paragraphs,outline/paragraphs/type');
            outlinePageContents.push(pageContent);
        }
    });
    await context.sync();

    // Load all rich text paragraphs across outlines.
    $.each(outlinePageContents, function(index, outlinePageContent) {
        const outline = outlinePageContent.outline;
        paragraphs = paragraphs.concat(outline.paragraphs.items);
    });
    $.each(paragraphs, function(index, paragraph) {
        if(paragraph.type == 'RichText')
        {
            richTextParagraphs.push(paragraph);
            paragraph.load("id,richText/text");
        }
    });
    await context.sync();

    // Display all rich text paragraphs to the console.
    $.each(richTextParagraphs, function(index, richTextParagraph) {
        const richText = richTextParagraph.richText;
        console.log(
            "Paragraph found with richtext content : " + 
            richText.text + " and richtext id : " + richText.id);
    });
    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?: {
            select?: string;
            expand?: string;
        }): OneNote.RichText;

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

toJSON(): OneNote.Interfaces.RichTextData;

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

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

Returns