OneNote.Page class

Obtient le ClassNotebookPageSource vers la page.

readonly classNotebookPageSource: string;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

URL du client de la page.

readonly clientUrl: string;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Collection d’objets PageContent dans la page. Lecture seule

readonly contents: OneNote.PageContentCollection;

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 de la page.

readonly id: string;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Interprétation du texte de l’entrée manuscrite sur la page. Renvoie la valeur null s’il n’existe aucune information d’analyse des entrées manuscrites.

readonly inkAnalysisOrNull: OneNote.InkAnalysis;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Obtient ou définit le niveau de retrait de la page.

pageLevel: number;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Obtient la section qui contient la page.

readonly parentSection: OneNote.Section;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Obtient ou définit le titre de la page.

title: string;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

URL web de la page.

readonly webUrl: string;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Ajoute un plan à la page à la position spécifiée.

addOutline(left: number, top: number, html: string): OneNote.Outline;

Paramètres

Retours

Remarques

Jeu d’API : OneNoteApi 1.1

Exemples

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

    // Gets the active page.
    const page = context.application.getActivePage();

    // Queue a command to add an outline with given html.
    const outline = page.addOutline(200, 200,
"<p>Images and a table below:</p> \
 <img src=\"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==\"> \
 <img src=\"http://imagenes.es.sftcdn.net/es/scrn/6653000/6653659/microsoft-onenote-2013-01-535x535.png\"> \
 <table> \
   <tr> \
     <td>Jill</td> \
     <td>Smith</td> \
     <td>50</td> \
   </tr> \
   <tr> \
     <td>Eve</td> \
     <td>Jackson</td> \
     <td>94</td> \
   </tr> \
 </table>"     
        );

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
});

Renvoie une chaîne JSON avec l’ID de nœud et le contenu au format HTML.

analyzePage(): OfficeExtension.ClientResult<string>;

Retours

Remarques

Jeu d’API : OneNoteApi 1.1

insère une nouvelle page avec du contenu traduit.

applyTranslation(translatedContent: string): void;

Paramètres

Retours

Remarques

Jeu d’API : OneNoteApi 1.1

Copie cette page dans la section spécifiée.

copyToSection(destinationSection: OneNote.Section): OneNote.Page;

Paramètres

Retours

Remarques

Jeu 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 page.
    const page = app.getActivePage();
    
    // Queue a command to load sections under the notebook.
    notebook.load('sections');
    
    let newPage;
    
    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();

    const section = notebook.sections.items[0];
    
    // Copy page to the section.
    newPage = page.copyToSection(section);
    newPage.load('id');
    await context.sync();
    
    console.log(newPage.id);
});

Copie cette page dans la section spécifiée et définit ClassNotebookPageSource.

copyToSectionAndSetClassNotebookPageSource(destinationSection: OneNote.Section): OneNote.Page;

Paramètres

Retours

Remarques

Jeu d’API : OneNoteApi 1.1

Obtient l’ID de l’API REST.

getRestApiId(): OfficeExtension.ClientResult<string>;

Retours

Remarques

Jeu d’API : OneNoteApi 1.1

Exemples

await OneNote.run(async (context) => {
    // Get the current page.
    const page = context.application.getActivePage();
    const restApiId = page.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
});

La page a-t-elle un titre de contenu ?

hasTitleContent(): OfficeExtension.ClientResult<boolean>;

Retours

Remarques

Jeu d’API : OneNoteApi 1.1

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

insertPageAsSibling(location: OneNote.InsertLocation, title: string): OneNote.Page;

Paramètres

Retours

Remarques

Jeu d’API : OneNoteApi 1.1

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

insertPageAsSibling(location: "Before" | "After", title: string): OneNote.Page;

Paramètres

Retours

Remarques

Jeu d’API : OneNoteApi 1.1

Exemples

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

    // Gets the active page.
    const activePage = context.application.getActivePage();

    // Queue a command to add a new page after the active page.
    const newPage = activePage.insertPageAsSibling("After", "Next Page");

    // Queue a command to load the newPage to access its data.
    context.load(newPage);

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    console.log("page is created with title: " + newPage.title);
});

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.PageLoadOptions): OneNote.Page;

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

Paramètres

Retours

Exemples

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

    // Gets the active page.
    const activePage = context.application.getActivePage();

    // Queue a command to add a new page after the active page.
    const pageContents = activePage.contents;

    // Queue a command to load the pageContents to access its data.
    context.load(pageContents);

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync()
    for(let i=0; i < pageContents.items.length; i++) {
        const pageContent = pageContents.items[i];
        if (pageContent.type == "Outline") {
            console.log("Found an outline");
        } else if (pageContent.type == "Image") {
            console.log("Found an image");
        } else if (pageContent.type == "Other") {
            console.log("Found a type not supported yet.");
        }
    }
});

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

Paramètres

Retours

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez transmettre soit un objet ordinaire avec les propriétés appropriées, soit un autre objet API du même type.

set(properties: Interfaces.PageUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

Retours

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: OneNote.Page): void;

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.Page est un objet API, la toJSON méthode renvoie un objet JavaScript simple (typé ) OneNote.Interfaces.PageDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): OneNote.Interfaces.PageData;

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

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

Retours