OneNote.Notebook class

URL du site où se trouve ce bloc-notes. En lecture seule.

readonly baseUrl: string;

Valeur de propriété

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

URL du client du bloc-notes. En 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 du bloc-notes. En lecture seule.

readonly id: string;

Valeur de propriété

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

True si le bloc-notes n’est pas créé par l’utilisateur (par exemple, « Sections mal placées »).

readonly isVirtual: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : OneNoteApi 1.2 ]

Obtient le nom du bloc-notes.

readonly name: string;

Valeur de propriété

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Obtient les groupes de sections dans le bloc-notes.

readonly sectionGroups: OneNote.SectionGroupCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Sections du bloc-notes.

readonly sections: OneNote.SectionCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Ajoute une nouvelle section à la fin du bloc-notes.

addSection(name: string): OneNote.Section;

Paramètres

Retours

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Exemples

await OneNote.run(async (context) => {

    // Gets the active notebook.
    const notebook = context.application.getActiveNotebook();

    // Queue a command to add a new section.
    const section = notebook.addSection("Sample section");
    
    // Queue a command to load the new section. This example reads the name property later.
    section.load("name");

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    console.log("New section name is " + section.name);
});

Ajoute un nouveau groupe de sections à la fin du bloc-notes.

addSectionGroup(name: string): OneNote.SectionGroup;

Paramètres

Retours

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Exemples

await OneNote.run(async (context) => {

    // Gets the active notebook.
    const notebook = context.application.getActiveNotebook();

    // Queue a command to add a new section group.
    const sectionGroup = notebook.addSectionGroup("Sample section group");

    // Queue a command to load the new section group.
    sectionGroup.load();

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    console.log("New section group name is " + sectionGroup.name);
});

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 notebook.
    const notebook = context.application.getActiveNotebook();
    const restApiId = notebook.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://video2.skills-academy.com/archive/blogs/onenotedev/and-sharepoint-makes-three
});

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.NotebookLoadOptions): OneNote.Notebook;

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

Paramètres

Retours

Exemples

await OneNote.run(async (context) => {
        
    // Get the current notebook.
    const notebook = context.application.getActiveNotebook();
            
    // Queue a command to load the notebook.
    // For best performance, request specific properties.
    notebook.load('baseUrl');
            
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    console.log("Base url: " + notebook.baseUrl);
    // This is only required for SharePoint notebooks, and will be null for OneDrive notebooks.
    // This baseUrl should be used to talk to OneNote REST APIs according to the OneNote Development Blog.
    // https://video2.skills-academy.com/archive/blogs/onenotedev/and-sharepoint-makes-three
});

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

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

toJSON(): OneNote.Interfaces.NotebookData;

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 devez ajouter l’objet à la collection d’objets suivie lors de la première création de l’objet.

track(): OneNote.Notebook;

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 mise en production de la mémoire ne prenne effet.

untrack(): OneNote.Notebook;

Retours