Articles in this section

How to Find Nested Bookmarks in a Word Document in C# .NET Core?

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 nested bookmarks in a Word document using C#.

Overview of the find nested bookmarks Logic:

  • Open the Word document.
  • Iterate through the bookmark collection and created a ‘BookmarksNavigator’ for each bookmark.
  • Used the navigator to retrieve the bookmark content as a ‘WordDocument’.
  • Cleared the header and footer in the extracted document, then iterated through each bookmark in the extracted document and stored the nested bookmarks in a collection.
  • Printed the parent bookmark and its nested bookmarks.

Steps to find nested bookmarks in a Word document:

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

Starting with v16.2.0.x, if you reference Syncfusion® assemblies from a 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 a trial message.

  1. Include the following namespaces in the Program.cs file.
    C#
using Syncfusion.DocIO.DLS;
using Syncfusion.DocIO; 
  1. Use the following code example to find nested bookmarks in a Word document.
    C#
// Load the existing Word document.
WordDocument document = new WordDocument(Path.GetFullPath(@"Data/Template.docx"));
//Iterate through the bookmark collection
foreach (Bookmark bookmark in document.Bookmarks)
{
    // Create a collection to store nested bookmarks
    List<string> nestedBookmarks = new List<string>();
    // Create a BookmarksNavigator for the current bookmark
    BookmarksNavigator bookmarksNavigator = new BookmarksNavigator(document);
    {
        // Move navigator to the current bookmark
        bookmarksNavigator.MoveToBookmark(bookmark.Name);
        // Retrieve the bookmark content as a WordDocument
        using (WordDocument content = bookmarksNavigator.GetContent().GetAsWordDocument())
        {
            // Remove headers and footers from the extracted document
            RemoveHeaderFooter(content);
            // Iterate through bookmarks in the extracted document
            foreach (Bookmark bm in content.Bookmarks)
            {
                // Exclude the parent itself if names are identical
                if (!bm.Name.Equals(bookmark.Name))
                    nestedBookmarks.Add(bm.Name);
            }
        }
        // Print the parent bookmark and its nested bookmarks
        Console.WriteLine("Parent Bookmark: " + bookmark.Name);
        foreach (string name in nestedBookmarks)
            Console.WriteLine("Nested Bookmark: " + name);
        Console.WriteLine("************************");
    }
}
Console.ReadLine();
  1. Use the following helper method to remove headers and footers.
    C#
private static void RemoveHeaderFooter(WordDocument doc)
{
    //Iterate and Remove the Header / footer
    foreach (WSection section in doc.Sections)
    {
        // Remove the first page header and footer
        section.HeadersFooters.FirstPageHeader.ChildEntities.Clear();
        section.HeadersFooters.FirstPageHeader.AddParagraph();
        section.HeadersFooters.FirstPageFooter.ChildEntities.Clear();
        section.HeadersFooters.FirstPageFooter.AddParagraph();

        // Remove the odd page header and footer
        section.HeadersFooters.OddHeader.ChildEntities.Clear();
        section.HeadersFooters.OddHeader.AddParagraph();
        section.HeadersFooters.OddFooter.ChildEntities.Clear();
        section.HeadersFooters.OddFooter.AddParagraph();

        // Remove the even page header and footer
        section.HeadersFooters.EvenHeader.ChildEntities.Clear();
        section.HeadersFooters.EvenHeader.AddParagraph();
        section.HeadersFooters.EvenFooter.ChildEntities.Clear();
        section.HeadersFooters.EvenFooter.AddParagraph();
    }
}

You can download a complete working sample to find nested bookmarks in a Word document from GitHub.

Input Document:

Input Word Document

Output Window:

Output Window

Take a moment to peruse the documentation where you can find basic Word document processing options along with 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 nested bookmarks in a Word document in a .NET Core Word document.

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 with 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!

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