Excel.CommentReply class

Représente une réponse de commentaire dans le classeur.

Extends

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

Propriétés

authorEmail

Obtenir l’adresse email de l’auteur de la réponse au commentaire.

authorName

Obtenir le nom de l’auteur de la réponse au commentaire.

content

Contenu de la réponse au commentaire. La chaîne est en texte brut.

contentType

Type de contenu de la réponse.

context

Contexte de requête associé à l’objet . Cela connecte le processus du complément au processus de l’application hôte Office.

creationDate

Obtient l’heure de création de la réponse à un commentaire.

id

Spécifie l’identificateur de réponse au commentaire.

mentions

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

resolved

Réponse au commentaire status. Une valeur de true signifie que la réponse est dans l’état résolu.

richContent

Contenu enrichi des commentaires (par exemple, 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.

Méthodes

assignTask(assignee)

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

delete()

Supprime la réponse de commentaire.

getLocation()

Obtient la cellule où se trouve cette réponse de commentaire.

getParentComment()

Obtient le commentaire parent de cette réponse.

getTask()

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

getTaskOrNullObject()

Obtient la tâche associée au thread de cette réponse de 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.

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.

set(properties, options)

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)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

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

updateMentions(contentWithMentions)

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

Détails de la propriété

authorEmail

Obtenir l’adresse email de l’auteur de la réponse au commentaire.

readonly authorEmail: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

authorName

Obtenir le nom de l’auteur de la réponse au commentaire.

readonly authorName: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

content

Contenu de la réponse au commentaire. La chaîne est en texte brut.

content: string;

Valeur de propriété

string

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-replies.yaml

await Excel.run(async (context) => {
    const sheet = context.workbook.worksheets.getItem("Comments");
    const comment = sheet.comments.getItemAt(0);
    const reply = comment.replies.getItemAt(0);
    reply.load("content");
    // Sync to load the content of the comment reply.
    await context.sync();

    // Append "Please!" to the end of the comment reply.
    reply.content += " Please!";
    await context.sync();
});

contentType

Type de contenu de la réponse.

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

Valeur de propriété

Excel.ContentType | "Plain" | "Mention"

Remarques

[ Ensemble d’API : ExcelApi 1.12 ]

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é

creationDate

Obtient l’heure de création de la réponse à un commentaire.

readonly creationDate: Date;

Valeur de propriété

Date

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

id

Spécifie l’identificateur de réponse au commentaire.

readonly id: string;

Valeur de propriété

string

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

mentions

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

readonly mentions: Excel.CommentMention[];

Valeur de propriété

Remarques

[ Ensemble d’API : ExcelApi 1.11 ]

resolved

Réponse au commentaire status. Une valeur de true signifie que la réponse est dans l’état résolu.

readonly resolved: boolean;

Valeur de propriété

boolean

Remarques

[ Ensemble d’API : ExcelApi 1.11 ]

richContent

Contenu enrichi des commentaires (par exemple, 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é

string

Remarques

[ Ensemble d’API : ExcelApi 1.11 ]

Détails de la méthode

assignTask(assignee)

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

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

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

Paramètres

assignee
Excel.EmailIdentity

Les informations d’identité de l’utilisateur du destinataire.

Retours

Remarques

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

delete()

Supprime la réponse de commentaire.

delete(): void;

Retours

void

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-replies.yaml

await Excel.run(async (context) => {
    // Remove the first comment reply from this worksheet's first comment.
    const sheet = context.workbook.worksheets.getItem("Comments");
    const comment = sheet.comments.getItemAt(0);
    comment.replies.getItemAt(0).delete();
    await context.sync();
});

getLocation()

Obtient la cellule où se trouve cette réponse de commentaire.

getLocation(): Excel.Range;

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

getParentComment()

Obtient le commentaire parent de cette réponse.

getParentComment(): Excel.Comment;

Retours

Remarques

[ Ensemble d’API : ExcelApi 1.10 ]

getTask()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Obtient la tâche associée au thread de cette réponse de 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) ]

getTaskOrNullObject()

Notes

Cet API est fourni en tant qu’aperçu pour les développeurs et peut être modifié en fonction des commentaires que nous avons reçus. N’utilisez pas cet API dans un environnement de production.

Obtient la tâche associée au thread de cette réponse de 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) ]

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?: Excel.Interfaces.CommentReplyLoadOptions): Excel.CommentReply;

Paramètres

options
Excel.Interfaces.CommentReplyLoadOptions

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

Retours

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

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

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;
        }): Excel.CommentReply;

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

set(properties, options)

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.CommentReplyUpdateData, options?: OfficeExtension.UpdateOptions): void;

Paramètres

properties
Excel.Interfaces.CommentReplyUpdateData

Objet JavaScript avec des propriétés qui sont structurées isomorphes en fonction des propriétés de l’objet sur lequel la méthode est appelée.

options
OfficeExtension.UpdateOptions

Fournit une option permettant de supprimer les erreurs si l’objet properties tente de définir des propriétés en lecture seule.

Retours

void

set(properties)

Définit plusieurs propriétés sur l’objet en même temps, en fonction d’un objet chargé existant.

set(properties: Excel.CommentReply): void;

Paramètres

properties
Excel.CommentReply

Retours

void

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

toJSON(): Excel.Interfaces.CommentReplyData;

Retours

updateMentions(contentWithMentions)

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

contentWithMentions
Excel.CommentRichContent

Contenu du commentaire. Il contient une chaîne spécialement mise en forme et une liste de mentions qui seront analysées dans la chaîne lorsqu’Elles seront affichées par Excel.

Retours

void

Remarques

[ Ensemble d’API : ExcelApi 1.11 ]