OneNote.PageContent class
Stellt einen Bereich auf einer Seite dar, der Inhaltstypen der obersten Ebene wie Gliederung oder Bild enthält. Einem PageContent-Objekt kann eine XY-Position zugewiesen werden.
- Extends
Hinweise
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 PageContent-Objekts ab. |
| image | Ruft das Bild des PageContent-Objekts ab. Löst eine Ausnahme aus, wenn PageContentType nicht vom Typ „Image“ ist. |
| ink | Ruft die Freihand im PageContent-Objekt ab. Löst eine Ausnahme aus, wenn PageContentType nicht vom Typ „Ink“ ist. |
| left | Ruft die linke Position (X-Achse) des PageContent-Objekts ab oder legt sie fest. |
| outline | Ruft die Gliederung des PageContent-Objekts ab. Löst eine Ausnahme aus, wenn PageContentType nicht vom Typ „Outline“ ist. |
| parent |
Ruft die Seite ab, die das PageContent-Objekt enthält. |
| top | Ruft die obere Position (X-Achse) des PageContent-Objekts ab oder legt sie fest. |
| type | Ruft den Typ des PageContent-Objekts ab. |
Methoden
| delete() | Löscht das PageContent-Objekt. |
| load(options) | Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| load(property |
Stellt einen Befehl zum Laden der angegebenen Eigenschaften des Objekts in die Warteschlange ein. Vor dem Lesen der Eigenschaften müssen Sie " |
| 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 |
| 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 |
| 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 |
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
id
Ruft die ID des PageContent-Objekts ab.
readonly id: string;Eigenschaftswert
string
Hinweise
image
Ruft das Bild des PageContent-Objekts ab. Löst eine Ausnahme aus, wenn PageContentType nicht vom Typ „Image“ ist.
readonly image: OneNote.Image;Eigenschaftswert
Hinweise
ink
Ruft die Freihand im PageContent-Objekt ab. Löst eine Ausnahme aus, wenn PageContentType nicht vom Typ „Ink“ ist.
readonly ink: OneNote.FloatingInk;Eigenschaftswert
Hinweise
left
Ruft die linke Position (X-Achse) des PageContent-Objekts ab oder legt sie fest.
left: number;Eigenschaftswert
number
Hinweise
outline
Ruft die Gliederung des PageContent-Objekts ab. Löst eine Ausnahme aus, wenn PageContentType nicht vom Typ „Outline“ ist.
readonly outline: OneNote.Outline;Eigenschaftswert
Hinweise
parentPage
Ruft die Seite ab, die das PageContent-Objekt enthält.
readonly parentPage: OneNote.Page;Eigenschaftswert
Hinweise
top
Ruft die obere Position (X-Achse) des PageContent-Objekts ab oder legt sie fest.
top: number;Eigenschaftswert
number
Hinweise
type
Ruft den Typ des PageContent-Objekts ab.
readonly type: OneNote.PageContentType | "Outline" | "Image" | "Ink" | "Other";Eigenschaftswert
OneNote.PageContentType | "Outline" | "Image" | "Ink" | "Other"
Hinweise
Details zur Methode
delete()
Löscht das PageContent-Objekt.
delete(): void;Gibt zurück
void
Hinweise
Beispiele
await OneNote.run(async (context) => {
const page = context.application.getActivePage();
const pageContents = page.contents;
const firstPageContent = pageContents.getItemAt(0);
firstPageContent.load('type');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
if (firstPageContent.isNullObject === false) {
firstPageContent.delete();
await context.sync();
}
});
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.PageContentLoadOptions): OneNote.PageContent;Parameter
Stellt Optionen dafür bereit, welche Eigenschaften des -Objekts geladen werden sollen.
Gibt zurück
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; }
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
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
Stellt eine Option zum Unterdrücken von Fehlern bereit, wenn das Eigenschaftenobjekt versucht, schreibgeschützte Eigenschaften festzulegen.
Gibt zurück
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 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.PageContent Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als OneNote.Interfaces.PageContentData) zurück, das 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 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.PageContent;Gibt zurück
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.PageContent;Gibt zurück
Office Add-ins