Word.Comment class
Represents a comment in the document.
- Extends
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml
// Sets a comment on the selected content.
await Word.run(async (context) => {
const text = (document.getElementById("comment-text") as HTMLInputElement).value;
const comment: Word.Comment = context.document.getSelection().insertComment(text);
// Load object to log in the console.
comment.load();
await context.sync();
console.log("Comment inserted:", comment);
});
Properties
| author |
Gets the email of the comment's author. |
| author |
Gets the name of the comment's author. |
| content | Specifies the comment's content as plain text. |
| content |
Specifies the comment'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. |
| creation |
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. |
Methods
| delete() | Deletes the comment and its replies. |
| get |
Gets the range in the main document where the comment is on. |
| load(options) | Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| load(property |
Queues up a command to load the specified properties of the object. You must call |
| reply(reply |
Adds a new reply to the end of the comment thread. |
| 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 |
| 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 |
| 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 |
Property Details
authorEmail
Gets the email of the comment's author.
readonly authorEmail: string;Property Value
string
Remarks
authorName
Gets the name of the comment's author.
readonly authorName: string;Property Value
string
Remarks
content
Specifies the comment's content as plain text.
content: string;Property Value
string
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml
// Edits the first active comment in the selected content.
await Word.run(async (context) => {
const text = (document.getElementById("edit-comment-text") as HTMLInputElement).value;
const comments: Word.CommentCollection = context.document.getSelection().getComments();
comments.load("items");
await context.sync();
const firstActiveComment: Word.Comment = comments.items.find((item) => item.resolved !== true);
if (!firstActiveComment) {
console.warn("No active comment was found in the selection, so couldn't edit.");
return;
}
firstActiveComment.content = text;
// Load object to log in the console.
firstActiveComment.load();
await context.sync();
console.log("Comment content changed:", firstActiveComment);
});
contentRange
Specifies the comment's content range.
contentRange: Word.CommentContentRange;Property Value
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml
// Gets the range of the first comment in the selected content.
await Word.run(async (context) => {
const comment: Word.Comment = context.document.getSelection().getComments().getFirstOrNullObject();
comment.load("contentRange");
const range: Word.Range = comment.getRange();
range.load("text");
await context.sync();
if (comment.isNullObject) {
console.warn("No comments in the selection, so no range to get.");
return;
}
console.log(`Comment location: ${range.text}`);
const contentRange: Word.CommentContentRange = comment.contentRange;
console.log("Comment content range:", contentRange);
});
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
creationDate
Gets the creation date of the comment.
readonly creationDate: Date;Property Value
Date
Remarks
id
Gets the ID of the comment.
readonly id: string;Property Value
string
Remarks
replies
Gets the collection of reply objects associated with the comment.
readonly replies: Word.CommentReplyCollection;Property Value
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml
// Gets the replies to the first comment in the selected content.
await Word.run(async (context) => {
const comment: Word.Comment = context.document.getSelection().getComments().getFirstOrNullObject();
comment.load("replies");
await context.sync();
if (comment.isNullObject) {
console.warn("No comments in the selection, so no replies to get.");
return;
}
const replies: Word.CommentReplyCollection = comment.replies;
console.log("Replies to the first comment:", replies);
});
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
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml
// Toggles Resolved status of the first comment in the selected content.
await Word.run(async (context) => {
const comment: Word.Comment = context.document
.getSelection()
.getComments()
.getFirstOrNullObject();
comment.load("resolved");
await context.sync();
if (comment.isNullObject) {
console.warn("No comments in the selection, so nothing to toggle.");
return;
}
// Toggle resolved status.
// If the comment is active, set as resolved.
// If it's resolved, set resolved to false.
const resolvedBefore = comment.resolved;
console.log(`Comment Resolved status (before): ${resolvedBefore}`);
comment.resolved = !resolvedBefore;
comment.load("resolved");
await context.sync();
console.log(`Comment Resolved status (after): ${comment.resolved}`);
});
Method Details
delete()
Deletes the comment and its replies.
delete(): void;Returns
void
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml
// Deletes the first comment in the selected content.
await Word.run(async (context) => {
const comment: Word.Comment = context.document.getSelection().getComments().getFirstOrNullObject();
comment.delete();
await context.sync();
if (comment.isNullObject) {
console.warn("No comments in the selection, so nothing to delete.");
return;
}
console.log("Comment deleted.");
});
getRange()
Gets the range in the main document where the comment is on.
getRange(): Word.Range;Returns
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml
// Gets the range of the first comment in the selected content.
await Word.run(async (context) => {
const comment: Word.Comment = context.document.getSelection().getComments().getFirstOrNullObject();
comment.load("contentRange");
const range: Word.Range = comment.getRange();
range.load("text");
await context.sync();
if (comment.isNullObject) {
console.warn("No comments in the selection, so no range to get.");
return;
}
console.log(`Comment location: ${range.text}`);
const contentRange: Word.CommentContentRange = comment.contentRange;
console.log("Comment content range:", contentRange);
});
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.CommentLoadOptions): Word.Comment;Parameters
Provides options for which properties of the object to load.
Returns
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.Comment;Parameters
- propertyNames
-
string | string[]
A comma-delimited string or an array of strings that specify the properties to load.
Returns
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.Comment;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
reply(replyText)
Adds a new reply to the end of the comment thread.
reply(replyText: string): Word.CommentReply;Parameters
- replyText
-
string
Required. Reply text.
Returns
Remarks
Examples
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-comments.yaml
// Replies to the first active comment in the selected content.
await Word.run(async (context) => {
const text = (document.getElementById("reply-text") as HTMLInputElement).value;
const comments: Word.CommentCollection = context.document.getSelection().getComments();
comments.load("items");
await context.sync();
const firstActiveComment: Word.Comment = comments.items.find((item) => item.resolved !== true);
if (firstActiveComment) {
const reply: Word.CommentReply = firstActiveComment.reply(text);
console.log("Reply added.");
} else {
console.warn("No active comment was found in the selection, so couldn't reply.");
}
});
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.CommentUpdateData, options?: OfficeExtension.UpdateOptions): void;Parameters
- properties
- Word.Interfaces.CommentUpdateData
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.Comment): void;Parameters
- properties
- Word.Comment
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's passed to it.) Whereas the original Word.Comment object is an API object, the toJSON method returns a plain JavaScript object (typed as Word.Interfaces.CommentData) that contains shallow copies of any loaded child properties from the original object.
toJSON(): Word.Interfaces.CommentData;Returns
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.Comment;Returns
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.Comment;