OneNote.PageContent class

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 l’objet PageContent.

readonly id: string;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Obtient l’image dans l’objet PageContent. Renvoie une exception si PageContentType n’est pas défini sur Image.

readonly image: OneNote.Image;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Obtient l’entrée manuscrite dans l’objet PageContent. Renvoie une exception si PageContentType n’est pas défini sur Ink.

readonly ink: OneNote.FloatingInk;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Obtient ou définit la position à gauche (axe des abscisses) de l’objet PageContent.

left: number;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Obtient le plan de l’objet PageContent. Renvoie une exception si PageContentType n’est pas défini sur Outline.

readonly outline: OneNote.Outline;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Obtient la page qui contient l’objet PageContent.

readonly parentPage: OneNote.Page;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Obtient ou définit la position supérieure (axe des ordonnées) de l’objet PageContent.

top: number;

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Obtient le type de l’objet PageContent.

readonly type: OneNote.PageContentType | "Outline" | "Image" | "Ink" | "Other";

Valeur de propriété

Remarques

Jeu d’API : OneNoteApi 1.1

Supprime l’objet PageContent.

delete(): void;

Retours

Remarques

Jeu d’API : OneNoteApi 1.1

Exemples

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

    const page = context.application.getActivePage();
    const pageContents = page.contents;

    const firstPageContent = pageContents.getItemAt(0);
    firstPageContent.load('type');

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    if (firstPageContent.isNullObject === false) {
        firstPageContent.delete();
        await context.sync();
    }
});

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.PageContentLoadOptions): OneNote.PageContent;

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

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

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

toJSON(): OneNote.Interfaces.PageContentData;

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

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

Retours