OneNote.SectionGroup class

URL du client du groupe de sections.

readonly clientUrl: string;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Obtient l’ID du groupe de sections.

readonly id: string;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Obtient le nom du groupe de sections.

readonly name: string;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Obtient le bloc-notes qui contient le groupe de sections.

readonly notebook: OneNote.Notebook;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Obtient le groupe de sections qui contient le groupe de sections. Génère ItemNotFound si le groupe de sections est un enfant direct du bloc-notes.

readonly parentSectionGroup: OneNote.SectionGroup;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Obtient le groupe de sections qui contient le groupe de sections. Renvoie la valeur Null si le groupe de sections est un enfant direct du bloc-notes.

readonly parentSectionGroupOrNull: OneNote.SectionGroup;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Collection de groupes de sections dans le groupe de sections.

readonly sectionGroups: OneNote.SectionGroupCollection;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Collection de sections dans le groupe de sections.

readonly sections: OneNote.SectionCollection;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Ajoute une nouvelle section à la fin du groupe de sections.

addSection(title: string): OneNote.Section;

Paramètres

Retours

Remarques

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

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

Ajoute un nouveau groupe de sections à la fin de cet objet sectionGroup.

addSectionGroup(name: string): OneNote.SectionGroup;

Paramètres

Retours

Remarques

Jeu d’API : OneNoteApi 1.1

Exemples

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

Obtient l’ID de l’API REST.

getRestApiId(): OfficeExtension.ClientResult<string>;

Retours

Remarques

Jeu 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.SectionGroupLoadOptions): OneNote.SectionGroup;

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

Paramètres

Retours

Exemples

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

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?: {
            select?: string;
            expand?: string;
        }): OneNote.SectionGroup;

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.stringify, à son tour, appelle la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet d’origine OneNote.SectionGroup est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) OneNote.Interfaces.SectionGroupDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): OneNote.Interfaces.SectionGroupData;

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 entre 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 devez ajouter l’objet à la collection d’objets suivis lors de la création initiale de l’objet.

track(): OneNote.SectionGroup;

Retours

Publication mémoire associée à cet objet si elle a été précédemment suivie. Cet appel est l’abréviation de 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 mémoire prenne effet.

untrack(): OneNote.SectionGroup;

Retours