OneNote.Section class

URL du client de la section. Lecture seule

readonly clientUrl: string;

Valeur de propriété

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

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é

Obtient l’ID de la section. En lecture seule.

readonly id: string;

Valeur de propriété

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

True si cette section est chiffrée avec un mot de passe. Lecture seule

readonly isEncrypted: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : OneNoteApi 1.2 ]

True si cette section est verrouillée. Lecture seule

readonly isLocked: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : OneNoteApi 1.2 ]

Obtient le nom de la section. En lecture seule.

readonly name: string;

Valeur de propriété

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Obtient le bloc-notes qui contient la section. En lecture seule.

readonly notebook: OneNote.Notebook;

Valeur de propriété

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Collection de pages dans la section. Lecture seule

readonly pages: OneNote.PageCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

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

readonly parentSectionGroup: OneNote.SectionGroup;

Valeur de propriété

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

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

readonly parentSectionGroupOrNull: OneNote.SectionGroup;

Valeur de propriété

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

URL web de la page. Lecture seule

readonly webUrl: string;

Valeur de propriété

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Ajoute une nouvelle page à la fin de la section.

addPage(title: string): OneNote.Page;

Paramètres

Retours

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Exemples

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

Copie cette section dans le bloc-notes spécifié.

copyToNotebook(destinationNotebook: OneNote.Notebook): OneNote.Section;

Paramètres

Retours

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Exemples

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

Copie cette section dans le groupe de sections spécifié.

copyToSectionGroup(destinationSectionGroup: OneNote.SectionGroup): OneNote.Section;

Paramètres

Retours

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Exemples

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

Obtient l’ID d’API REST.

getRestApiId(): OfficeExtension.ClientResult<string>;

Retours

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Exemples

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

Insère une nouvelle section avant ou après la section active.

insertSectionAsSibling(location: OneNote.InsertLocation, title: string): OneNote.Section;

Paramètres

Retours

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Insère une nouvelle section avant ou après la section active.

insertSectionAsSibling(locationString: "Before" | "After", title: string): OneNote.Section;

Paramètres

Retours

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Exemples

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

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.SectionLoadOptions): OneNote.Section;

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

Paramètres

Retours

Exemples

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

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

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 OneNote.Section d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant OneNote.Interfaces.SectionDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): OneNote.Interfaces.SectionData;

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

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

Retours