OneNote.Page class

Paquet:

onenote

Représente une page OneNote.

Extends

OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Propriétés

classNotebookPageSource	Obtient le ClassNotebookPageSource à la page.
clientUrl	URL du client de la page.
contents	Collection d’objets PageContent dans la page. Lecture seule
context	Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.
id	Obtient l’ID de la page.
inkAnalysisOrNull	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.
pageLevel	Obtient ou définit le niveau de retrait de la page.
parentSection	Obtient la section qui contient la page.
title	Obtient ou définit le titre de la page.
webUrl	URL web de la page.

Méthodes

addOutline(left, top, html)	Ajoute un plan à la page à la position spécifiée.
analyzePage()	Retourne une chaîne JSON avec l’ID de nœud et le contenu au format HTML.
applyTranslation(translatedContent)	Insère une nouvelle page avec du contenu traduit.
copyToSection(destinationSection)	Copie cette page dans la section spécifiée.
copyToSectionAndSetClassNotebookPageSource(destinationSection)	Copie cette page dans la section spécifiée et définit ClassNotebookPageSource.
getRestApiId()	Obtient l’ID d’API REST.
hasTitleContent()	La page a-t-elle un titre de contenu ?
insertPageAsSibling(location, title)	Insère une nouvelle page avant ou après la page active.
insertPageAsSibling(locationString, title)	Insère une nouvelle page avant ou après la page active.
load(options)	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)	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)	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.
set(properties, options)	Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.
set(properties)	Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.
toJSON()	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 brut (typé en tant OneNote.Interfaces.PageDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.
track()	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.
untrack()	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.

Détails de la propriété

classNotebookPageSource

Obtient le ClassNotebookPageSource à la page.

readonly classNotebookPageSource: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

clientUrl

URL du client de la page.

readonly clientUrl: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

contents

Collection d’objets PageContent dans la page. Lecture seule

readonly contents: OneNote.PageContentCollection;

Valeur de propriété

OneNote.PageContentCollection

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

context

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é

OneNote.RequestContext

id

Obtient l’ID de la page.

readonly id: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

inkAnalysisOrNull

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é

OneNote.InkAnalysis

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

pageLevel

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

pageLevel: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

parentSection

Obtient la section qui contient la page.

readonly parentSection: OneNote.Section;

Valeur de propriété

OneNote.Section

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

title

Obtient ou définit le titre de la page.

title: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

webUrl

URL web de la page.

readonly webUrl: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Détails de la méthode

addOutline(left, top, html)

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

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

Paramètres

left

number

Position gauche du coin supérieur gauche du plan.

top

number

Position du haut du coin supérieur gauche du plan.

html

string

Chaîne HTML qui décrit la présentation visuelle du plan. Consultez HTML pris en charge pour l’API JavaScript des compléments OneNote.

Retours

OneNote.Outline

Remarques

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

analyzePage()

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

analyzePage(): OfficeExtension.ClientResult<string>;

Retours

OfficeExtension.ClientResult<string>

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

applyTranslation(translatedContent)

Insère une nouvelle page avec du contenu traduit.

applyTranslation(translatedContent: string): void;

Paramètres

translatedContent

string

Contenu traduit de la page.

Retours

void

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

copyToSection(destinationSection)

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

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

Paramètres

destinationSection

OneNote.Section

Section dans laquelle copier cette page.

Retours

OneNote.Page

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

copyToSectionAndSetClassNotebookPageSource(destinationSection)

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

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

Paramètres

destinationSection

OneNote.Section

Retours

OneNote.Page

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

getRestApiId()

Obtient l’ID d’API REST.

getRestApiId(): OfficeExtension.ClientResult<string>;

Retours

OfficeExtension.ClientResult<string>

Remarques

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

hasTitleContent()

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

hasTitleContent(): OfficeExtension.ClientResult<boolean>;

Retours

OfficeExtension.ClientResult<boolean>

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

insertPageAsSibling(location, title)

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

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

Paramètres

location

OneNote.InsertLocation

Emplacement de la nouvelle page par rapport à la page active.

title

string

Titre de la nouvelle page.

Retours

OneNote.Page

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

insertPageAsSibling(locationString, title)

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

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

Paramètres

locationString

"Before" | "After"

Emplacement de la nouvelle page par rapport à la page active.

title

string

Titre de la nouvelle page.

Retours

OneNote.Page

Remarques

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

load(options)

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

options

OneNote.Interfaces.PageLoadOptions

Fournit des options pour les propriétés de l’objet à charger.

Retours

OneNote.Page

load(propertyNames)

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

propertyNames

string | string[]

Chaîne délimitée par des virgules ou tableau de chaînes qui spécifient les propriétés à charger.

Retours

OneNote.Page

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

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select est une chaîne délimitée par des virgules qui spécifie les propriétés à charger, et propertyNamesAndPaths.expand est une chaîne délimitée par des virgules qui spécifie les propriétés de navigation à charger.

Retours

OneNote.Page

set(properties, options)

Définit plusieurs propriétés d’un objet en même temps. Vous pouvez passer un objet brut avec les propriétés appropriées ou un autre objet API du même type.

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

Paramètres

properties

OneNote.Interfaces.PageUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.

options

OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

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

properties

OneNote.Page

Retours

void

toJSON()

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 brut (typé en tant OneNote.Interfaces.PageDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées de l’objet d’origine.

toJSON(): OneNote.Interfaces.PageData;

Retours

OneNote.Interfaces.PageData

track()

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

Retours

OneNote.Page

untrack()

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

Retours

OneNote.Page