Edit

Excel.Interfaces.CommentData interface

  • Reference
Package:
excel

An interface describing the data returned by calling comment.toJSON().

Properties

authorEmail

Gets the email of the comment's author.
authorName

Gets the name of the comment's author.
content

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

Gets the content type of the comment.
creationDate

Gets the creation time of the comment. Returns null if the comment was converted from a note, since the comment does not have a creation date.
id

Specifies the comment identifier.
mentions

Gets the entities (e.g., people) that are mentioned in comments.
replies

Represents a collection of reply objects associated with the comment.
resolved

The comment thread status. A value of true means that the comment thread is resolved.
richContent

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

Property Details

authorEmail

Gets the email of the comment's author.

authorEmail?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.10 ]

authorName

Gets the name of the comment's author.

authorName?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.10 ]

content

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

content?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.10 ]

contentType

Gets the content type of the comment.

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

Property Value

Excel.ContentType | "Plain" | "Mention"

Remarks

[ API set: ExcelApi 1.12 ]

creationDate

Gets the creation time of the comment. Returns null if the comment was converted from a note, since the comment does not have a creation date.

creationDate?: Date;

Property Value

Date

Remarks

[ API set: ExcelApi 1.10 ]

id

Specifies the comment identifier.

id?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.10 ]

mentions

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

mentions?: Excel.CommentMention[];

Property Value

Excel.CommentMention[]

Remarks

[ API set: ExcelApi 1.11 ]

replies

Represents a collection of reply objects associated with the comment.

replies?: Excel.Interfaces.CommentReplyData[];

Property Value

Excel.Interfaces.CommentReplyData[]

Remarks

[ API set: ExcelApi 1.10 ]

resolved

The comment thread status. A value of true means that the comment thread is resolved.

resolved?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.11 ]

richContent

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

richContent?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.11 ]