Word.Interfaces.CommentCollectionLoadOptions interface

Package:

word

Contains a collection of Word.Comment objects.

Remarks

[ API set: WordApi 1.4 ]

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: Specifies the comment's content as plain text.
contentRange	For EACH ITEM in the collection: Specifies the comment's content range.
creationDate	For EACH ITEM in the collection: Gets the creation date of the comment.
id	For EACH ITEM in the collection: Gets the ID of the comment.
resolved	For EACH ITEM in the collection: Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved.

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: WordApi 1.4 ]

authorName

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

authorName?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.4 ]

content

For EACH ITEM in the collection: Specifies the comment's content as plain text.

content?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.4 ]

contentRange

For EACH ITEM in the collection: Specifies the comment's content range.

contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;

Property Value

Word.Interfaces.CommentContentRangeLoadOptions

Remarks

[ API set: WordApi 1.4 ]

creationDate

For EACH ITEM in the collection: Gets the creation date of the comment.

creationDate?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.4 ]

id

For EACH ITEM in the collection: Gets the ID of the comment.

id?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.4 ]

resolved

For EACH ITEM in the collection: Specifies the comment thread's status. Setting to true resolves the comment thread. Getting a value of true means that the comment thread is resolved.

resolved?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.4 ]