Partager via

OneNote.RichText class

  • Référence
Paquet:
onenote

Représente un objet RichText dans un paragraphe.

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 RichText. En lecture seule.
languageId

ID de langue du texte. En lecture seule.
paragraph

Renvoie l’objet Paragraph qui contient l’objet RichText. En lecture seule.
style

Obtient le style de texte de l’objet RichText. En lecture seule.
text

Obtient le texte de l’objet RichText. En lecture seule.

Méthodes

getHtml()

Obtenir le code HTML du texte enrichi.
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.stringifyappelle à son tour la toJSON méthode de l’objet qui lui est passé.) Alors que l’objet OneNote.RichText d’origine est un objet API, la toJSON méthode renvoie un objet JavaScript brut (typé en tant OneNote.Interfaces.RichTextDataque ) 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 RichText. En lecture seule.

readonly id: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

languageId

ID de langue du texte. En lecture seule.

readonly languageId: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

paragraph

Renvoie l’objet Paragraph qui contient l’objet RichText. En lecture seule.

readonly paragraph: OneNote.Paragraph;

Valeur de propriété

OneNote.Paragraph

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

style

Obtient le style de texte de l’objet RichText. En lecture seule.

readonly style: OneNote.ParagraphStyle;

Valeur de propriété

OneNote.ParagraphStyle

Remarques

[ Ensemble d’API : OneNoteApi 1.8 ]

text

Obtient le texte de l’objet RichText. En lecture seule.

readonly text: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : OneNoteApi 1.1 ]

Détails de la méthode

getHtml()

Obtenir le code HTML du texte enrichi.

getHtml(): OfficeExtension.ClientResult<string>;

Retours

OfficeExtension.ClientResult<string>

Html du texte enrichi

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.RichTextLoadOptions): OneNote.RichText;

Paramètres

options
OneNote.Interfaces.RichTextLoadOptions

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

Retours

OneNote.RichText

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

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

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 paragraphs.
    const outlinePageContents = pageContents.getItem(0);
    let paragraphs = outlinePageContents.outline.paragraphs;
    const richTextParagraphs = paragraphs.items;
    // Queue a command to load the id and type of each page content in the outline.
    pageContents.load("id,type");

    // Run the queued commands, and return a promise to indicate task completion.
    await context.sync();

    // Load all page contents of type Outline.
    $.each(pageContents.items, function(index, pageContent) {
        if(pageContent.type == 'Outline')
        {
            pageContent.load('outline,outline/paragraphs,outline/paragraphs/type');
            outlinePageContents.push(pageContent);
        }
    });
    await context.sync();

    // Load all rich text paragraphs across outlines.
    $.each(outlinePageContents, function(index, outlinePageContent) {
        const outline = outlinePageContent.outline;
        paragraphs = paragraphs.concat(outline.paragraphs.items);
    });
    $.each(paragraphs, function(index, paragraph) {
        if(paragraph.type == 'RichText')
        {
            richTextParagraphs.push(paragraph);
            paragraph.load("id,richText/text");
        }
    });
    await context.sync();

    // Display all rich text paragraphs to the console.
    $.each(richTextParagraphs, function(index, richTextParagraph) {
        const richText = richTextParagraph.richText;
        console.log(
            "Paragraph found with richtext content : " + 
            richText.text + " and richtext id : " + richText.id);
    });
    await context.sync();
});

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

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

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

toJSON(): OneNote.Interfaces.RichTextData;

Retours

OneNote.Interfaces.RichTextData

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

Retours

OneNote.RichText

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

Retours

OneNote.RichText