Articles in this section
Category / Section

How to create table of figures if captions exist in Word document?

5 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 create a table of figures if captions exist in a Word document using C#.

By using the FindAllItemsByProperty API, find all SEQ fields in the Word document with the given caption name.

Steps to create a table of figures if captions exist in a Word document in C#:

  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

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 a trial message.

  1. Include the following namespaces in the Program.cs file.
    C#
using Syncfusion.DocIO;
using Syncfusion.DocIO.DLS;
using Syncfusion.DocIORenderer; 
  1. Use the following code snippet in the Program.cs file to create a table of figures if captions exist in a Word document.
    C#
// Open the existing Word document from file stream.
using (FileStream docStream = new FileStream(Path.GetFullPath(@"Data/InputDocument.docx"), FileMode.Open, FileAccess.Read))
{
    // Load the Word document.
    using (WordDocument document = new WordDocument(docStream, FormatType.Docx))
    {
        // Define the target caption name.
        string targetCaption = "Figure";         
        // Find all SEQ fields in the document with the given caption name
        List<Entity> seqField = document.FindAllItemsByProperty(EntityType.SeqField, "CaptionName", targetCaption);
        // Check if any SEQ fields with the target caption exist
        if (seqField.Count > 0)
        {
            // Create a new paragraph for the "List of Figures" title
            WParagraph paragraph = new WParagraph(document);
            paragraph.AppendText("List of Figures");
            // Apply Heading1 style to the paragraph
            paragraph.ApplyStyle(BuiltinStyle.Heading1);
            // Insert the paragraph at the beginning of the document
            document.LastSection.Body.ChildEntities.Insert(0, paragraph);
            // Create a new paragraph for the Table of Contents (TOC)
            paragraph = new WParagraph(document);
            // Append the TOC for figures (based on SEQ fields)
            TableOfContent tableOfContent = paragraph.AppendTOC(1, 3);
            // Exclude heading style paragraphs from TOC entries
            tableOfContent.UseHeadingStyles = false;
            // Set the SEQ field identifier for the table of figures (targeting "Figure")
            tableOfContent.TableOfFiguresLabel = "Figure";
            // Exclude caption labels and numbers in TOC entries
            tableOfContent.IncludeCaptionLabelsAndNumbers = false;
            // Insert the TOC paragraph into the document
            document.LastSection.Body.ChildEntities.Insert(1, paragraph);
        }
        // Update the Table of Contents to reflect any changes
        document.UpdateTableOfContents();
        // Save the modified document to a new file
        using (FileStream docStream1 = new FileStream(Path.GetFullPath(@"Output/Result.docx"), FileMode.Create, FileAccess.Write))
        {
            document.Save(docStream1, FormatType.Docx);
        }
    }
}

You can download a complete working sample to create a table of figures if captions exist in a Word document in C# from GitHub.

Input Word document as follows:

sshot-1i.png

By executing the program, you will get the table of figures if captions exist in a Word document as shown below:

sshot-2r.png

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 create a table of figures if captions exist 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)
Please  to leave a comment
Access denied
Access denied