OneNote.SectionGroup class
Stellt eine OneNote-Abschnittsgruppe dar. Abschnittsgruppen können Abschnitte und andere Abschnittsgruppen enthalten.
- Extends
Hinweise
Eigenschaften
| client |
Die Client-URL der Abschnittsgruppe. |
| 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 Abschnittsgruppe ab. |
| name | Ruft den Namen der Abschnittsgruppe ab. |
| notebook | Ruft das Notizbuch ab, das die Abschnittsgruppe enthält. |
| parent |
Ruft die Abschnittsgruppe ab, die die Abschnittsgruppe enthält. Löst „ItemNotFound“ aus, wenn die Abschnittsgruppe ein direkt untergeordnetes Element des Notizbuchs ist. |
| parent |
Ruft die Abschnittsgruppe ab, die die Abschnittsgruppe enthält. Gibt Null zurück, wenn die Abschnittsgruppe ein direkt untergeordnetes Element des Notizbuchs ist. |
| section |
Die Auflistung von Abschnittsgruppen in der Abschnittsgruppe. |
| sections | Die Auflistung von Abschnitten in der Abschnittsgruppe. |
Methoden
| add |
Fügt einen neuen Abschnitt am Ende der Abschnittsgruppe hinzu. |
| add |
Fügt eine neue Abschnittsgruppe am Ende dieser Abschnittsgruppe hinzu. |
| get |
Ruft die REST-API-ID ab. |
| 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 der Abschnittsgruppe.
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 der Abschnittsgruppe ab.
readonly id: string;Eigenschaftswert
string
Hinweise
name
Ruft den Namen der Abschnittsgruppe ab.
readonly name: string;Eigenschaftswert
string
Hinweise
notebook
Ruft das Notizbuch ab, das die Abschnittsgruppe enthält.
readonly notebook: OneNote.Notebook;Eigenschaftswert
Hinweise
parentSectionGroup
Ruft die Abschnittsgruppe ab, die die Abschnittsgruppe enthält. Löst „ItemNotFound“ aus, wenn die Abschnittsgruppe ein direkt untergeordnetes Element des Notizbuchs ist.
readonly parentSectionGroup: OneNote.SectionGroup;Eigenschaftswert
Hinweise
parentSectionGroupOrNull
Ruft die Abschnittsgruppe ab, die die Abschnittsgruppe enthält. Gibt Null zurück, wenn die Abschnittsgruppe ein direkt untergeordnetes Element des Notizbuchs ist.
readonly parentSectionGroupOrNull: OneNote.SectionGroup;Eigenschaftswert
Hinweise
sectionGroups
Die Auflistung von Abschnittsgruppen in der Abschnittsgruppe.
readonly sectionGroups: OneNote.SectionGroupCollection;Eigenschaftswert
Hinweise
sections
Die Auflistung von Abschnitten in der Abschnittsgruppe.
readonly sections: OneNote.SectionCollection;Eigenschaftswert
Hinweise
Details zur Methode
addSection(title)
Fügt einen neuen Abschnitt am Ende der Abschnittsgruppe hinzu.
addSection(title: string): OneNote.Section;Parameter
- title
-
string
Der Name des neuen Abschnitts.
Gibt zurück
Hinweise
Beispiele
await OneNote.run(async (context) => {
// Get the section groups that are direct children of the current notebook.
const sectionGroups = context.application.getActiveNotebook().sectionGroups;
// Queue a command to load the section groups.
// For best performance, request specific properties.
sectionGroups.load("id");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Add a section to each section group.
$.each(sectionGroups.items, function(index, sectionGroup) {
sectionGroup.addSection("Agenda");
});
// Run the queued commands.
await context.sync();
});
addSectionGroup(name)
Fügt eine neue Abschnittsgruppe am Ende dieser Abschnittsgruppe hinzu.
addSectionGroup(name: string): OneNote.SectionGroup;Parameter
- name
-
string
Der Name des neuen Abschnitts.
Gibt zurück
Hinweise
Beispiele
await OneNote.run(async (context) => {
let sectionGroup;
let nestedSectionGroup;
// Gets the active notebook.
const notebook = context.application.getActiveNotebook();
// Queue a command to add a new section group.
const sectionGroups = notebook.sectionGroups;
// Queue a command to load the new section group.
sectionGroups.load();
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
sectionGroup = sectionGroups.items[0];
sectionGroup.load();
await context.sync();
nestedSectionGroup = sectionGroup.addSectionGroup("Sample nested section group");
nestedSectionGroup.load();
await context.sync();
console.log("New nested section group name is " + nestedSectionGroup.name);
});
getRestApiId()
Ruft die REST-API-ID ab.
getRestApiId(): OfficeExtension.ClientResult<string>;Gibt zurück
OfficeExtension.ClientResult<string>
Hinweise
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.SectionGroupLoadOptions): OneNote.SectionGroup;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.SectionGroup;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 parent section group that contains the current section.
const sectionGroup = context.application.getActiveSection().parentSectionGroup;
// Queue a command to load the section group.
// For best performance, request specific properties.
sectionGroup.load("id,name");
// Run the queued commands, and return a promise to indicate task completion.
await context.sync();
// Write the properties.
console.log("Section group name: " + sectionGroup.name);
console.log("Section group ID: " + sectionGroup.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.SectionGroup;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.SectionGroup Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als OneNote.Interfaces.SectionGroupData) zurück, das flache Kopien aller geladenen untergeordneten Eigenschaften aus dem ursprünglichen Objekt enthält.
toJSON(): OneNote.Interfaces.SectionGroupData;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.SectionGroup;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.SectionGroup;Gibt zurück
Office Add-ins