Working with Comments
Try online
You can try this functionality with our Free online remove annotations.
Aspose.Words allows users to work with comments – comments in a document in Aspose.Words are represented by the Comment class. Also use the CommentRangeStart and CommentRangeEnd classes to specify the region of text that should be associated with a comment.
Add a Comment
Aspose.Words allows you to add comments in several ways:
- Using the Comment class
- Using the CommentRangeStart and CommentRangeEnd classes
The following code example shows how to add a comment to a paragraph using the Comment class:
The following code example shows how to add a comment to a paragraph using a region of text and the CommentRangeStart and CommentRangeEnd classes:
Extract or Remove Comments
Using Comments in a Word document (in addition to Track Changes) is a common practice when reviewing documents, particularly when there are multiple reviewers. There can be situations where the only thing you need from a document is the comments. Say you want to generate a list of review findings, or perhaps you have collected all the useful information from the document and you simply want to remove unnecessary comments. You may want to view or remove the comments of a particular reviewer.
In this sample, we are going to look at some simple methods for both gathering information from the comments within a document and for removing comments from a document. Specifically, we’ll cover how to:
- Extract all the comments from a document or only the ones made by a particular author.
- Remove all the comments from a document or only from a particular author.
How to Extract or Remove Comments
The code in this sample is quite simple and all methods are based on the same approach. A comment in a Word document is represented by a Comment object in the Aspose.Words document object model. To collect all the comments in a document use the getChildNodes method with the first parameter set to NodeType.Comment. Make sure that the second parameter of the getChildNodes method is set to true: this forces the getChildNodes to select from all child nodes recursively, rather than only collecting the immediate children.
To illustrate how to extract and remove comments from a document, we will go through the following steps:
- Open a Word document using the Document class
- Get all comments from the document into a collection
- To extract comments:
- Go through the collection using the for the operator
- Extract and list the author name, date & time and text of all comments
- Extract and list the author name, date & time and text of comments written by a specific author, in this case, the author
ks
- To remove comments:
- Go backwards through the collection using the for the operator
- Remove comments
- Save the changes.
We are going to use the following Word document for this exercise:
As you can see, it contains several Comments from two authors with the initials “pm” and “ks”.
How to Extract All Comments
The getChildNodes method is very useful and you can use it every time you need to get a list of document nodes of any type. The resulting collection does not create an immediate overhead because the nodes are selected into this collection only when you enumerate or access items in it.
The following code example shows how to extract the author name, date&time and text of all comments in the document:
How to Extract Comments of a Specified Author
After you have selected Comment nodes into a collection, all you have to do is extract the information you need. In this sample, the author’s initials, date, time and the plain text of the comment is combined into one string; you could choose to store it in some other ways instead.
The overloaded method that extracts the Comments from a particular author is almost the same, it just checks the author’s name before adding the info into the array.
The following code example shows how to extract the author name, date&time and text of the comments by the specified author:
How to Remove Comments
If you are removing all comments, there is no need to move through the collection deleting comments one by one; you can remove them by calling clear on the comments collection.
The following code example shows how to remove all comments in the document:
When you need to selectively remove comments, the process becomes more similar to the code we used for comment extraction.
The following code example shows how to remove comments by the specified author:
The main point to highlight here is the use of the for operator. Unlike the simple extraction, here you want to delete a comment. A suitable trick is to iterate the collection backwards from the last Comment to the first one. The reason for this if you start from the end and move backwards, the index of the preceding items remains unchanged, and you can work your way back to the first item in the collection.
The following code example shows the methods for the comments extraction and removal:
When launched, the sample displays the following results. First, it lists all comments by all authors, then it lists comments by the selected author only. Finally, the code removing all comments.
The output Word document has now comments removed from it:
How to Remove Text between CommentRangeStart and CommentRangeEnd
Using Aspose.Words you can also remove comments between the CommentRangeStart and CommentRangeEnd nodes.
The following code example shows how to remove text between CommentRangeStart and CommentRangeEnd:
Add or Remove Comment’s Reply
The addReply method adds a reply to this comment. Please note that due to the existing MS Office limitations only one (1) level of replies is allowed in the document. An exception of type InvalidOperationException will be raised if this method is called on the existing Reply comment.
You can use the removeReply method to remove the specified reply to this comment.
The following code example shows how to add a reply to a comment and remove a comment’s reply:
Read Comment’s Reply
Aspose.Words support to read the reply of a Comment. The Replies property returns a collection of the Comment objects that are immediate children of the specified comment.
The following code example shows how to iterate through a comment’s replies and resolved them: