Partager via

OneNote.Outline class

  • Référence
Paquet:
onenote

Représente un conteneur pour les objets Paragraph.

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 Outline.
pageContent

Obtient l’objet PageContent qui contient le plan. Cet objet définit la position du plan sur la page.
paragraphs

Obtient la collection d’objets Paragraph dans le plan.

Méthodes

appendHtml(html)

Ajoute le code HTML spécifié dans la partie inférieure du plan.
appendImage(base64EncodedImage, width, height)

Ajoute l’image spécifiée dans la partie inférieure du plan.
appendRichText(paragraphText)

Ajoute le texte spécifié dans la partie inférieure du plan.
appendTable(rowCount, columnCount, values)

Ajoute un tableau avec le nombre spécifié de lignes et de colonnes dans la partie inférieure du plan.
isTitle()

Vérifiez si le plan est un plan de titre.
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.
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.Outline est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant OneNote.Interfaces.OutlineDataque ) 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é

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

readonly id: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

pageContent

Obtient l’objet PageContent qui contient le plan. Cet objet définit la position du plan sur la page.

readonly pageContent: OneNote.PageContent;

Valeur de propriété

OneNote.PageContent

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

paragraphs

Obtient la collection d’objets Paragraph dans le plan.

readonly paragraphs: OneNote.ParagraphCollection;

Valeur de propriété

OneNote.ParagraphCollection

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Détails de la méthode

appendHtml(html)

Ajoute le code HTML spécifié dans la partie inférieure du plan.

appendHtml(html: string): void;

Paramètres

html

string

Chaîne HTML à ajouter. Consultez HTML pris en charge pour l’API JavaScript des compléments OneNote.

Retours

void

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Exemples

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

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

    // Get pageContents of the activePage.
    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();
    if (pageContents.items.length != 0 && pageContents.items[0].type == "Outline")
    {
        // First item is an outline.
        const outline = pageContents.items[0].outline;

        // Queue a command to append a paragraph to the outline.
        outline.appendHtml("<p>new paragraph</p>");

        // Run the queued commands.
        await context.sync();
    }
});

appendImage(base64EncodedImage, width, height)

Ajoute l’image spécifiée dans la partie inférieure du plan.

appendImage(base64EncodedImage: string, width: number, height: number): OneNote.Image;

Paramètres

base64EncodedImage

string

Chaîne HTML à ajouter.

width

number

Optional. Largeur de l’unité des points. La valeur par défaut est Null et la largeur d’image est respectée.

height

number

Optional. Hauteur de l’unité des points. La valeur par défaut est Null et la hauteur d’image est respectée.

Retours

OneNote.Image

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

appendRichText(paragraphText)

Ajoute le texte spécifié dans la partie inférieure du plan.

appendRichText(paragraphText: string): OneNote.RichText;

Paramètres

paragraphText

string

Chaîne HTML à ajouter.

Retours

OneNote.RichText

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

appendTable(rowCount, columnCount, values)

Ajoute un tableau avec le nombre spécifié de lignes et de colonnes dans la partie inférieure du plan.

appendTable(rowCount: number, columnCount: number, values?: string[][]): OneNote.Table;

Paramètres

rowCount

number

Obligatoire. Nombre de lignes dans le tableau.

columnCount

number

Obligatoire. Nombre de colonnes dans le tableau.

values

string[][]

Tableau 2D facultatif. Les cellules sont remplies si les chaînes correspondantes sont spécifiées dans le tableau.

Retours

OneNote.Table

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Exemples

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

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

    // Get pageContents of the activePage.
    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();
    if (pageContents.items.length != 0 && pageContents.items[0].type == "Outline") {
        // First item is an outline.
        const outline = pageContents.items[0].outline;

        // Queue a command to append a paragraph to the outline.
        outline.appendTable(2, 2, [["1", "2"],["3", "4"]]);

        // Run the queued commands.
        await context.sync();
    }
});

isTitle()

Vérifiez si le plan est un plan de titre.

isTitle(): OfficeExtension.ClientResult<boolean>;

Retours

OfficeExtension.ClientResult<boolean>

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

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.OutlineLoadOptions): OneNote.Outline;

Paramètres

options
OneNote.Interfaces.OutlineLoadOptions

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

Retours

OneNote.Outline

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

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

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

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

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

toJSON(): OneNote.Interfaces.OutlineData;

Retours

OneNote.Interfaces.OutlineData

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

Retours

OneNote.Outline

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

Retours

OneNote.Outline