OneNote.ParagraphCollection class

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é

Renvoie le nombre de paragraphes dans la page.

readonly count: number;

Valeur de propriété

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Obtient l’élément enfant chargé dans cette collection de sites.

readonly items: OneNote.Paragraph[];

Valeur de propriété

Obtient un objet Paragraph en fonction de son ID ou de son index dans la collection. En lecture seule.

getItem(index: number | string): OneNote.Paragraph;

Paramètres

Retours

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Obtient un paragraphe en fonction de sa position dans la collection.

getItemAt(index: number): OneNote.Paragraph;

Paramètres

Retours

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Exemples

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

    // Get the collection of pageContent items from the page.
    const pageContents = context.application.getActivePage().contents;

    // Get the first PageContent on the page, and then get its Outline's first paragraph.
    const pageContent = pageContents.getItemAt(0);
    const paragraphs = pageContent.outline.paragraphs;

    const firstParagraph = paragraphs.getItemAt(0);

    // Queue a command to load the id and type properties of this paragraph.
    firstParagraph.load("id,type");


    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    // Write text from paragraph to console.
    console.log(
        "First Paragraph found with id : " + 
        firstParagraph.id + " and type " + firstParagraph.type);
});

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.ParagraphCollectionLoadOptions & OneNote.Interfaces.CollectionLoadOptions): OneNote.ParagraphCollection;

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

Paramètres

Retours

Exemples

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

    // Get the collection of pageContent items from the page.
    const pageContents = context.application.getActivePage().contents;

    // Get the first PageContent on the page, and then get its Outline's first paragraph.
    const pageContent = pageContents.getItem(0);
    const paragraphs = pageContent.outline.paragraphs;
    
    // Queue a command to load the id and type of each paragraph.
    paragraphs.load("id,type");

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();
    const firstParagraph = paragraphs.items[0];
    // Write text from first paragraph to console.
    console.log(
        "First Paragraph found with id : " + 
        firstParagraph.id + " and type " + firstParagraph.type);
});

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?: OfficeExtension.LoadOption): OneNote.ParagraphCollection;

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.ParagraphCollection est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant OneNote.Interfaces.ParagraphCollectionDataque ) qui contient un tableau « items » avec des copies superficielles de toutes les propriétés chargées à partir des éléments de la collection.

toJSON(): OneNote.Interfaces.ParagraphCollectionData;

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

Retours

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

Retours