Freigeben über

OneNote.Outline class

  • Referenz
Paket:
onenote

Stellt einen Container für Paragraph-Objekte dar.

Extends
OfficeExtension.ClientObject

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Eigenschaften

context

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

Ruft die ID des Outline-Objekts ab.
pageContent

Ruft das PageContent-Objekt, das die Gliederung enthält. Dieses Objekt definiert die Position der Gliederung auf der Seite.
paragraphs

Ruft die Auflistung von Paragraph-Objekten in der Gliederung ab.

Methoden

appendHtml(html)

Fügt den angegebenen HTML-Code am Ende der Gliederung hinzu.
appendImage(base64EncodedImage, width, height)

Fügt das angegebene Bild am Ende der Gliederung hinzu.
appendRichText(paragraphText)

Fügt den angegebenen Text am Ende der Gliederung hinzu.
appendTable(rowCount, columnCount, values)

Fügt eine Tabelle mit der angegebenen Anzahl von Zeilen und Spalten am Ende der Gliederung hinzu.
isTitle()

Überprüfen Sie, ob es sich bei der Gliederung um eine Titelgliederung handelt.
load(options)

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)

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)

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.
toJSON()

Ü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.Outline Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als OneNote.Interfaces.OutlineData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
track()

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.
untrack()

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.

Details zur Eigenschaft

context

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

context: RequestContext;

Eigenschaftswert

OneNote.RequestContext

id

Ruft die ID des Outline-Objekts ab.

readonly id: string;

Eigenschaftswert

string

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

pageContent

Ruft das PageContent-Objekt, das die Gliederung enthält. Dieses Objekt definiert die Position der Gliederung auf der Seite.

readonly pageContent: OneNote.PageContent;

Eigenschaftswert

OneNote.PageContent

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

paragraphs

Ruft die Auflistung von Paragraph-Objekten in der Gliederung ab.

readonly paragraphs: OneNote.ParagraphCollection;

Eigenschaftswert

OneNote.ParagraphCollection

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Details zur Methode

appendHtml(html)

Fügt den angegebenen HTML-Code am Ende der Gliederung hinzu.

appendHtml(html: string): void;

Parameter

html

string

Die HTML-Zeichenfolge, die angefügt werden soll. Weitere Informationen finden Sie unter Unterstütztes HTML für die JavaScript-API für OneNote-Add-Ins.

Gibt zurück

void

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Beispiele

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

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

    // Get pageContents of the activePage.
    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();
    if (pageContents.items.length != 0 && pageContents.items[0].type == "Outline")
    {
        // First item is an outline.
        const outline = pageContents.items[0].outline;

        // Queue a command to append a paragraph to the outline.
        outline.appendHtml("<p>new paragraph</p>");

        // Run the queued commands.
        await context.sync();
    }
});

appendImage(base64EncodedImage, width, height)

Fügt das angegebene Bild am Ende der Gliederung hinzu.

appendImage(base64EncodedImage: string, width: number, height: number): OneNote.Image;

Parameter

base64EncodedImage

string

HTML-Zeichenfolge, die angefügt werden soll.

width

number

Optional. Breite in der Maßeinheit Punkt. Der Standardwert ist null, und die Bildbreite wird beachtet.

height

number

Optional. Höhe in der Maßeinheit Punkt. Der Standardwert ist null, und die Bildhöhe wird beachtet.

Gibt zurück

OneNote.Image

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

appendRichText(paragraphText)

Fügt den angegebenen Text am Ende der Gliederung hinzu.

appendRichText(paragraphText: string): OneNote.RichText;

Parameter

paragraphText

string

HTML-Zeichenfolge, die angefügt werden soll.

Gibt zurück

OneNote.RichText

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

appendTable(rowCount, columnCount, values)

Fügt eine Tabelle mit der angegebenen Anzahl von Zeilen und Spalten am Ende der Gliederung hinzu.

appendTable(rowCount: number, columnCount: number, values?: string[][]): OneNote.Table;

Parameter

rowCount

number

Erforderlich. Die Anzahl der Zeilen in der Tabelle.

columnCount

number

Erforderlich. Die Anzahl der Spalten in der Tabelle.

values

string[][]

Optionales 2D-Array. Wenn die entsprechenden Zeichenfolgen im Array angegeben sind, werden die Zellen gefüllt.

Gibt zurück

OneNote.Table

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Beispiele

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

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

    // Get pageContents of the activePage.
    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();
    if (pageContents.items.length != 0 && pageContents.items[0].type == "Outline") {
        // First item is an outline.
        const outline = pageContents.items[0].outline;

        // Queue a command to append a paragraph to the outline.
        outline.appendTable(2, 2, [["1", "2"],["3", "4"]]);

        // Run the queued commands.
        await context.sync();
    }
});

isTitle()

Überprüfen Sie, ob es sich bei der Gliederung um eine Titelgliederung handelt.

isTitle(): OfficeExtension.ClientResult<boolean>;

Gibt zurück

OfficeExtension.ClientResult<boolean>

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

load(options)

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.OutlineLoadOptions): OneNote.Outline;

Parameter

options
OneNote.Interfaces.OutlineLoadOptions

Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.

Gibt zurück

OneNote.Outline

load(propertyNames)

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

Parameter

propertyNames

string | string[]

Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

Gibt zurück

OneNote.Outline

load(propertyNamesAndPaths)

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

Parameter

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und propertyNamesAndPaths.expand eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

Gibt zurück

OneNote.Outline

toJSON()

Ü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.Outline Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als OneNote.Interfaces.OutlineData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.

toJSON(): OneNote.Interfaces.OutlineData;

Gibt zurück

OneNote.Interfaces.OutlineData

track()

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

Gibt zurück

OneNote.Outline

untrack()

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

Gibt zurück

OneNote.Outline