OneNote.RichText class

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Ruft die ID des RichText-Objekts ab.

readonly id: string;

Eigenschaftswert

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Die Sprachen-ID des Texts.

readonly languageId: string;

Eigenschaftswert

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Ruft das Paragraph-Objekt ab, das das RichText-Objekt enthält.

readonly paragraph: OneNote.Paragraph;

Eigenschaftswert

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Ruft die Textart des RichText-Objekts ab. Schreibgeschützt.

readonly style: OneNote.ParagraphStyle;

Eigenschaftswert

Hinweise

[ API-Satz: OneNoteApi 1.8 ]

Ruft den Textinhalt des RichText-Objekts ab. Schreibgeschützt.

readonly text: string;

Eigenschaftswert

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Ruft den HTML-Code des Rich-Texts ab.

getHtml(): OfficeExtension.ClientResult<string>;

Gibt zurück

Der HTML-Code des Rich-Texts

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(options?: OneNote.Interfaces.RichTextLoadOptions): OneNote.RichText;

Parameter

Gibt zurück

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

load(propertyNames?: string | string[]): OneNote.RichText;

Parameter

Gibt zurück

Beispiele

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();
});

Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie "context.sync()" aufrufen.

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

Parameter

Gibt zurück

Überschreibt die JavaScript-Methode toJSON() , um eine nützlichere Ausgabe bereitzustellen, wenn ein API-Objekt an JSON.stringify()übergeben wird. (JSON.stringifyruft wiederum die toJSON -Methode des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche OneNote.RichText Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als OneNote.Interfaces.RichTextData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): OneNote.Interfaces.RichTextData;

Gibt zurück

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzform für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe hinweg und außerhalb der sequenziellen Ausführung eines ".run"-Batches verwenden und beim Festlegen einer Eigenschaft oder beim Aufrufen einer Methode für das Objekt den Fehler "InvalidObjectPath" erhalten, müssen Sie das Objekt der nachverfolgten Objektauflistung hinzufügen, als das Objekt zum ersten Mal erstellt wurde.

track(): OneNote.RichText;

Gibt zurück

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für context.trackedObjects.remove(thisObject). Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen aufrufen context.sync() , bevor die Speicherfreigabe wirksam wird.

untrack(): OneNote.RichText;

Gibt zurück