ExcelScript.Comment interface

Paquet:

ExcelScript

Représente un commentaire dans le classeur.

Méthodes

addCommentReply(content, contentType)	Crée une réponse de commentaire pour un commentaire.
delete()	Supprime le commentaire et toutes les réponses connectées.
getAuthorEmail()	Obtenir l’adresse email de l’auteur du commentaire.
getAuthorName()	Obtient le nom de l’auteur du commentaire.
getCommentReply(commentReplyId)	Renvoie une réponse de commentaire identifié via son ID. Si l’objet de réponse au commentaire n’existe pas, cette méthode retourne undefined.
getContent()	Contenu du commentaire. La chaîne est en texte brut.
getContentType()	Obtient le type de contenu du commentaire.
getCreationDate()	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.
getId()	Spécifie l’identificateur du commentaire.
getLocation()	Obtient la cellule où se trouve ce commentaire.
getMentions()	Obtient les entités (par exemple, les personnes) mentionnées dans les commentaires.
getReplies()	Représente une collection de feuilles de calcul associées au classeur.
getResolved()	Le thread de commentaire status. Une valeur de true signifie que le thread de commentaire est résolu.
getRichContent()	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.
setContent(content)	Contenu du commentaire. La chaîne est en texte brut.
setResolved(resolved)	Le thread de commentaire status. Une valeur de true signifie que le thread de commentaire est résolu.
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 méthode

addCommentReply(content, contentType)

Crée une réponse de commentaire pour un commentaire.

addCommentReply(
            content: CommentRichContent | string,
            contentType?: ContentType
        ): CommentReply;

Paramètres

content

ExcelScript.CommentRichContent | string

Contenu du commentaire. Il peut s’agir d’une chaîne ou d’un CommentRichContent objet (par exemple, pour les commentaires avec des mentions).

contentType

ExcelScript.ContentType

Optional. Type de contenu contenu dans le commentaire. La valeur par défaut est enum ContentType.Plain.

Retours

ExcelScript.CommentReply

delete()

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

delete(): void;

Retours

void

getAuthorEmail()

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

getAuthorEmail(): string;

Retours

string

getAuthorName()

Obtient le nom de l’auteur du commentaire.

getAuthorName(): string;

Retours

string

getCommentReply(commentReplyId)

Renvoie une réponse de commentaire identifié via son ID. Si l’objet de réponse au commentaire n’existe pas, cette méthode retourne undefined.

getCommentReply(commentReplyId: string): CommentReply | undefined;

Paramètres

commentReplyId

string

Identificateur de la réponse au commentaire.

Retours

ExcelScript.CommentReply | undefined

getContent()

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

getContent(): string;

Retours

string

getContentType()

Obtient le type de contenu du commentaire.

getContentType(): ContentType;

Retours

ExcelScript.ContentType

getCreationDate()

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.

getCreationDate(): Date;

Retours

Date

getId()

Spécifie l’identificateur du commentaire.

getId(): string;

Retours

string

getLocation()

Obtient la cellule où se trouve ce commentaire.

getLocation(): Range;

Retours

ExcelScript.Range

getMentions()

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

getMentions(): CommentMention[];

Retours

ExcelScript.CommentMention[]

getReplies()

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

getReplies(): CommentReply[];

Retours

ExcelScript.CommentReply[]

getResolved()

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

getResolved(): boolean;

Retours

boolean

getRichContent()

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.

getRichContent(): string;

Retours

string

setContent(content)

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

setContent(content: string): void;

Paramètres

content

string

Retours

void

setResolved(resolved)

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

setResolved(resolved: boolean): void;

Paramètres

resolved

boolean

Retours

void

updateMentions(contentWithMentions)

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

updateMentions(contentWithMentions: CommentRichContent): void;

Paramètres

contentWithMentions

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