Excel.Comment class

Obtenir l’adresse email de l’auteur du commentaire.

readonly authorEmail: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Obtient le nom de l’auteur du commentaire.

readonly authorName: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Contenu du commentaire. La chaîne est en texte brut.

content: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-basics.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Comments");
    const comment = sheet.comments.getItemAt(0);
    comment.content = "PLEASE add headers here.";
    await context.sync();
});

Obtient le type de contenu du commentaire.

readonly contentType: Excel.ContentType | "Plain" | "Mention";

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.12 ]

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é

Obtenir l’heure de création du commentaire. Retourne null si le commentaire a été converti à partir d’une note, car le commentaire n’a pas de date de création.

readonly creationDate: Date;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Spécifie l’identificateur du commentaire.

readonly id: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Obtient les entités (par exemple, les personnes) mentionnées dans les commentaires.

readonly mentions: Excel.CommentMention[];

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.11 ]

Représente une collection de feuilles de calcul associées au classeur.

readonly replies: Excel.CommentReplyCollection;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Le thread de commentaire status. Une valeur de true signifie que le thread de commentaire est résolu.

resolved: boolean;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.11 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-resolution.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Comments");
    sheet.comments.getItemAt(0).resolved = true;
    await context.sync();
});

Obtient le contenu enrichi des commentaires (par exemple, les mentions dans les commentaires). Cette chaîne n’est pas destinée à être affichée pour les utilisateurs finaux. Votre complément doit uniquement l’utiliser pour analyser le contenu des commentaires enrichis.

readonly richContent: string;

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.11 ]

Affecte la tâche jointe au commentaire à l’utilisateur donné en tant que destinataire. S’il n’y a pas de tâche, une tâche est créée.

assignTask(assignee: Excel.EmailIdentity): Excel.DocumentTask;

Paramètres

Retours

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

Supprime le commentaire et toutes les réponses connectées.

delete(): void;

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-basics.yaml

await Excel.run(async (context) => {
    context.workbook.comments.getItemByCell("Comments!A2").delete();
    await context.sync();
});

Obtient la cellule où se trouve ce commentaire.

getLocation(): Excel.Range;

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Obtient la tâche associée à ce commentaire. S’il n’existe aucune tâche pour le thread de commentaire, une ItemNotFound exception est levée.

getTask(): Excel.DocumentTask;

Retours

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

Obtient la tâche associée à ce commentaire. S’il n’existe aucune tâche pour le thread de commentaire, cette méthode retourne un objet avec sa isNullObject propriété définie sur true. Pour plus d’informations, consultez *Méthodes et propriétés OrNullObject.

getTaskOrNullObject(): Excel.DocumentTask;

Retours

Remarques

[ Ensemble d’API : ExcelApi BETA (PRÉVERSION UNIQUEMENT) ]

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?: Excel.Interfaces.CommentLoadOptions): Excel.Comment;

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[]): Excel.Comment;

Paramètres

Retours

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comment/comment-basics.yaml

await Excel.run(async (context) => {
    const comment = context.workbook.comments.getItemByCell("Comments!A2");
    comment.load(["authorEmail", "authorName", "creationDate"]);
    await context.sync();

    console.log(`${comment.creationDate.toDateString()}: ${comment.authorName} (${comment.authorEmail})`);
    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(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.Comment;

Paramètres

Retours

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

toJSON(): Excel.Interfaces.CommentData;

Retours

Mises à jour le contenu du commentaire avec une chaîne spécialement mise en forme et une liste de mentions.

updateMentions(contentWithMentions: Excel.CommentRichContent): void;

Paramètres

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.11 ]