Partager via

OneNote.PageContent class

  • Référence
Paquet:
onenote

Représente une zone sur une page qui contient des types de contenu de niveau supérieur tels que des plans ou des images. Un objet PageContent peut être affecté à une position XY.

Extends
OfficeExtension.ClientObject

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Propriétés

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 l’objet PageContent. En lecture seule.
image

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

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

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

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

Obtient la page qui contient l’objet PageContent. En lecture seule.
top

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

Obtient le type de l’objet PageContent. En lecture seule.

Méthodes

delete()

Supprime l’objet PageContent.
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.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet OneNote.PageContent d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant OneNote.Interfaces.PageContentDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir 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 deviez avoir ajouté l’objet à la collection d’objets suivie lors de la création de l’objet pour la première fois.
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 libération de la mémoire ne prenne effet.

Détails de la propriété

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

readonly id: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

image

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é

OneNote.Image

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

ink

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é

OneNote.FloatingInk

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

left

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

left: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

outline

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é

OneNote.Outline

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

parentPage

Obtient la page qui contient l’objet PageContent. En lecture seule.

readonly parentPage: OneNote.Page;

Valeur de propriété

OneNote.Page

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

top

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

top: number;

Valeur de propriété

number

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

type

Obtient le type de l’objet PageContent. En lecture seule.

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

Valeur de propriété

OneNote.PageContentType | "Outline" | "Image" | "Ink" | "Other"

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Détails de la méthode

delete()

Supprime l’objet PageContent.

delete(): void;

Retours

void

Remarques

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

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

Paramètres

options
OneNote.Interfaces.PageContentLoadOptions

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

Retours

OneNote.PageContent

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

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

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

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

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.PageContentUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
OneNote.Interfaces.PageContentUpdateData

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

Paramètres

properties
OneNote.PageContent

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.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet OneNote.PageContent d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (tapé en tant OneNote.Interfaces.PageContentDataque ) qui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): OneNote.Interfaces.PageContentData;

Retours

OneNote.Interfaces.PageContentData

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

Retours

OneNote.PageContent

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 libération de la mémoire ne prenne effet.

untrack(): OneNote.PageContent;

Retours

OneNote.PageContent