Word.Interfaces.CommentLoadOptions interface

Package:

word

Represents a comment in the document.

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	Gets the email of the comment's author.
authorName	Gets the name of the comment's author.
content	Specifies the comment's content as plain text.
contentRange	Specifies the comment's content range.
creationDate	Gets the creation date of the comment.
id	Gets the ID of the comment.
resolved	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

Gets the email of the comment's author.

authorEmail?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.4 ]

authorName

Gets the name of the comment's author.

authorName?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.4 ]

content

Specifies the comment's content as plain text.

content?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.4 ]

contentRange

Specifies the comment's content range.

contentRange?: Word.Interfaces.CommentContentRangeLoadOptions;

Property Value

Word.Interfaces.CommentContentRangeLoadOptions

Remarks

[ API set: WordApi 1.4 ]

creationDate

Gets the creation date of the comment.

creationDate?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.4 ]

id

Gets the ID of the comment.

id?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.4 ]

resolved

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 ]