Edit

Share via


Word.Interfaces.CommentData interface

An interface describing the data returned by calling comment.toJSON().

Properties

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.

replies

Gets the collection of reply objects associated with 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

authorEmail

Gets the email of the comment's author.

TypeScript
authorEmail?: string;

Property Value

string

Remarks

[ API set: WordApi 1.4 ]

authorName

Gets the name of the comment's author.

TypeScript
authorName?: string;

Property Value

string

Remarks

[ API set: WordApi 1.4 ]

content

Specifies the comment's content as plain text.

TypeScript
content?: string;

Property Value

string

Remarks

[ API set: WordApi 1.4 ]

contentRange

Specifies the comment's content range.

TypeScript
contentRange?: Word.Interfaces.CommentContentRangeData;

Property Value

Remarks

[ API set: WordApi 1.4 ]

creationDate

Gets the creation date of the comment.

TypeScript
creationDate?: Date;

Property Value

Date

Remarks

[ API set: WordApi 1.4 ]

id

Gets the ID of the comment.

TypeScript
id?: string;

Property Value

string

Remarks

[ API set: WordApi 1.4 ]

replies

Gets the collection of reply objects associated with the comment.

TypeScript
replies?: Word.Interfaces.CommentReplyData[];

Property Value

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.

TypeScript
resolved?: boolean;

Property Value

boolean

Remarks

[ API set: WordApi 1.4 ]