How to find text and add bookmark to get content in ASP.NET Core Word?

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 text and add bookmarks in Word document using C#.

You can achieve the requirement by following these steps:

1. Open the template Word document.
2. Add a bookmark to the searched text.
3. Find all bookmarks in the Word document using the FindAllItemsByProperty API.
4. Iterate through the bookmarks and get the content from each bookmark.

Steps to find text and add bookmarks in Word document:

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

3. Include the following namespaces in Program.cs file
   C#

using Syncfusion.DocIO.DLS;
using Syncfusion.DocIO; 

4. Use the following code example to find text and add bookmarks in Word document.
   C#

using (FileStream fileStream = new FileStream(Path.GetFullPath(@"Data/Template.docx"), FileMode.Open, FileAccess.ReadWrite))
{
   using (WordDocument document = new WordDocument(fileStream, FormatType.Automatic))
   {
       // Define texts and corresponding bookmark names
       var textBookmarkPairs = new Dictionary<string, string>
   {
       { "they are considered one of the world's most loved animals.", "bkmk1" },
       { "The table below lists the main characteristics the giant panda shares with bears and red pandas.", "bkmk2" },
       { "Did you know that the giant panda may actually be a raccoon", "bkmk3" }
   };
       // Add bookmarks to specified texts
       foreach (var pair in textBookmarkPairs)
       {
           AddBookmarkToText(document, pair.Key, pair.Value);
       }
       // Retrieve and display bookmark contents
       List<string> bookmarksContent = GetBookmarkContents(document);
       foreach (var content in bookmarksContent)
       {
           Console.WriteLine("Bookmark content: ");
           Console.WriteLine(content);
       }
       // Save the modified document
       using (FileStream outputStream = new FileStream(Path.GetFullPath(@"Output/Result.docx"), FileMode.Create, FileAccess.ReadWrite))
       {
           document.Save(outputStream, FormatType.Docx);
       }
   }
}

5. Use the following code example to adds a bookmark to a specific text in the document.
   C#

private static void AddBookmarkToText(WordDocument document, string searchText, string bookmarkName)
{
   TextSelection textSelection = document.Find(searchText, false, true);
   if (textSelection != null)
   {
       WTextRange textRange = textSelection.GetAsOneRange();
       int indexOfText = textRange.OwnerParagraph.Items.IndexOf(textRange);
       textRange.OwnerParagraph.Items.Insert(indexOfText, new BookmarkStart(document, bookmarkName));
       textRange.OwnerParagraph.Items.Insert(indexOfText + 2, new BookmarkEnd(document, bookmarkName));
   }
} 

6. Use the following code example to retrieves all bookmark contents from the document.
   C#

private static List<string> GetBookmarkContents(WordDocument document)
{
   List<string> bookmarkContents = new List<string>();
   foreach (Entity entity in document.FindAllItemsByProperty(EntityType.BookmarkStart, null, null))
   {
       if (entity is BookmarkStart bookmarkStart)
       {
           var bookmarkNavigator = new BookmarksNavigator(document);
           bookmarkNavigator.MoveToBookmark(bookmarkStart.Name);
           WordDocumentPart part = bookmarkNavigator.GetContent();
           WordDocument tempDoc = part.GetAsWordDocument();
           bookmarkContents.Add(tempDoc.GetText());
           tempDoc.Close();
           tempDoc.Dispose();
           part.Close();
       }
   }
   return bookmarkContents;
} 

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

Template Word document

Generated result document with bookmark

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 Word 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 text and add bookmark to get content in ASP.NET Core Word.

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 forums, Direct-Trac, or feedback portal. We are always happy to assist you!