OneNote.Page class
Stellt eine OneNote-Seite dar.
- Extends
Hinweise
Eigenschaften
| class |
Ruft die ClassNotebookPageSource auf die Seite ab. |
| client |
Die Client-URL der Seite. Schreibgeschützt |
| contents | Die Auflistung von PageContent-Objekten auf der Seite. Schreibgeschützt |
| 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 der Seite ab. Schreibgeschützt. |
| ink |
Textinterpretation für die Freihandeingabe auf der Seite. Gibt Null zurück, wenn keine Freihandanalyseinformationen vorhanden sind. |
| page |
Dient zum Abrufen oder Festlegen Einzugsebene der Seite. |
| parent |
Ruft den Abschnitt ab, der die Seite enthält. Schreibgeschützt. |
| title | Dient zum Abrufen oder Festlegen des Titels der Seite. |
| web |
Die Web-URL der Seite. Schreibgeschützt |
Methoden
| add |
Fügt eine Gliederung zu der Seite an der angegebenen Position hinzu. |
| analyze |
Gibt eine JSON-Zeichenfolge mit Knoten-ID und Inhalt im HTML-Format zurück. |
| apply |
Fügt eine neue Seite mit übersetztem Inhalt ein. |
| copy |
Kopiert diese Seite in den angegebenen Abschnitt. |
| copy |
Kopiert diese Seite in den angegebenen Abschnitt und legt ClassNotebookPageSource fest. |
| get |
Ruft die REST-API-ID ab. |
| has |
Hat die Seite einen Inhaltstitel? |
| insert |
Fügt eine neue Seite vor oder nach der aktuellen Seite ein. |
| insert |
Fügt eine neue Seite vor oder nach der aktuellen Seite ein. |
| 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 Abkürzung für |
| untrack() | Gibt den diesem Objekt zugewiesenen Arbeitsspeicher frei, wenn das Objekt zuvor nachverfolgt wurde. Dieser Aufruf ist die Kurzform für |
Details zur Eigenschaft
classNotebookPageSource
Ruft die ClassNotebookPageSource auf die Seite ab.
readonly classNotebookPageSource: string;Eigenschaftswert
string
Hinweise
clientUrl
Die Client-URL der Seite. Schreibgeschützt
readonly clientUrl: string;Eigenschaftswert
string
Hinweise
contents
Die Auflistung von PageContent-Objekten auf der Seite. Schreibgeschützt
readonly contents: OneNote.PageContentCollection;Eigenschaftswert
Hinweise
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 der Seite ab. Schreibgeschützt.
readonly id: string;Eigenschaftswert
string
Hinweise
inkAnalysisOrNull
Textinterpretation für die Freihandeingabe auf der Seite. Gibt Null zurück, wenn keine Freihandanalyseinformationen vorhanden sind.
readonly inkAnalysisOrNull: OneNote.InkAnalysis;Eigenschaftswert
Hinweise
pageLevel
Dient zum Abrufen oder Festlegen Einzugsebene der Seite.
pageLevel: number;Eigenschaftswert
number
Hinweise
parentSection
Ruft den Abschnitt ab, der die Seite enthält. Schreibgeschützt.
readonly parentSection: OneNote.Section;Eigenschaftswert
Hinweise
title
Dient zum Abrufen oder Festlegen des Titels der Seite.
title: string;Eigenschaftswert
string
Hinweise
webUrl
Die Web-URL der Seite. Schreibgeschützt
readonly webUrl: string;Eigenschaftswert
string
Hinweise
Details zur Methode
addOutline(left, top, html)
Fügt eine Gliederung zu der Seite an der angegebenen Position hinzu.
addOutline(left: number, top: number, html: string): OneNote.Outline;Parameter
- left
-
number
Die linke Position der oberen linke Ecke der Gliederung.
- top
-
number
Die obere Position der oberen linke Ecke der Gliederung.
- html
-
string
Eine HTML-Zeichenfolge, die die visuelle Darstellung der Gliederung beschreibt. Weitere Informationen finden Sie unter Unterstütztes HTML für die JavaScript-API für OneNote-Add-Ins.
Gibt zurück
Hinweise
Beispiele
await OneNote.run(async (context) => {
// Gets the active page.
const page = context.application.getActivePage();
// Queue a command to add an outline with given html.
const outline = page.addOutline(200, 200,
"<p>Images and a table below:</p> \
<img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==\"> \
<img src=\"http://imagenes.es.sftcdn.net/es/scrn/6653000/6653659/microsoft-onenote-2013-01-535x535.png\"> \
<table> \
<tr> \
<td>Jill</td> \
<td>Smith</td> \
<td>50</td> \
</tr> \
<tr> \
<td>Eve</td> \
<td>Jackson</td> \
<td>94</td> \
</tr> \
</table>"
);
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
});
analyzePage()
Gibt eine JSON-Zeichenfolge mit Knoten-ID und Inhalt im HTML-Format zurück.
analyzePage(): OfficeExtension.ClientResult<string>;Gibt zurück
OfficeExtension.ClientResult<string>
Hinweise
applyTranslation(translatedContent)
Fügt eine neue Seite mit übersetztem Inhalt ein.
applyTranslation(translatedContent: string): void;Parameter
- translatedContent
-
string
Übersetzter Inhalt der Seite
Gibt zurück
void
Hinweise
copyToSection(destinationSection)
Kopiert diese Seite in den angegebenen Abschnitt.
copyToSection(destinationSection: OneNote.Section): OneNote.Page;Parameter
- destinationSection
- OneNote.Section
Der Abschnitt, in den diese Seite kopiert werden soll.
Gibt zurück
Hinweise
Beispiele
await OneNote.run(async (context) => {
const app = context.application;
// Gets the active notebook.
const notebook = app.getActiveNotebook();
// Gets the active page.
const page = app.getActivePage();
// Queue a command to load sections under the notebook.
notebook.load('sections');
let newPage;
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
const section = notebook.sections.items[0];
// Copy page to the section.
newPage = page.copyToSection(section);
newPage.load('id');
await context.sync();
console.log(newPage.id);
});
copyToSectionAndSetClassNotebookPageSource(destinationSection)
Kopiert diese Seite in den angegebenen Abschnitt und legt ClassNotebookPageSource fest.
copyToSectionAndSetClassNotebookPageSource(destinationSection: OneNote.Section): OneNote.Page;Parameter
- destinationSection
- OneNote.Section
Gibt zurück
Hinweise
getRestApiId()
Ruft die REST-API-ID ab.
getRestApiId(): OfficeExtension.ClientResult<string>;Gibt zurück
OfficeExtension.ClientResult<string>
Hinweise
Beispiele
await OneNote.run(async (context) => {
// Get the current page.
const page = context.application.getActivePage();
const restApiId = page.getRestApiId();
await context.sync();
console.log("The REST API ID is " + restApiId.value);
// Note that the REST API ID isn't all you need to interact with the OneNote REST API.
// This is only required for SharePoint notebooks. baseUrl will be null for OneDrive notebooks.
// For SharePoint notebooks, the notebook baseUrl should be used to talk to the OneNote REST API
// according to the OneNote Development Blog.
// https://learn.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
});
hasTitleContent()
Hat die Seite einen Inhaltstitel?
hasTitleContent(): OfficeExtension.ClientResult<boolean>;Gibt zurück
OfficeExtension.ClientResult<boolean>
Hinweise
insertPageAsSibling(location, title)
Fügt eine neue Seite vor oder nach der aktuellen Seite ein.
insertPageAsSibling(location: OneNote.InsertLocation, title: string): OneNote.Page;Parameter
- location
- OneNote.InsertLocation
Die Position der neuen Seite relativ zu der aktuellen Seite.
- title
-
string
Der Titel der neuen Seite.
Gibt zurück
Hinweise
insertPageAsSibling(locationString, title)
Fügt eine neue Seite vor oder nach der aktuellen Seite ein.
insertPageAsSibling(locationString: "Before" | "After", title: string): OneNote.Page;Parameter
- locationString
-
"Before" | "After"
Die Position der neuen Seite relativ zu der aktuellen Seite.
- title
-
string
Der Titel der neuen Seite.
Gibt zurück
Hinweise
Beispiele
await OneNote.run(async (context) => {
// Gets the active page.
const activePage = context.application.getActivePage();
// Queue a command to add a new page after the active page.
const newPage = activePage.insertPageAsSibling("After", "Next Page");
// Queue a command to load the newPage to access its data.
context.load(newPage);
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
console.log("page is created with title: " + newPage.title);
});
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.PageLoadOptions): OneNote.Page;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.Page;Parameter
- propertyNames
-
string | string[]
Eine durch Trennzeichen getrennte Zeichenfolge oder ein Array von Zeichenfolgen, die die zu ladenden Eigenschaften angeben.
Gibt zurück
Beispiele
await OneNote.run(async (context) => {
// Gets the active page.
const activePage = context.application.getActivePage();
// Queue a command to add a new page after the active page.
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()
for(let i=0; i < pageContents.items.length; i++) {
const pageContent = pageContents.items[i];
if (pageContent.type == "Outline") {
console.log("Found an outline");
} else if (pageContent.type == "Image") {
console.log("Found an image");
} else if (pageContent.type == "Other") {
console.log("Found a type not supported yet.");
}
}
});
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.Page;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.PageUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameter
- properties
- OneNote.Interfaces.PageUpdateData
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.Page): void;Parameter
- properties
- OneNote.Page
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.Page-Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als OneNote.Interfaces.PageData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): OneNote.Interfaces.PageData;Gibt zurück
track()
Nachverfolgung des Objekts zwecks automatischer Anpassung auf der Grundlage der umgebenden Änderungen im Dokument. Dieser Aufruf ist eine Abkürzung für context.trackedObjects.add(thisObject). Wenn Sie dieses Objekt über .sync Aufrufe 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, mussten Sie das Objekt der nachverfolgten Objektauflistung hinzugefügt haben, als das Objekt zum ersten Mal erstellt wurde.
track(): OneNote.Page;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.Page;Gibt zurück
Office Add-ins
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für