Articles in this section
Category / Section

How to find a text and add comments in Word document using C#?

4 mins read

Syncfusion® Essential® DocIO is a .NET Word Library used to create, read, edit, and convert Word documents programmatically without Microsoft Word or interop dependencies. Using this library, you can find a text and add comments in Word document using C#.

Steps to find a text and add comments in Word document using C#:

  1. Create a new C# .NET Console application project.
    Create a new C# .NET console application.
  2. Install the Syncfusion.DocIO.Net.Core NuGet package as a reference to your project from NuGet.org.
    Install Syncfusion.DocIO.Net.Core NuGet package

Starting with v16.2.0.x, if you reference Syncfusion® assemblies from trial setup or from the NuGet feed, include a license key in your projects. Refer to the link to learn about generating and registering a Syncfusion® license key in your application to use the components without trail message.

  1. Include the following namespaces in Program.cs file.
    C#
using Syncfusion.DocIO.DLS;
using Syncfusion.DocIO; 
  1. Use the following code snippet in Program.cs file, to find a text and add comments in Word document.
    C#
using (FileStream fileStream = new FileStream(Path.GetFullPath(@"../../../Data/Template.docx"), FileMode.Open, FileAccess.ReadWrite))
{
   //Open the existing Word document.
   using (WordDocument document = new WordDocument(fileStream, FormatType.Docx))
   {
       //Find all occurrence of a particular text ending with comma in the document using regex.
       TextSelection[] textSelection = document.FindAll(new Regex("\\w+,"));
       if (textSelection != null)
       {
           //Iterates through each occurrence and comment it.
           for (int i = 0; i < textSelection.Count(); i++)
           {
               //Get the found text as a single text range.
               WTextRange textRange = textSelection[i].GetAsOneRange();
               //Get the owner paragraph of the found text.
               WParagraph paragraph = textRange.OwnerParagraph;
               //Get the index of the found text.
               int textIndex = paragraph.ChildEntities.IndexOf(textRange);
               //Add comment to a paragraph.
               WComment comment = paragraph.AppendComment("comment test_" + i);
               //Specify the author of the comment.
               comment.Format.User = "Peter";
               //Specify the initial of the author.
               comment.Format.UserInitials = "St";
               //Set the date and time for the comment.
               comment.Format.DateTime = DateTime.Now;
               //Insert the comment next to the textrange.
               paragraph.ChildEntities.Insert(textIndex + 1, comment);
               //Add the paragraph items to the commented items.
               comment.AddCommentedItem(textRange);
           }
       }
       //Create the file stream.
       using (FileStream outputFileStream = new FileStream(Path.GetFullPath(@"../../../Result.docx"), FileMode.Create, FileAccess.ReadWrite))
       {
           //Save the Word document to the file stream.
           document.Save(outputFileStream, FormatType.Docx);
       }
   }
}

You can download a complete working sample to find a text and add comments in Word document from GitHub.

Take a moment to peruse the documentation where you can find basic Word document processing options along with the features like mail merge, merge, split, and compare documents, find and replace text in the Word document, protect the Word documents, and most importantly, the PDF and Image conversions with code examples.

Conclusion

I hope you enjoyed learning about how to find a text and add comments in Word document using C#.

You can refer to our ASP.NET Core DocIO feature tour page to know about its other groundbreaking feature representations and documentation, and how to quickly get started for configuration specifications. You can also explore our ASP.NET Core DocIO example to understand how to create and manipulate data.

For current customers, you can check out our components from the License and Downloads page. If you are new to Syncfusion®, you can try our 30-day free trial to check out our other controls.

If you have any queries or require clarifications, please let us know in the comments section below. You can also contact us through our support forum, Direct Trac, or feedback portal. We are always happy to assist you!

Did you find this information helpful?
Yes
No
Help us improve this page
Please provide feedback or comments
Comments (0)
Please  to leave a comment
Access denied
Access denied