Excel.Interfaces.CommentCollectionLoadOptions interface

Package:

excel

Represents a collection of comment objects that are part of the workbook.

Remarks

[ API set: ExcelApi 1.10 ]

Properties

$all	Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).
authorEmail	For EACH ITEM in the collection: Gets the email of the comment's author.
authorName	For EACH ITEM in the collection: Gets the name of the comment's author.
content	For EACH ITEM in the collection: The comment's content. The string is plain text.
contentType	For EACH ITEM in the collection: Gets the content type of the comment.
creationDate	For EACH ITEM in the collection: 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	For EACH ITEM in the collection: Specifies the comment identifier.
mentions	For EACH ITEM in the collection: Gets the entities (e.g., people) that are mentioned in comments.
resolved	For EACH ITEM in the collection: The comment thread status. A value of true means that the comment thread is resolved.
richContent	For EACH ITEM in the collection: 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 LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

$all?: boolean;

Property Value

boolean

authorEmail

For EACH ITEM in the collection: Gets the email of the comment's author.

authorEmail?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.10 ]

authorName

For EACH ITEM in the collection: Gets the name of the comment's author.

authorName?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.10 ]

content

For EACH ITEM in the collection: The comment's content. The string is plain text.

content?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.10 ]

contentType

For EACH ITEM in the collection: Gets the content type of the comment.

contentType?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.12 ]

creationDate

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies the comment identifier.

id?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.10 ]

mentions

For EACH ITEM in the collection: Gets the entities (e.g., people) that are mentioned in comments.

mentions?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.11 ]

resolved

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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 ]