OneNote.PageContent class

Stellt einen Bereich auf einer Seite dar, der Inhaltstypen auf oberster Ebene enthält, z. B. Outline oder Image. Ein PageContent-Objekt kann einer XY-Position zugewiesen werden.

[API-Satz: OneNoteApi 1.1]

Extends

Eigenschaften

context

Der Dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

id

Ruft die ID des PageContent-Objekts ab. Schreibgeschützt.

[API-Satz: OneNoteApi 1.1]

image

Ruft das Bild des PageContent-Objekts ab. Löst eine Ausnahme aus, wenn PageContentType nicht vom Typ „Image“ ist.

[API-Satz: OneNoteApi 1.1]

ink

Ruft die Freihand im PageContent-Objekt ab. Löst eine Ausnahme aus, wenn PageContentType nicht vom Typ „Ink“ ist.

[API-Satz: OneNoteApi 1.1]

left

Ruft die linke Position (X-Achse) des PageContent-Objekts ab oder legt sie fest.

[API-Satz: OneNoteApi 1.1]

outline

Ruft die Gliederung des PageContent-Objekts ab. Löst eine Ausnahme aus, wenn PageContentType nicht vom Typ „Outline“ ist.

[API-Satz: OneNoteApi 1.1]

parentPage

Ruft die Seite ab, die das PageContent-Objekt enthält. Schreibgeschützt.

[API-Satz: OneNoteApi 1.1]

top

Ruft die obere Position (X-Achse) des PageContent-Objekts ab oder legt sie fest.

[API-Satz: OneNoteApi 1.1]

type

Ruft den Typ des PageContent-Objekts ab. Schreibgeschützt.

[API-Satz: OneNoteApi 1.1]

Methoden

delete()

Löscht das PageContent-Objekt.

[API-Satz: OneNoteApi 1.1]

load(option)

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.

set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

set(properties)

Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

toJSON()

Überschreibt die JavaScript-Methode, um eine nützlichere Ausgabe zu toJSON() bieten, wenn ein API-Objekt an übergeben wird JSON.stringify(). (JSON.stringifyruft wiederum die Methode toJSON des Objekts auf, das an das Objekt übergeben wird.) Während das ursprüngliche OneNote.PageContent-Objekt ein API-Objekt ist, gibt die Methode ein toJSON einfaches JavaScript-Objekt zurück (Typ: OneNote.Interfaces.PageContentData), die 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 Kurzschreibweise für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt übergreifend für ".sync"-Aufrufe und außerhalb der sequenziellen Ausführung eines ".run"-Stapels verwenden und beim Festlegen einer Eigenschaft oder Aufrufen einer Methode für das Objekt ein "InvalidObjectPath"-Fehler zurückgegeben wird, hätte das Objekt der nachverfolgten Objektsammlung hinzugefügt werden müssen, in der das Objekt ursprünglich erstellt wurde.

untrack()

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf stellt eine Kurzschreibweise für context.trackedObjects.remove(thisObject) dar. Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen "context.sync()" aufrufen, damit die Freigabe des Arbeitsspeichers wirksam wird.

Details zur Eigenschaft

context

Der Dem Objekt zugeordnete Anforderungskontext. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

id

Ruft die ID des PageContent-Objekts ab. Schreibgeschützt.

[API-Satz: OneNoteApi 1.1]

readonly id: string;

Eigenschaftswert

string

image

Ruft das Bild des PageContent-Objekts ab. Löst eine Ausnahme aus, wenn PageContentType nicht vom Typ „Image“ ist.

[API-Satz: OneNoteApi 1.1]

readonly image: OneNote.Image;

Eigenschaftswert

ink

Ruft die Freihand im PageContent-Objekt ab. Löst eine Ausnahme aus, wenn PageContentType nicht vom Typ „Ink“ ist.

[API-Satz: OneNoteApi 1.1]

readonly ink: OneNote.FloatingInk;

Eigenschaftswert

left

Ruft die linke Position (X-Achse) des PageContent-Objekts ab oder legt sie fest.

[API-Satz: OneNoteApi 1.1]

left: number;

Eigenschaftswert

number

outline

Ruft die Gliederung des PageContent-Objekts ab. Löst eine Ausnahme aus, wenn PageContentType nicht vom Typ „Outline“ ist.

[API-Satz: OneNoteApi 1.1]

readonly outline: OneNote.Outline;

Eigenschaftswert

parentPage

Ruft die Seite ab, die das PageContent-Objekt enthält. Schreibgeschützt.

[API-Satz: OneNoteApi 1.1]

readonly parentPage: OneNote.Page;

Eigenschaftswert

top

Ruft die obere Position (X-Achse) des PageContent-Objekts ab oder legt sie fest.

[API-Satz: OneNoteApi 1.1]

top: number;

Eigenschaftswert

number

type

Ruft den Typ des PageContent-Objekts ab. Schreibgeschützt.

[API-Satz: OneNoteApi 1.1]

readonly type: OneNote.PageContentType | "Outline" | "Image" | "Ink" | "Other";

Eigenschaftswert

OneNote.PageContentType | "Outline" | "Image" | "Ink" | "Other"

Details zur Methode

delete()

Löscht das PageContent-Objekt.

[API-Satz: OneNoteApi 1.1]

delete(): void;

Gibt zurück

void

Beispiele

OneNote.run(function (context) {

    var page = context.application.getActivePage();
    var pageContents = page.contents;

    var firstPageContent = pageContents.getItemAt(0);
    firstPageContent.load('type');

    // Run the queued commands, and return a promise to indicate task completion.
    return context.sync()
        .then(function () {
            if(firstPageContent.isNull === false) {
                firstPageContent.delete();
                return context.sync();
            }
        });
})
.catch(function(error) {
    console.log("Error: " + error);
    if (error instanceof OfficeExtension.Error) {
        console.log("Debug info: " + JSON.stringify(error.debugInfo));
    }
});

load(option)

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(option?: OneNote.Interfaces.PageContentLoadOptions): OneNote.PageContent;

Parameter

Gibt zurück

Hinweise

Zusätzlich zu dieser Signatur verfügt diese Methode über die folgenden Signaturen:

load(option?: string | string[]): OneNote.PageContent - Bei der Option handelt es sich um eine durch Kommas getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.

load(option?: { select?: string; expand?: string; }): OneNote.PageContent - Dabei ist option.select eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Eigenschaften angibt, und options.expand ist eine durch Trennzeichen getrennte Zeichenfolge, die die zu ladenden Navigationseigenschaften angibt.

load(option?: { select?: string; expand?: string; top?: number; skip?: number }): OneNote.PageContent - Nur für Auflistungstypen verfügbar. Sie ähnelt der vorherigen Signatur. Option.top gibt die maximale Anzahl von Auflistungselementen an, die in das Ergebnis eingeschlossen werden können. Option.skip gibt die Anzahl der Elemente an, die übersprungen und nicht in das Ergebnis einbezogen werden sollen. Wenn option.top angegeben wird, wird das Ergebnisset gestartet, nachdem die angegebene Anzahl von Elementen übersprungen wurde.

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

Parameter

propertyNames

string | string[]

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

Gibt zurück

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

Parameter

propertyNamesAndPaths

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

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

Gibt zurück

set(properties, options)

Legt mehrere Eigenschaften eines Objekts gleichzeitig fest. Sie können entweder ein einfaches Objekt mit den entsprechenden Eigenschaften oder ein anderes API-Objekt desselben Typs übergeben.

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

Parameter

properties
OneNote.Interfaces.PageContentUpdateData

Ein JavaScript-Objekt mit Eigenschaften, die isomorph zu den Eigenschaften des Objekts strukturiert sind, für das die Methode aufgerufen wird.

options
OfficeExtension.UpdateOptions

Bietet eine Option zum Unterdrücken von Fehlern, wenn das Properties-Objekt versucht, schreibgeschützte Eigenschaften zu setzen.

Gibt zurück

void

Hinweise

Diese Methode verfügt über die folgende zusätzliche Signatur:

set(properties: OneNote.PageContent): void

set(properties)

Legt mehrere Eigenschaften für das Objekt gleichzeitig fest, basierend auf einem vorhandenen geladenen Objekt.

set(properties: OneNote.PageContent): void;

Parameter

properties
OneNote.PageContent

Gibt zurück

void

toJSON()

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

toJSON(): OneNote.Interfaces.PageContentData;

Gibt zurück

track()

Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Kurzschreibweise für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt übergreifend für ".sync"-Aufrufe und außerhalb der sequenziellen Ausführung eines ".run"-Stapels verwenden und beim Festlegen einer Eigenschaft oder Aufrufen einer Methode für das Objekt ein "InvalidObjectPath"-Fehler zurückgegeben wird, hätte das Objekt der nachverfolgten Objektsammlung hinzugefügt werden müssen, in der das Objekt ursprünglich erstellt wurde.

track(): OneNote.PageContent;

Gibt zurück

untrack()

Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf stellt eine Kurzschreibweise für context.trackedObjects.remove(thisObject) dar. Viele nachverfolgte Objekte verlangsamen die Ausführung der Hostanwendung, also achten Sie darauf, alle hinzugefügten Objekte nach abgeschlossener Verwendung freizugeben. Sie müssen "context.sync()" aufrufen, damit die Freigabe des Arbeitsspeichers wirksam wird.

untrack(): OneNote.PageContent;

Gibt zurück