Edit

Share via

Excel.Interfaces.CommentLoadOptions interface

  • Reference
Package:
excel

Represents a comment in the workbook.

Remarks

[ API set: ExcelApi 1.10 ]

Properties

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).
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.
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

$all

Specifying $all for the load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as Range.format.fill.color).

$all?: boolean;

Property Value

boolean

authorEmail

Gets the email of the comment's author.

authorEmail?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.10 ]

authorName

Gets the name of the comment's author.

authorName?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.10 ]

content

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

content?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.10 ]

contentType

Gets the content type of the comment.

contentType?: boolean;

Property Value

boolean

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?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.10 ]

id

Specifies the comment identifier.

id?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.10 ]

mentions

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

mentions?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.11 ]

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?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.11 ]