OneNote.SectionGroupCollection class

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Renvoie le nombre de groupes de sections de la collection. En lecture seule.

readonly count: number;

Valeur de propriété

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Obtient l’élément enfant chargé dans cette collection de sites.

readonly items: OneNote.SectionGroup[];

Valeur de propriété

Obtient la collection de groupes de sections portant le nom spécifié.

getByName(name: string): OneNote.SectionGroupCollection;

Paramètres

Retours

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Exemples

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

Obtient un groupe de sections en fonction de son ID ou de son index dans la collection. En lecture seule.

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

Paramètres

Retours

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Obtient un groupe de sections en fonction de sa position dans la collection.

getItemAt(index: number): OneNote.SectionGroup;

Paramètres

Retours

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(options?: OneNote.Interfaces.SectionGroupCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions): OneNote.SectionGroupCollection;

Paramètres

Retours

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNames?: string | string[]): OneNote.SectionGroupCollection;

Paramètres

Retours

Exemples

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

Files d’attente de la commande pour charger les propriétés de l’objet spécifié. Vous devez contacter context.sync() avant de lire les propriétés.

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): OneNote.SectionGroupCollection;

Paramètres

Retours

Remplace la méthode JavaScript toJSON() afin de fournir une sortie plus utile lorsqu’un objet API est passé à JSON.stringify(). (JSON.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine OneNote.SectionGroupCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant OneNote.Interfaces.SectionGroupCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

toJSON(): OneNote.Interfaces.SectionGroupCollectionData;

Retours

Effectuer le suivi de l’objet pour l’ajustement automatique en fonction environnant des modifications dans le document. Cet appel est un raccourci pour context.trackedObjects.add(thisObject). Si vous utilisez cet objet sur des .sync appels et en dehors de l’exécution séquentielle d’un lot . run et que vous obtenez une erreur « InvalidObjectPath » lors de la définition d’une propriété ou de l’appel d’une méthode sur l’objet, vous deviez avoir ajouté l’objet à la collection d’objets suivie lors de la création de l’objet pour la première fois.

track(): OneNote.SectionGroupCollection;

Retours

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est abrégé pour context.trackedObjects.remove(thisObject). Vous rencontrez de nombreux objets suivies ralentit l’application hôte, donc n’oubliez pas de libérer les objets que l'on ajoute, une fois que vous avez terminé à les utiliser. Vous devez appeler context.sync() avant que la libération de la mémoire ne prenne effet.

untrack(): OneNote.SectionGroupCollection;

Retours