ExcelScript.CommentReply interface

Package:

ExcelScript

Represents a comment reply in the workbook.

Methods

delete()	Deletes the comment reply.
getAuthorEmail()	Gets the email of the comment reply's author.
getAuthorName()	Gets the name of the comment reply's author.
getContent()	The comment reply's content. The string is plain text.
getContentType()	The content type of the reply.
getCreationDate()	Gets the creation time of the comment reply.
getId()	Specifies the comment reply identifier.
getLocation()	Gets the cell where this comment reply is located.
getMentions()	The entities (e.g., people) that are mentioned in comments.
getParentComment()	Gets the parent comment of this reply.
getResolved()	The comment reply status. A value of true means the reply is in the resolved state.
getRichContent()	The rich comment content (e.g., mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content.
setContent(content)	The comment reply's content. The string is plain text.
updateMentions(contentWithMentions)	Updates the comment content with a specially formatted string and a list of mentions.

Method Details

delete()

Deletes the comment reply.

delete(): void;

Returns

void

getAuthorEmail()

Gets the email of the comment reply's author.

getAuthorEmail(): string;

Returns

string

getAuthorName()

Gets the name of the comment reply's author.

getAuthorName(): string;

Returns

string

getContent()

The comment reply's content. The string is plain text.

getContent(): string;

Returns

string

getContentType()

The content type of the reply.

getContentType(): ContentType;

Returns

ExcelScript.ContentType

getCreationDate()

Gets the creation time of the comment reply.

getCreationDate(): Date;

Returns

Date

getId()

Specifies the comment reply identifier.

getId(): string;

Returns

string

getLocation()

Gets the cell where this comment reply is located.

getLocation(): Range;

Returns

ExcelScript.Range

getMentions()

The entities (e.g., people) that are mentioned in comments.

getMentions(): CommentMention[];

Returns

ExcelScript.CommentMention[]

getParentComment()

Gets the parent comment of this reply.

getParentComment(): Comment;

Returns

ExcelScript.Comment

getResolved()

The comment reply status. A value of true means the reply is in the resolved state.

getResolved(): boolean;

Returns

boolean

getRichContent()

The rich comment content (e.g., mentions in comments). This string is not meant to be displayed to end-users. Your add-in should only use this to parse rich comment content.

getRichContent(): string;

Returns

string

setContent(content)

The comment reply's content. The string is plain text.

setContent(content: string): void;

Parameters

content

string

Returns

void

updateMentions(contentWithMentions)

Updates the comment content with a specially formatted string and a list of mentions.

updateMentions(contentWithMentions: CommentRichContent): void;

Parameters

contentWithMentions

ExcelScript.CommentRichContent

The content for the comment. This contains a specially formatted string and a list of mentions that will be parsed into the string when displayed by Excel.

Returns

void