OneNote.SectionGroupCollection class

Der Anforderungskontext, der dem -Objekt zugeordnet ist. Dadurch wird der Prozess des Add-Ins mit dem Prozess der Office-Hostanwendung verbunden.

context: RequestContext;

Eigenschaftswert

Gibt die Anzahl von Abschnittsgruppen in der Sammlung zurück.

readonly count: number;

Eigenschaftswert

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Ruft die geladenen untergeordneten Elemente in dieser Sammlung ab.

readonly items: OneNote.SectionGroup[];

Eigenschaftswert

Ruft die Auflistung von Abschnittsgruppen mit dem angegebenen Namen ab.

getByName(name: string): OneNote.SectionGroupCollection;

Parameter

Gibt zurück

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

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"); 

    // Get the section groups with the specified name.
    const labsSectionGroups = sectionGroups.getByName("Labs");

    // Queue a command to load the section groups with the specified properties.
    labsSectionGroups.load("id,name"); 
            
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();

    // Iterate through the collection or access items individually by index.
    if (labsSectionGroups.items.length > 0) {
        console.log("Section group name: " + labsSectionGroups.items[0].name);
        console.log("Section group ID: " + labsSectionGroups.items[0].id);
    }
});

Ruft eine Abschnittsgruppe nach ID oder dem Index in der Auflistung ab. Schreibgeschützt.

getItem(index: number | string): OneNote.SectionGroup;

Parameter

Gibt zurück

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

Ruft eine Abschnittsgruppe anhand ihrer Position in der Auflistung ab.

getItemAt(index: number): OneNote.SectionGroup;

Parameter

Gibt zurück

Hinweise

[ API-Satz: OneNoteApi 1.1 ]

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.SectionGroupCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions): OneNote.SectionGroupCollection;

Parameter

Gibt zurück

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

Parameter

Gibt zurück

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("name"); 

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
            
    // Iterate through the collection or access items individually by index.
    // For example: sectionGroups.items[0]
    $.each(sectionGroups.items, function(index, sectionGroup) {
        console.log("Section group name: " + sectionGroup.name);  
        console.log("Section group ID: " + sectionGroup.id);  
    });
});

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?: OfficeExtension.LoadOption): OneNote.SectionGroupCollection;

Parameter

Gibt zurück

Ü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.SectionGroupCollection Objekt ein API-Objekt ist, gibt die toJSON Methode ein einfaches JavaScript-Objekt (typisiert als OneNote.Interfaces.SectionGroupCollectionData) zurück, das ein "Items"-Array mit flachen Kopien aller geladenen Eigenschaften aus den Elementen der Auflistung enthält.

toJSON(): OneNote.Interfaces.SectionGroupCollectionData;

Gibt zurück

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

Gibt zurück

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

Gibt zurück