Excel.Comment class

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

readonly authorEmail: string;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.10

Obtient le nom de l’auteur du commentaire.

readonly authorName: string;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.10

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

content: string;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.10

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/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

Jeu d’API : ExcelApi 1.12

Contexte de requête associé à l’objet. Cette opération connecte le processus du complément à celui de l’application hôte Office.

context: RequestContext;

Valeur de propriété

Obtenir l’heure de création du commentaire. Renvoie 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

Jeu d’API : ExcelApi 1.10

Spécifie l’identificateur du commentaire.

readonly id: string;

Valeur de propriété

Remarques

Jeu 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

Jeu 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

Jeu d’API : ExcelApi 1.10

le status du thread de commentaires. La valeur signifie true que le thread de commentaires est résolu.

resolved: boolean;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.11

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/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 de commentaire enrichi (par exemple, les mentions dans les commentaires). Cette chaîne n’est pas destinée à être affichée aux utilisateurs finaux. Votre complément doit utiliser cette fonction uniquement pour analyser le contenu de commentaires enrichis.

readonly richContent: string;

Valeur de propriété

Remarques

Jeu d’API : ExcelApi 1.11

Affecte la tâche jointe au commentaire à l’utilisateur donné en tant que personne affectée. 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

Jeu d’API : ExcelApi BÊTA (PRÉVERSION UNIQUEMENT)

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

delete(): void;

Retours

Remarques

Jeu d’API : ExcelApi 1.10

Exemples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/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

Jeu 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

Jeu d’API : ExcelApi BÊTA (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 renvoie un objet dont la isNullObject propriété est définie sur true. Pour plus d’informations, consultez * Méthodes et propriétés d’OrNullObject.

getTaskOrNullObject(): Excel.DocumentTask;

Retours

Remarques

Jeu d’API : ExcelApi BÊTA (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-comments-and-notes/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 transmettre soit un objet ordinaire avec les propriétés appropriées, soit 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.stringify, à son tour, appelle 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 simple (typé ) Excel.Interfaces.CommentDataqui contient des copies superficielles de toutes les propriétés enfants chargées à partir de l’objet d’origine.

toJSON(): Excel.Interfaces.CommentData;

Retours

Mises à jour du 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

Jeu d’API : ExcelApi 1.11