OneNote.Section class
Stellt einen OneNote-Abschnitt dar. Abschnitte können Seiten enthalten.
- Extends
Hinweise
Eigenschaften
| client |
Die Client-URL des Abschnitts. |
| 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 Abschnitts ab. |
| is |
True, wenn dieser Abschnitt mit einem Kennwort verschlüsselt ist. |
| is |
True, wenn dieser Abschnitt gesperrt ist. |
| name | Ruft den Namen des Abschnitt ab. |
| notebook | Ruft das Notizbuch ab, das den Abschnitt enthält. |
| pages | Ruft die Auflistung von Seiten in dem Abschnitt ab. |
| parent |
Ruft die Abschnittsgruppe ab, die den Abschnitt enthält. Löst „ItemNotFound“ aus, wenn der Abschnitt ein direkt untergeordnetes Element des Notizbuchs ist. |
| parent |
Ruft die Abschnittsgruppe ab, die den Abschnitt enthält. Gibt Null zurück, wenn der Abschnitt ein direkt untergeordnetes Element des Notizbuchs ist. Schreibgeschützt. |
| web |
Die Web-URL der Seite. |
Methoden
| add |
Fügt eine neue Seite am Ende des Abschnitts hinzu. |
| copy |
Kopiert diesen Abschnitt in das angegebene Notizbuch. |
| copy |
Kopiert diesen Abschnitt in die angegebene Abschnittsgruppe. |
| get |
Ruft die REST-API-ID ab. |
| insert |
Fügt einen neuen Abschnitt vor oder nach dem aktuellen Abschnitt ein. |
| insert |
Fügt einen neuen Abschnitt vor oder nach dem aktuellen Abschnitt 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 " |
| 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
clientUrl
Die Client-URL des Abschnitts.
readonly clientUrl: string;Eigenschaftswert
string
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 des Abschnitts ab.
readonly id: string;Eigenschaftswert
string
Hinweise
isEncrypted
True, wenn dieser Abschnitt mit einem Kennwort verschlüsselt ist.
readonly isEncrypted: boolean;Eigenschaftswert
boolean
Hinweise
isLocked
True, wenn dieser Abschnitt gesperrt ist.
readonly isLocked: boolean;Eigenschaftswert
boolean
Hinweise
name
Ruft den Namen des Abschnitt ab.
readonly name: string;Eigenschaftswert
string
Hinweise
notebook
Ruft das Notizbuch ab, das den Abschnitt enthält.
readonly notebook: OneNote.Notebook;Eigenschaftswert
Hinweise
pages
Ruft die Auflistung von Seiten in dem Abschnitt ab.
readonly pages: OneNote.PageCollection;Eigenschaftswert
Hinweise
parentSectionGroup
Ruft die Abschnittsgruppe ab, die den Abschnitt enthält. Löst „ItemNotFound“ aus, wenn der Abschnitt ein direkt untergeordnetes Element des Notizbuchs ist.
readonly parentSectionGroup: OneNote.SectionGroup;Eigenschaftswert
Hinweise
parentSectionGroupOrNull
Ruft die Abschnittsgruppe ab, die den Abschnitt enthält. Gibt Null zurück, wenn der Abschnitt ein direkt untergeordnetes Element des Notizbuchs ist. Schreibgeschützt.
readonly parentSectionGroupOrNull: OneNote.SectionGroup;Eigenschaftswert
Hinweise
webUrl
Die Web-URL der Seite.
readonly webUrl: string;Eigenschaftswert
string
Hinweise
Details zur Methode
addPage(title)
Fügt eine neue Seite am Ende des Abschnitts hinzu.
addPage(title: string): OneNote.Page;Parameter
- title
-
string
Der Titel der neuen Seite.
Gibt zurück
Hinweise
Beispiele
await OneNote.run(async (context) => {
// Queue a command to add a page to the current section.
const page = context.application.getActiveSection().addPage("Wish list");
// Queue a command to load the id and title of the new page.
// This example loads the new page so it can read its properties later.
page.load('id,title');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Display the properties.
console.log("Page name: " + page.title);
console.log("Page ID: " + page.id);
});
copyToNotebook(destinationNotebook)
Kopiert diesen Abschnitt in das angegebene Notizbuch.
copyToNotebook(destinationNotebook: OneNote.Notebook): OneNote.Section;Parameter
- destinationNotebook
- OneNote.Notebook
Das Notizbuch, in das dieser Abschnitt 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 Section.
const section = app.getActiveSection();
let newSection;
await context.sync();
newSection = section.copyToNotebook(notebook);
newSection.load('id');
await context.sync();
console.log(newSection.id);
});
copyToSectionGroup(destinationSectionGroup)
Kopiert diesen Abschnitt in die angegebene Abschnittsgruppe.
copyToSectionGroup(destinationSectionGroup: OneNote.SectionGroup): OneNote.Section;Parameter
- destinationSectionGroup
- OneNote.SectionGroup
Die Abschnittsgruppe, in die dieser Abschnitt 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 Section.
const section = app.getActiveSection();
let newSection;
await context.sync();
const firstSectionGroup = notebook.sectionGroups.items[0];
newSection = section.copyToSectionGroup(firstSectionGroup);
newSection.load('id');
await context.sync();
console.log(newSection.id);
});
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 section.
const section = context.application.getActiveSection();
const restApiId = section.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
});
insertSectionAsSibling(location, title)
Fügt einen neuen Abschnitt vor oder nach dem aktuellen Abschnitt ein.
insertSectionAsSibling(location: OneNote.InsertLocation, title: string): OneNote.Section;Parameter
- location
- OneNote.InsertLocation
Die Position des neuen Abschnitts relativ zu dem aktuellen Abschnitt.
- title
-
string
Der Name des neuen Abschnitts.
Gibt zurück
Hinweise
insertSectionAsSibling(locationString, title)
Fügt einen neuen Abschnitt vor oder nach dem aktuellen Abschnitt ein.
insertSectionAsSibling(locationString: "Before" | "After", title: string): OneNote.Section;Parameter
- locationString
-
"Before" | "After"
Die Position des neuen Abschnitts relativ zu dem aktuellen Abschnitt.
- title
-
string
Der Name des neuen Abschnitts.
Gibt zurück
Hinweise
Beispiele
await OneNote.run(async (context) => {
// Queue a command to insert a section after the current section.
const section = context.application.getActiveSection().insertSectionAsSibling("After", "New section");
// Queue a command to load the id and name of the new section.
// This example loads the new section so it can read its properties later.
section.load('id,name');
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Display the properties.
console.log("Section name: " + section.name);
console.log("Section ID: " + section.id);
});
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.SectionLoadOptions): OneNote.Section;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.Section;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) => {
// Get the current section.
const section = context.application.getActiveSection();
// Queue a command to load the section.
// For best performance, request specific properties.
section.load("id");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
console.log("Section ID: " + section.id);
});
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.Section;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
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.Section Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als OneNote.Interfaces.SectionData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): OneNote.Interfaces.SectionData;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.Section;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.Section;Gibt zurück
Office Add-ins