Word.CommentReply class

Package:

word

Represents a comment reply in the document.

Extends

OfficeExtension.ClientObject

Remarks

[ API set: WordApi 1.4 ]

Properties

authorEmail	Gets the email of the comment reply's author.
authorName	Gets the name of the comment reply's author.
content	Specifies the comment reply's content. The string is plain text.
contentRange	Specifies the commentReply's content range.
context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
creationDate	Gets the creation date of the comment reply.
id	Gets the ID of the comment reply.
parentComment	Gets the parent comment of this reply.

Methods

delete()	Deletes the comment reply.
load(options)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
set(properties, options)	Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties)	Sets multiple properties on the object at the same time, based on an existing loaded object.
toJSON()	Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Word.CommentReply object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.CommentReplyData) that contains shallow copies of any loaded child properties from the original object.
track()	Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.
untrack()	Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.

Property Details

authorEmail

Gets the email of the comment reply's author.

readonly authorEmail: string;

Property Value

string

Remarks

[ API set: WordApi 1.4 ]

authorName

Gets the name of the comment reply's author.

readonly authorName: string;

Property Value

string

Remarks

[ API set: WordApi 1.4 ]

content

Specifies the comment reply's content. The string is plain text.

content: string;

Property Value

string

Remarks

[ API set: WordApi 1.4 ]

contentRange

Specifies the commentReply's content range.

contentRange: Word.CommentContentRange;

Property Value

Word.CommentContentRange

Remarks

[ API set: WordApi 1.4 ]

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Word.RequestContext

creationDate

Gets the creation date of the comment reply.

readonly creationDate: Date;

Property Value

Date

Remarks

[ API set: WordApi 1.4 ]

id

Gets the ID of the comment reply.

readonly id: string;

Property Value

string

Remarks

[ API set: WordApi 1.4 ]

parentComment

Gets the parent comment of this reply.

readonly parentComment: Word.Comment;

Property Value

Word.Comment

Remarks

[ API set: WordApi 1.4 ]

Method Details

delete()

Deletes the comment reply.

delete(): void;

Returns

void

Remarks

[ API set: WordApi 1.4 ]

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(options?: Word.Interfaces.CommentReplyLoadOptions): Word.CommentReply;

Parameters

options

Word.Interfaces.CommentReplyLoadOptions

Provides options for which properties of the object to load.

Returns

Word.CommentReply

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNames?: string | string[]): Word.CommentReply;

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

Word.CommentReply

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.CommentReply;

Parameters

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

Word.CommentReply

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

set(properties: Interfaces.CommentReplyUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parameters

properties

Word.Interfaces.CommentReplyUpdateData

A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options

OfficeExtension.UpdateOptions

Provides an option to suppress errors if the properties object tries to set any read-only properties.

Returns

void

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Word.CommentReply): void;

Parameters

properties

Word.CommentReply

Returns

void

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Word.CommentReply object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.CommentReplyData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Word.Interfaces.CommentReplyData;

Returns

Word.Interfaces.CommentReplyData

track()

Track the object for automatic adjustment based on surrounding changes in the document. This call is a shorthand for context.trackedObjects.add(thisObject). If you're using this object across .sync calls and outside the sequential execution of a ".run" batch, and get an "InvalidObjectPath" error when setting a property or invoking a method on the object, you need to add the object to the tracked object collection when the object was first created. If this object is part of a collection, you should also track the parent collection.

track(): Word.CommentReply;

Returns

Word.CommentReply

untrack()

Release the memory associated with this object, if it has previously been tracked. This call is shorthand for context.trackedObjects.remove(thisObject). Having many tracked objects slows down the host application, so please remember to free any objects you add, once you're done using them. You'll need to call context.sync() before the memory release takes effect.

untrack(): Word.CommentReply;

Returns

Word.CommentReply