Edit

Share via

Excel.Interfaces.CommentCollectionLoadOptions interface

  • Reference
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 load options loads all the scalar properties (such as Range.address) but not the navigational properties (such as 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.
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.

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

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 ]

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 ]