Working with Table Of Contents

26 Jun 202424 minutes to read

Table of contents (TOC) is used to provide an outline of the Word document. By default table of contents will be created automatically from heading styles.

You can add the TOC into the paragraph by specifying the LowerHeadingLevel and UpperHeadingLevel. The heading level range must be from 1 to 9.

Basically TOC determines the TOC entries based on the TOC switches.

Switches in TOC

S.No	Switches	Description
1	\o	Builds a table of contents from paragraphs formatted with built-in heading styles.
2	\h	Inserts TOC entries as hyperlinks.
3	\n	Omits page numbers from the table of contents.
4	\p	Specifies the characters that separate a TOC entry and its page number. The default is a tab with leader dots.
5	\t	Builds a table of contents from paragraphs formatted with specified styles other than the built-in heading styles
6	\c	Builds a table of figures of the given label.
7	\a	Builds a table of figures but does not include the caption's label and number.

To quickly start create and update a table of contents in Word document, please check out this video:

Adding a TOC field

The following code example shows how to add a table of contents (TOC) in Word document.

C# [Cross-platform]

//Creates a new Word document
WordDocument document = new WordDocument();
//Adds the section into the Word document
IWSection section = document.AddSection();
string paraText = "AdventureWorks Cycles, the fictitious company on which the AdventureWorks sample databases are based, is a large, multinational manufacturing company.";
//Adds the paragraph into the created section
IWParagraph paragraph = section.AddParagraph();
//Appends the TOC field with LowerHeadingLevel and UpperHeadingLevel to determines the TOC entries
paragraph.AppendTOC(1, 3);
//Adds the section into the Word document
section = document.AddSection();
//Adds the paragraph into the created section
paragraph = section.AddParagraph();
//Adds the text for the headings
paragraph.AppendText("First Chapter");
//Sets a built-in heading style.
paragraph.ApplyStyle(BuiltinStyle.Heading1);
//Adds the text into the paragraph
section.AddParagraph().AppendText(paraText);
//Adds the section into the Word document
section = document.AddSection();
//Adds the paragraph into the created section
paragraph = section.AddParagraph();
//Adds the text for the headings
paragraph.AppendText("Second Chapter");
//Sets a built-in heading style.
paragraph.ApplyStyle(BuiltinStyle.Heading2);
//Adds the text into the paragraph
section.AddParagraph().AppendText(paraText);
//Adds the section into the Word document
section = document.AddSection();
//Adds the paragraph into the created section
paragraph = section.AddParagraph();
//Adds the text into the headings
paragraph.AppendText("Third Chapter");
//Sets a built-in heading style
paragraph.ApplyStyle(BuiltinStyle.Heading3);
//Adds the text into the paragraph.
section.AddParagraph().AppendText(paraText);
//Updates the table of contents
document.UpdateTableOfContents();
//Saves the Word document to MemoryStream
MemoryStream stream = new MemoryStream();
document.Save(stream, FormatType.Docx);
//Closes the document
document.Close();

C# [Windows-specific]

//Creates a new Word document
WordDocument document = new WordDocument();
//Adds the section into the Word document
IWSection section = document.AddSection();
string paraText = "AdventureWorks Cycles, the fictitious company on which the AdventureWorks sample databases are based, is a large, multinational manufacturing company.";
//Adds the paragraph into the created section
IWParagraph paragraph = section.AddParagraph();
//Appends the TOC field with LowerHeadingLevel and UpperHeadingLevel to determines the TOC entries
paragraph.AppendTOC(1, 3);
//Adds the section into the Word document
section = document.AddSection();
//Adds the paragraph into the created section
paragraph = section.AddParagraph(); 
//Adds the text for the headings
paragraph.AppendText("First Chapter");
//Sets a built-in heading style.
paragraph.ApplyStyle(BuiltinStyle.Heading1);
//Adds the text into the paragraph
section.AddParagraph().AppendText(paraText);
//Adds the section into the Word document
section = document.AddSection();
//Adds the paragraph into the created section
paragraph = section.AddParagraph();
//Adds the text for the headings
paragraph.AppendText("Second Chapter");
//Sets a built-in heading style.
paragraph.ApplyStyle(BuiltinStyle.Heading2);
//Adds the text into the paragraph
section.AddParagraph().AppendText(paraText);
//Adds the section into the Word document
section = document.AddSection();
//Adds the paragraph into the created section
paragraph = section.AddParagraph();
//Adds the text into the headings
paragraph.AppendText("Third Chapter");
//Sets a built-in heading style
paragraph.ApplyStyle(BuiltinStyle.Heading3);
//Adds the text into the paragraph.
section.AddParagraph().AppendText(paraText);
//Updates the table of contents
document.UpdateTableOfContents();
//Saves and closes the Word document instance
document.Save("Sample.docx", FormatType.Docx);
document.Close();

VB.NET [Windows-specific]

'Creates a new Word document
Dim document As New WordDocument()
'Adds the section into the Word document
Dim section As IWSection = document.AddSection()
Dim paraText As String = "AdventureWorks Cycles, the fictitious company on which the AdventureWorks sample databases are based, is a large, multinational manufacturing company."
'Adds the paragraph into the created section
Dim paragraph As IWParagraph = section.AddParagraph()
'Appends the TOC field with LowerHeadingLevel and UpperHeadingLevel to determines the TOC entries
paragraph.AppendTOC(1, 3)
'Adds the section into the Word document
section = document.AddSection()
'Adds the paragraph into the created section
paragraph = section.AddParagraph()
'Adds the text for the headings
paragraph.AppendText("First Chapter")
'Sets a built-in heading style
paragraph.ApplyStyle(BuiltinStyle.Heading1)
'Adds the text into the paragraph.
section.AddParagraph().AppendText(paraText)
'Adds the section into the Word document
section = document.AddSection()
'Adds the paragraph into the created section
paragraph = section.AddParagraph()
'Adds the text for the headings
paragraph.AppendText("Second Chapter")
'Sets a built-in heading style
paragraph.ApplyStyle(BuiltinStyle.Heading2)
'Adds the text into the paragraph
section.AddParagraph().AppendText(paraText)
'Adds the section into the Word document
section = document.AddSection()
'Adds the paragraph into the created section
paragraph = section.AddParagraph()
'Adds the text into the headings
paragraph.AppendText("Third Chapter")
'Sets a built-in heading style
paragraph.ApplyStyle(BuiltinStyle.Heading3)
'Adds the text into the paragraph
section.AddParagraph().AppendText(paraText)
'Updates the table of contents
document.UpdateTableOfContents()
‘Saves and closes the Word document instance
document.Save("Sample.docx", FormatType.Docx)
document.Close()

UWP

//DocIO supports Table of contents in WPF, Windows Forms platforms alone

You can download a complete working sample from GitHub.

Updating table of contents

You can also update or re-build the TOC in an existing document or document created from the scratch.

NOTE

1. Updating of TOC is not supported in Silverlight, WinRT, Universal and Windows Phone applications.
2. Updating TOC makes use of the Word to PDF layout engine that may lead to update incorrect page number due to its limitations.
3. In ASP.NET Core, Blazor, and Xamarin platforms, to update TOC in a Word document we recommend you to use Word to PDF assemblies or NuGet as a reference in your application.

The following code example shows how to update a TOC in an existing word document.

C# [Cross-platform]

//Opens an existing document from stream through constructor of WordDocument class
FileStream fileStreamPath = new FileStream("Template.docx", FileMode.Open, FileAccess.Read, FileShare.ReadWrite);
WordDocument document = new WordDocument(fileStreamPath, FormatType.Automatic);
//Updates the table of contents.
document.UpdateTableOfContents();
//Saves the Word document to MemoryStream
MemoryStream stream = new MemoryStream();
document.Save(stream, FormatType.Docx);
//Closes the document
document.Close();

C# [Windows-specific]

//Opens an input word template
WordDocument document = new WordDocument(@”Template.docx”);
//Updates the table of contents.
document.UpdateTableOfContents();
//Saves and closes the Word document instance.
document.Save("Sample.docx", FormatType.Docx);
document.Close();

VB.NET [Windows-specific]

'Opens an input word template
Dim document As New WordDocument("Template.docx")
'Updates the table of contents.
document.UpdateTableOfContents()
‘Saves and closes the Word document instance.
document.Save("Sample.docx", FormatType.Docx)
document.Close()

UWP

//DocIO supports Table of contents in WPF, Windows Forms platforms alone

//Please download the helper files from the below link to save the stream as file and open the file for viewing in Xamarin platform
//https://help.syncfusion.com/document-processing/word/word-library/net/create-word-document-in-xamarin#helper-files-for-xamarin

You can download a complete working sample from GitHub.

Creating table of contents with user-defined styles

The following code example shows how to create table of contents with user-defined styles instead of heading styles.

C# [Cross-platform]

//Creates a new Word document
WordDocument document = new WordDocument();
//Creates a new custom styles
Style style = (WParagraphStyle)document.AddParagraphStyle("MyStyle");
style.CharacterFormat.Bold = true;
style.CharacterFormat.FontName = "Verdana";
style.CharacterFormat.FontSize = 25;
//Adds the section into the Word document
IWSection section = document.AddSection();
string paraText = "AdventureWorks Cycles, the fictitious company on which the AdventureWorks sample databases are based, is a large, multinational manufacturing company.";
//Adds the paragraph into the created section
IWParagraph paragraph = section.AddParagraph();
//Appends the TOC field with LowerHeadingLevel and UpperHeadingLevel to determines the TOC entries
TableOfContent tableOfContents = paragraph.AppendTOC(1, 3);
tableOfContents.UseHeadingStyles = false;
//Sets the TOC level style based on the created TOC 
tableOfContents.SetTOCLevelStyle(2, "MyStyle");
//Adds the section into the Word document
section = document.AddSection();
//Adds the paragraph into the created section
paragraph = section.AddParagraph();
//Adds the text for the headings
paragraph.AppendText("First Chapter");
//Sets the built-in heading style
paragraph.ApplyStyle("MyStyle");
//Adds the text into the paragraph
section.AddParagraph().AppendText(paraText);
//Adds the section into the Word document
section = document.AddSection();
//Adds the paragraph into the created section
paragraph = section.AddParagraph();
//Adds the text for the headings
paragraph.AppendText("Second Chapter");
//Sets the built-in heading style
paragraph.ApplyStyle(BuiltinStyle.Heading1);
//Adds the text to the paragraph
section.AddParagraph().AppendText(paraText);
//Adds the section into Word document
section = document.AddSection();
//Adds a paragraph to a created section
paragraph = section.AddParagraph();
//Adds the text for the headings
paragraph.AppendText("Third Chapter");
//Sets the built-in heading style
paragraph.ApplyStyle("MyStyle");
//Adds the text to the paragraph
section.AddParagraph().AppendText(paraText);
//Updates the table of contents
document.UpdateTableOfContents();
//Saves the Word document to MemoryStream
MemoryStream stream = new MemoryStream();
document.Save(stream, FormatType.Docx);
//Closes the document
document.Close();

C# [Windows-specific]

//Creates a new Word document
WordDocument document = new WordDocument();
//Creates a new custom styles
Style style = (WParagraphStyle)document.AddParagraphStyle("MyStyle");
style.CharacterFormat.Bold = true;
style.CharacterFormat.FontName = "Verdana";
style.CharacterFormat.FontSize = 25;
//Adds the section into the Word document
IWSection section = document.AddSection();
string paraText = "AdventureWorks Cycles, the fictitious company on which the AdventureWorks sample databases are based, is a large, multinational manufacturing company.";
//Adds the paragraph into the created section
IWParagraph paragraph = section.AddParagraph();
//Appends the TOC field with LowerHeadingLevel and UpperHeadingLevel to determines the TOC entries
TableOfContent tableOfContents = paragraph.AppendTOC(1, 3);
tableOfContents.UseHeadingStyles = false;
//Sets the TOC level style based on the created TOC 
tableOfContents.SetTOCLevelStyle(2, "MyStyle");
//Adds the section into the Word document
section = document.AddSection();
//Adds the paragraph into the created section
paragraph = section.AddParagraph();
//Adds the text for the headings
paragraph.AppendText("First Chapter");
//Sets the built-in heading style
paragraph.ApplyStyle("MyStyle");
//Adds the text into the paragraph
section.AddParagraph().AppendText(paraText);
//Adds the section into the Word document
section = document.AddSection();
//Adds the paragraph into the created section
paragraph = section.AddParagraph();
//Adds the text for the headings
paragraph.AppendText("Second Chapter");
//Sets the built-in heading style
paragraph.ApplyStyle(BuiltinStyle.Heading1);
//Adds the text to the paragraph
section.AddParagraph().AppendText(paraText);
//Adds the section into Word document
section = document.AddSection();
//Adds a paragraph to a created section
paragraph = section.AddParagraph();
//Adds the text for the headings
paragraph.AppendText("Third Chapter");
//Sets the built-in heading style
paragraph.ApplyStyle("MyStyle");
//Adds the text to the paragraph
section.AddParagraph().AppendText(paraText);
//Updates the table of contents
document.UpdateTableOfContents();
//Saves and closes the Word document instance
document.Save("Sample.docx", FormatType.Docx);
document.Close();

VB.NET [Windows-specific]

'Creates a new Word document
Dim document As New WordDocument()
'Creates a new custom styles
Dim style As Style = DirectCast(document.AddParagraphStyle("MyStyle"), WParagraphStyle)
style.CharacterFormat.Bold = True
style.CharacterFormat.FontName = "Verdana"
style.CharacterFormat.FontSize = 25
'Adds the section into the Word document
Dim section As IWSection = document.AddSection()
Dim paraText As String = "AdventureWorks Cycles, the fictitious company on which the AdventureWorks sample databases are based, is a large, multinational manufacturing company."
'Adds the paragraph into the created section
Dim paragraph As IWParagraph = section.AddParagraph()
'Appends the TOC field with LowerHeadingLevel and UpperHeadingLevel to determine the TOC entries
Dim tableOfContents As TableOfContent = paragraph.AppendTOC(1, 3)
tableOfContents.UseHeadingStyles = False
'Sets the TOC level style based on the created TOC 
tableOfContents.SetTOCLevelStyle(2, "MyStyle")
'Adds the section into the Word document
section = document.AddSection()
'Adds the paragraph into the created section
paragraph = section.AddParagraph()
'Adds the text for the headings
paragraph.AppendText("First Chapter")
'Sets the built-in heading style
paragraph.ApplyStyle("MyStyle")
'Adds the text into the paragraph
section.AddParagraph().AppendText(paraText)
'Adds the section into the Word document
section = document.AddSection()
'Adds the paragraph into the created section
paragraph = section.AddParagraph()
'Adds the text for the headings
paragraph.AppendText("Second Chapter")
'Sets the built-in heading style
paragraph.ApplyStyle(BuiltinStyle.Heading1)
'Adds the text to the paragraph
section.AddParagraph().AppendText(paraText)
'Adds the section into Word document
section = document.AddSection()
'Adds a paragraph to created section
paragraph = section.AddParagraph()
'Adds the text for the headings
paragraph.AppendText("Third Chapter")
'Sets the built-in heading style
paragraph.ApplyStyle("My style")
'Adds the text to the paragraph
section.AddParagraph().AppendText(paraText)
'Updates the table of contents
document.UpdateTableOfContents()
‘Saves and closes the Word document instance
document.Save("Sample.docx", FormatType.Docx)
document.Close()

UWP

//DocIO supports Table of contents in WPF, Windows Forms platforms alone

You can download a complete working sample from GitHub.

Apply switches for table of contents

You can modify the preservation of TOC entries in a Word document by applying switches to the table of contents, and you can also apply switches to preserve TOC entries as hyperlinks or not, use the default heading styles, preserve page numbers or not, align the page numbers, preserve new line characters, preserve outline level paragraphs, and preserve table of entry fields in the TOC entries using Word (DocIO) library.

The following code example illustrates how to apply switches for the table of contents.

C# [Cross-platform]

//Create a new Word document.
using (WordDocument document = new WordDocument())
{
    //Add a section to the Word document.
    IWSection section = document.AddSection();
    //Add a paragraph to the created section.
    IWParagraph paragraph = section.AddParagraph();
    //Append the TOC field with LowerHeadingLevel and UpperHeadingLevel to determine the TOC entries.
    TableOfContent tableOfContent = paragraph.AppendTOC(1, 3);
    //Set lower heading level for TOC.
    tableOfContent.LowerHeadingLevel = 2;
    //Set upper heading level for TOC.
    tableOfContent.UpperHeadingLevel = 5;
    //Enable a flag to use default heading styles in TOC entries.
    tableOfContent.UseHeadingStyles = true;
    //Enable a flag to show page numbers in TOC entries.
    tableOfContent.IncludePageNumbers = true;
    //Disable a flag to align page numbers after the TOC entries.
    tableOfContent.RightAlignPageNumbers = false;
    //Disable a flag to preserve TOC entries without hyperlinks.
    tableOfContent.UseHyperlinks = false;
    //Add a paragraph to the section.
    paragraph = section.AddParagraph();
    //Append text.
    paragraph.AppendText("First ");
    //Append line break.
    paragraph.AppendBreak(BreakType.LineBreak);
    paragraph.AppendText("Chapter");
    //Enable a flag to include newline characters in TOC entries.
    tableOfContent.IncludeNewLineCharacters = true;
    //Set a built-in heading style.
    paragraph.ApplyStyle(BuiltinStyle.Heading2);
    //Add a section to the Word document.
    section = document.AddSection();
    //Add a paragraph to the section.
    paragraph = section.AddParagraph();
    //Append text.
    paragraph.AppendText("Second ");
    paragraph.AppendText("Chapter");
    //Set a built-in heading style.
    paragraph.ApplyStyle(BuiltinStyle.Heading1);
    //Add a section to the Word document.
    section = document.AddSection();
    paragraph = section.AddParagraph();
    paragraph.AppendText("Third ");
    paragraph.AppendText("Chapter");
    //Set a built-in heading style.
    paragraph.ApplyStyle(BuiltinStyle.Heading2);
    section = document.AddSection();
    paragraph = section.AddParagraph();
    paragraph.AppendText("Fourth ");
    paragraph.AppendText("Chapter");
    //Set a built-in heading style.
    paragraph.ApplyStyle(BuiltinStyle.Heading3);
    //Add the text to the new paragraph of the section.
    section.AddParagraph().AppendText("AdventureWorks Cycles, the fictitious company on which the AdventureWorks sample databases are based, is a large, multinational manufacturing company.");
    //Add a paragraph to the section.
    paragraph = section.AddParagraph();
    //Set outline level for paragraph.
    paragraph.ParagraphFormat.OutlineLevel = OutlineLevel.Level2;
    //Append text.
    paragraph.AppendText("Outline Level Paragraph");
    //Enable a flag to consider outline level paragraphs in TOC entries.
    tableOfContent.UseOutlineLevels = true;
    //Add a section to the Word document.
    section = document.AddSection();
    //Add a paragraph to the section.
    paragraph = section.AddParagraph();
    //Append a field to the paragraph.
    paragraph.AppendField("Table of Entry Field", FieldType.FieldTOCEntry);
    //Enable a flag to use table entry fields in TOC entries.
    tableOfContent.UseTableEntryFields = true;
    //Update the table of contents.
    document.UpdateTableOfContents();
    //Saves the Word document to MemoryStream
    MemoryStream stream = new MemoryStream();
    document.Save(stream, FormatType.Docx);
    //Closes the document
    document.Close();
}

C# [Windows-specific]

//Create a new Word document.
using (WordDocument document = new WordDocument())
{
    //Add a section to the Word document.
    IWSection section = document.AddSection();
    //Add a paragraph to the created section.
    IWParagraph paragraph = section.AddParagraph();
    //Append the TOC field with LowerHeadingLevel and UpperHeadingLevel to determine the TOC entries.
    TableOfContent tableOfContent = paragraph.AppendTOC(1, 3);
    //Set lower heading level for TOC.
    tableOfContent.LowerHeadingLevel = 2;
    //Set upper heading level for TOC.
    tableOfContent.UpperHeadingLevel = 5;
    //Enable a flag to use default heading styles in TOC entries.
    tableOfContent.UseHeadingStyles = true;
    //Enable a flag to show page numbers in TOC entries.
    tableOfContent.IncludePageNumbers = true;
    //Disable a flag to align page numbers after the TOC entries.
    tableOfContent.RightAlignPageNumbers = false;
    //Disable a flag to preserve TOC entries without hyperlinks.
    tableOfContent.UseHyperlinks = false;
    //Add a paragraph to the section.
    paragraph = section.AddParagraph();
    //Append text.
    paragraph.AppendText("First ");
    //Append line break.
    paragraph.AppendBreak(BreakType.LineBreak);
    paragraph.AppendText("Chapter");
    //Enable a flag to include newline characters in TOC entries.
    tableOfContent.IncludeNewLineCharacters = true;
    //Set a built-in heading style.
    paragraph.ApplyStyle(BuiltinStyle.Heading2);
    //Add a section to the Word document.
    section = document.AddSection();
    //Add a paragraph to the section.
    paragraph = section.AddParagraph();
    //Append text.
    paragraph.AppendText("Second ");
    paragraph.AppendText("Chapter");
    //Set a built-in heading style.
    paragraph.ApplyStyle(BuiltinStyle.Heading1);
    //Add a section to the Word document.
    section = document.AddSection();
    paragraph = section.AddParagraph();
    paragraph.AppendText("Third ");
    paragraph.AppendText("Chapter");
    //Set a built-in heading style.
    paragraph.ApplyStyle(BuiltinStyle.Heading2);
    section = document.AddSection();
    paragraph = section.AddParagraph();
    paragraph.AppendText("Fourth ");
    paragraph.AppendText("Chapter");
    //Set a built-in heading style.
    paragraph.ApplyStyle(BuiltinStyle.Heading3);
    //Add the text to the new paragraph of the section.
    section.AddParagraph().AppendText("AdventureWorks Cycles, the fictitious company on which the AdventureWorks sample databases are based, is a large, multinational manufacturing company.");
    //Add a paragraph to the section.
    paragraph = section.AddParagraph();
    //Set outline level for paragraph.
    paragraph.ParagraphFormat.OutlineLevel = OutlineLevel.Level2;
    //Append text.
    paragraph.AppendText("Outline Level Paragraph");
    //Enable a flag to consider outline level paragraphs in TOC entries.
    tableOfContent.UseOutlineLevels = true;
    //Add a section to the Word document.
    section = document.AddSection();
    //Add a paragraph to the section.
    paragraph = section.AddParagraph();
    //Append a field to the paragraph.
    paragraph.AppendField("Table of Entry Field", FieldType.FieldTOCEntry);
    //Enable a flag to use table entry fields in TOC entries.
    tableOfContent.UseTableEntryFields = true;
    //Update the table of contents.
    document.UpdateTableOfContents();
    //Save a Word document.
    document.Save("Sample.docx");
}

VB.NET [Windows-specific]

'Create a new Word document.
Using document As WordDocument = New WordDocument()
    'Add a section into the Word document.
    Dim section As IWSection = document.AddSection()
    'Add a paragraph into the created section.
    Dim paragraph As IWParagraph = section.AddParagraph()
    'Append the TOC field with LowerHeadingLevel and UpperHeadingLevel to determines the TOC entries.
    Dim tableOfContent As TableOfContent = paragraph.AppendTOC(1, 3)
    'Set lower heading level for TOC.
    tableOfContent.LowerHeadingLevel = 2
    'Set upper heading level for TOC.
    tableOfContent.UpperHeadingLevel = 5
    'Enable a flag to use default heading styles in TOC entries.
    tableOfContent.UseHeadingStyles = True
    'Enable a flag to show page numbers in TOC entries.
    tableOfContent.IncludePageNumbers = True
    'Disable a flag to align page numbers after to the TOC entries.
    tableOfContent.RightAlignPageNumbers = False
    'Disable a flag to preserve TOC entries without hyperlinks.
    tableOfContent.UseHyperlinks = False
    'Add a paragraph into the section.
    paragraph = section.AddParagraph()
    'Append text.
    paragraph.AppendText("First ")
    'Append line break.
    paragraph.AppendBreak(BreakType.LineBreak)
    paragraph.AppendText("Chapter")
    'Enable a flag to include new line characters in TOC entries.
    tableOfContent.IncludeNewLineCharacters = True
    'Set a built-in heading style.
    paragraph.ApplyStyle(BuiltinStyle.Heading2)
    'Add a section into the Word document.
    section = document.AddSection()
    'Add a paragraph to the section.
    paragraph = section.AddParagraph()
    'Append text.
    paragraph.AppendText("Second ")
    paragraph.AppendText("Chapter")
    'Sets a built-in heading style.
    paragraph.ApplyStyle(BuiltinStyle.Heading1)
    'Add a section into the Word document.
    section = document.AddSection()
    paragraph = section.AddParagraph()
    paragraph.AppendText("Third ")
    paragraph.AppendText("Chapter")
    'Set a built-in heading style.
    paragraph.ApplyStyle(BuiltinStyle.Heading2)
    section = document.AddSection()
    paragraph = section.AddParagraph()
    paragraph.AppendText("Fourth ")
    paragraph.AppendText("Chapter")
    'Set a built-in heading style.
    paragraph.ApplyStyle(BuiltinStyle.Heading3)
    'Add the text into the new paragraph of the section.
    section.AddParagraph().AppendText("AdventureWorks Cycles, the fictitious company on which the AdventureWorks sample databases are based, is a large, multinational manufacturing company.")
    'Add a paragraph to the section.
    paragraph = section.AddParagraph()
    'Set outline level for paragraph.
    paragraph.ParagraphFormat.OutlineLevel = OutlineLevel.Level2
    'Append text.
    paragraph.AppendText("Outline Level Paragraph")
    'Enable a flag to consider outline level paragraphs in TOC entries.
    tableOfContent.UseOutlineLevels = True
    'Add a section into the Word document.
    section = document.AddSection()
    'Add a paragraph to the section.
    paragraph = section.AddParagraph()
    'Append a field to the paragraph.
    paragraph.AppendField("Table of Entry Field", FieldType.FieldTOCEntry)
    'Enable a flag to use table entry fields in TOC entries.
    tableOfContent.UseTableEntryFields = True
    'Update the table of content.
    document.UpdateTableOfContents()
    'Save a Word document.
    document.Save("Sample.docx")
End Using

UWP

//DocIO doesn't support updating table of contents in UWP platform.

Removing table of contents

The following code example shows how to remove table of contents (TOC) in Word document.

C# [Cross-platform]

using (WordDocument document = new WordDocument())
{
    //Opens the Word template document.
    FileStream docStream = new FileStream("Template.docx", FileMode.Open, FileAccess.Read, FileShare.ReadWrite);
    document.Open(docStream, FormatType.Docx);
    docStream.Dispose();
    //Removes the TOC field.
    TableOfContent toc = document.Sections[0].Body.Paragraphs[2].Items[0] as TableOfContent;
    RemoveTableOfContents(toc);
    //Saves the file in the given path
    MemoryStream stream = new MemoryStream();
    document.Save(stream, FormatType.Docx);
    docStream.Dispose();
    //Closes the document
    document.Close();
}

C# [Windows-specific]

using (WordDocument document = new WordDocument())
{
    //Opens the Word template document.
    document.Open("Template.docx", FormatType.Docx);
    //Removes the TOC field.
    TableOfContent toc = document.Sections[0].Body.Paragraphs[2].Items[0] as TableOfContent;
    RemoveTableOfContents(toc);
    //Saves the file in the given path
    document.Save("Sample.docx", FormatType.Docx);
}

VB.NET [Windows-specific]

Using document As WordDocument = New WordDocument
    document.Open("Template.docx", FormatType.Docx)
    Dim toc As TableOfContent = CType(document.Sections(0).Body.Paragraphs(2).Items(0), TableOfContent)
    RemoveTableOfContents(toc)
    'Saves the file in the given path
    document.Save("Sample.docx", FormatType.Docx)
End Using

UWP

//DocIO does not support a table of contents directly in the UWP platform. You can achieve this by using the Syncfusion.DocIORenderer.Net.Core NuGet package in UWP.

The helper methods helps for removing table of contents (TOC) in Word document.

C# [Cross-platform]

// Removes the table of contents from Word document.
static void RemoveTableOfContents(TableOfContent toc)
{
    //Finds the last TOC item.
    Entity lastItem = FindLastTOCItem(toc);

    //TOC field end mark wasn't exist.
    if (lastItem == null)
        return;

    //Inserts the bookmark start before the TOC instance.
    BookmarkStart bkmkStart = new BookmarkStart(toc.Document, "tableOfContent");
    toc.OwnerParagraph.Items.Insert(toc.OwnerParagraph.Items.IndexOf(toc), bkmkStart);

    //Inserts the bookmark end to next of TOC last item.
    BookmarkEnd bkmkEnd = new BookmarkEnd(toc.Document, "tableOfContent");
    WParagraph paragraph = lastItem.Owner as WParagraph;
    paragraph.Items.Insert(paragraph.Items.IndexOf(lastItem) + 1, bkmkEnd);

    //Delete all the items from bookmark start to end (TOC items) using Bookmark Navigator.
    DeleteBookmarkContents(bkmkEnd.Name, toc.Document);
}
// Finds the last TOC item.
static Entity FindLastTOCItem(TableOfContent toc)
{
    int tocIndex = toc.OwnerParagraph.Items.IndexOf(toc);
    //TOC may contains nested fields and each fields has its owner field end mark 
    //so to identify the TOC Field end mark (WFieldMark instance) used the stack.
    Stack<Entity> fieldStack = new Stack<Entity>();
    fieldStack.Push(toc);

    //Finds whether TOC end item is exist in same paragraph.
    for (int i = tocIndex + 1; i < toc.OwnerParagraph.Items.Count; i++)
    {
        Entity item = toc.OwnerParagraph.Items[i];

        if (item is WField)
            fieldStack.Push(item);
        else if (item is WFieldMark && (item as WFieldMark).Type == FieldMarkType.FieldEnd)
        {
            if (fieldStack.Count == 1)
            {
                fieldStack.Clear();
                return item;
            }
            else
                fieldStack.Pop();
        }
    }
    return FindLastItemInTextBody(toc, fieldStack);
}
// Finds the last TOC item from consequence text body items.
static Entity FindLastItemInTextBody(TableOfContent toc, Stack<Entity> fieldStack)
{
    WTextBody tBody = toc.OwnerParagraph.OwnerTextBody;

    //Finds whether TOC end item is exist in text body items.
    for (int i = tBody.ChildEntities.IndexOf(toc.OwnerParagraph) + 1; i < tBody.ChildEntities.Count; i++)
    {
        WParagraph paragraph = null;
        if (tBody.ChildEntities[i] is WParagraph)
            paragraph = tBody.ChildEntities[i] as WParagraph;
        else
            continue;

        foreach (Entity item in paragraph.Items)
        {
            if (item is WField)
                fieldStack.Push(item);
            else if (item is WFieldMark && (item as WFieldMark).Type == FieldMarkType.FieldEnd)
            {
                if (fieldStack.Count == 1)
                {
                    fieldStack.Clear();
                    return item;
                }
                else
                    fieldStack.Pop();
            }
        }
    }
    return null;
}
// Delete the bookmark items.
static void DeleteBookmarkContents(string bkmkName, WordDocument document)
{
    //Creates the bookmark navigator instance to access the bookmark
    BookmarksNavigator navigator = new BookmarksNavigator(document);
    //Moves the virtual cursor to the location before the end of the bookmark "tableOfContent".
    navigator.MoveToBookmark(bkmkName);
    //Deletes the bookmark content.
    navigator.DeleteBookmarkContent(false);
    //Gets the bookmark instance by using FindByName method of BookmarkCollection with bookmark name.
    Bookmark bookmark = document.Bookmarks.FindByName(bkmkName);
    //Removes the bookmark named "tableOfContent" from Word document.
    document.Bookmarks.Remove(bookmark);
}

C# [Windows-specific]

#region Helper methods
// Removes the table of contents from Word document.
static void RemoveTableOfContents(TableOfContent toc)
{
    //Finds the last TOC item.
    Entity lastItem = FindLastTOCItem(toc);

    //TOC field end mark wasn't exist.
    if (lastItem == null)
        return;

    //Inserts the bookmark start before the TOC instance.
    BookmarkStart bkmkStart = new BookmarkStart(toc.Document, "tableOfContent");
    toc.OwnerParagraph.Items.Insert(toc.OwnerParagraph.Items.IndexOf(toc), bkmkStart);

    //Inserts the bookmark end to next of TOC last item.
    BookmarkEnd bkmkEnd = new BookmarkEnd(toc.Document, "tableOfContent");
    WParagraph paragraph = lastItem.Owner as WParagraph;
    paragraph.Items.Insert(paragraph.Items.IndexOf(lastItem) + 1, bkmkEnd);

    //Delete all the items from bookmark start to end (TOC items) using Bookmark Navigator.
    DeleteBookmarkContents(bkmkEnd.Name, toc.Document);
}
// Finds the last TOC item.
static Entity FindLastTOCItem(TableOfContent toc)
{
    int tocIndex = toc.OwnerParagraph.Items.IndexOf(toc);
    //TOC may contains nested fields and each fields has its owner field end mark 
    //so to identify the TOC Field end mark (WFieldMark instance) used the stack.
    Stack<Entity> fieldStack = new Stack<Entity>();
    fieldStack.Push(toc);

    //Finds whether TOC end item is exist in same paragraph.
    for (int i = tocIndex + 1; i < toc.OwnerParagraph.Items.Count; i++)
    {
        Entity item = toc.OwnerParagraph.Items[i];

        if (item is WField)
            fieldStack.Push(item);
        else if (item is WFieldMark && (item as WFieldMark).Type == FieldMarkType.FieldEnd)
        {
            if (fieldStack.Count == 1)
            {
                fieldStack.Clear();
                return item;
            }
            else
                fieldStack.Pop();
        }
    }
    return FindLastItemInTextBody(toc, fieldStack);
}
// Finds the last TOC item from consequence text body items.
static Entity FindLastItemInTextBody(TableOfContent toc, Stack<Entity> fieldStack)
{
    WTextBody tBody = toc.OwnerParagraph.OwnerTextBody;

    //Finds whether TOC end item is exist in text body items.
    for (int i = tBody.ChildEntities.IndexOf(toc.OwnerParagraph) + 1; i < tBody.ChildEntities.Count; i++)
    {
        WParagraph paragraph = null;
        if (tBody.ChildEntities[i] is WParagraph)
            paragraph = tBody.ChildEntities[i] as WParagraph;
        else
            continue;

        foreach (Entity item in paragraph.Items)
        {
            if (item is WField)
                fieldStack.Push(item);
            else if (item is WFieldMark && (item as WFieldMark).Type == FieldMarkType.FieldEnd)
            {
                if (fieldStack.Count == 1)
                {
                    fieldStack.Clear();
                    return item;
                }
                else
                    fieldStack.Pop();
            }
        }
    }
    return null;
}
// Delete the bookmark items.
static void DeleteBookmarkContents(string bkmkName, WordDocument document)
{
    //Creates the bookmark navigator instance to access the bookmark
    BookmarksNavigator navigator = new BookmarksNavigator(document);
    //Moves the virtual cursor to the location before the end of the bookmark "tableOfContent".
    navigator.MoveToBookmark(bkmkName);
    //Deletes the bookmark content.
    navigator.DeleteBookmarkContent(false);
    //Gets the bookmark instance by using FindByName method of BookmarkCollection with bookmark name.
    Bookmark bookmark = document.Bookmarks.FindByName(bkmkName);
    //Removes the bookmark named "tableOfContent" from Word document.
    document.Bookmarks.Remove(bookmark);
}

VB.NET [Windows-specific]

'Removes the table of contents from Word document.
Private Sub RemoveTableOfContents(ByVal toc As TableOfContent)
    'Finds the last TOC item.
    Dim lastItem As Entity = FindLastTOCItem(toc)
    'TOC field end mark wasn't exist.
    If (lastItem Is Nothing) Then
        Return
    End If

    'Inserts the bookmark start before the TOC instance.
    Dim bkmkStart As BookmarkStart = New BookmarkStart(toc.Document, "tableOfContent")
    toc.OwnerParagraph.Items.Insert(toc.OwnerParagraph.Items.IndexOf(toc), bkmkStart)
    'Inserts the bookmark end to next of TOC last item.
    Dim bkmkEnd As BookmarkEnd = New BookmarkEnd(toc.Document, "tableOfContent")
    Dim paragraph As WParagraph = CType(lastItem.Owner, WParagraph)
    paragraph.Items.Insert((paragraph.Items.IndexOf(lastItem) + 1), bkmkEnd)
    'Delete all the items from bookmark start to end (TOC items) using Bookmark Navigator.
    DeleteBookmarkContents(bkmkEnd.Name, toc.Document)
End Sub

'Finds the last TOC item.
Private Function FindLastTOCItem(ByVal toc As TableOfContent) As Entity
    Dim tocIndex As Integer = toc.OwnerParagraph.Items.IndexOf(toc)
    'TOC may contains nested fields and each fields has its owner field end mark 
    'so to identify the TOC Field end mark (WFieldMark instance) used the stack.
    Dim fieldStack As Stack(Of Entity) = New Stack(Of Entity)
    fieldStack.Push(toc)
    'Finds whether TOC end item is exist in same paragraph.
    Dim i As Integer = (tocIndex + 1)
    Do While (i < toc.OwnerParagraph.Items.Count)
        Dim item As Entity = toc.OwnerParagraph.Items(i)
        If (TypeOf item Is WField) Then
            fieldStack.Push(item)
        ElseIf (TypeOf item Is WFieldMark AndAlso (CType(item, WFieldMark).Type = FieldMarkType.FieldEnd)) Then
            If (fieldStack.Count = 1) Then
                fieldStack.Clear()
                Return item
            Else
                fieldStack.Pop()
            End If

        End If

        i = (i + 1)
    Loop

    Return FindLastItemInTextBody(toc, fieldStack)
End Function

'Finds the last TOC item from consequence text body items.
Private Function FindLastItemInTextBody(ByVal toc As TableOfContent, ByVal fieldStack As Stack(Of Entity)) As Entity
    Dim tBody As WTextBody = toc.OwnerParagraph.OwnerTextBody
    'Finds whether TOC end item is exist in text body items.
    Dim i As Integer = (tBody.ChildEntities.IndexOf(toc.OwnerParagraph) + 1)
    Do While (i < tBody.ChildEntities.Count)
        Dim paragraph As WParagraph = Nothing
        If (TypeOf tBody.ChildEntities(i) Is WParagraph) Then
            paragraph = CType(tBody.ChildEntities(i), WParagraph)
        Else
            'TODO: Warning!!! continue Else
        End If

        For Each item As Entity In paragraph.Items
            If (TypeOf item Is WField) Then
                fieldStack.Push(item)
            ElseIf (TypeOf item Is WFieldMark AndAlso (CType(item, WFieldMark).Type = FieldMarkType.FieldEnd)) Then
                If (fieldStack.Count = 1) Then
                    fieldStack.Clear()
                    Return item
                Else
                    fieldStack.Pop()
                End If

            End If

        Next
        i = (i + 1)
    Loop

    Return Nothing
End Function

'Delete the bookmark items.
Private Sub DeleteBookmarkContents(ByVal bkmkName As String, ByVal document As WordDocument)
    'Creates the bookmark navigator instance to access the bookmark
    Dim navigator As BookmarksNavigator = New BookmarksNavigator(document)
    'Moves the virtual cursor to the location before the end of the bookmark "tableOfContent".
    navigator.MoveToBookmark(bkmkName)
    'Deletes the bookmark content.
    navigator.DeleteBookmarkContent(False)
    'Gets the bookmark instance by using FindByName method of BookmarkCollection with bookmark name.
    Dim bookmark As Bookmark = document.Bookmarks.FindByName(bkmkName)
    'Removes the bookmark named "tableOfContent" from Word document.
    document.Bookmarks.Remove(bookmark)
End Sub

You can download a complete working sample from GitHub.

Table of Figures

You can create captions for images, tables, charts, or other items using the SEQ field. Now, create a Table of Figures, tables, charts, or other items that are numbered by a SEQ (Sequence) field using the SEQIdentifier in the TableOfFiguresLabel API.

With this feature, you can create a Table of Figures, tables, charts, and more, giving readers a clear overview of the document’s contents and facilitating easier navigation.

NOTE

Update the SEQ fields in the Word document by calling the UpdateDocumentFields API and then update the Table of Contents by calling the UpdateTableOfContents to build the Table of Figures.

The following code example illustrates how to add a Table of Figures in a Word document using the .NET Word Library (DocIO).

NOTE

Refer to the appropriate tabs in the code snippets section: C# [Cross-platform] for ASP.NET Core, Blazor, Xamarin, UWP, .NET MAUI, and WinUI; C# [Windows-specific] for WinForms and WPF; VB.NET [Windows-specific] for VB.NET applications.

C# [Cross-platform]

using (FileStream fileStream = new FileStream("Input.docx", FileMode.Open, FileAccess.Read))
{
    using (WordDocument document = new WordDocument(fileStream, FormatType.Docx))
    {
        WParagraph paragraph = new WParagraph(document);
        paragraph.AppendText("List of Figures");
        //Apply Heading1 style for paragraph.
        paragraph.ApplyStyle(BuiltinStyle.Heading1);
        //Insert the paragraph 
        document.LastSection.Body.ChildEntities.Insert(0, paragraph);
        //Create new paragraph and append TOC 
        paragraph = new WParagraph(document);
        TableOfContent tableOfContent = paragraph.AppendTOC(1, 3);
        //Disable a flag to exclude heading style paragraphs in TOC entries.
        tableOfContent.UseHeadingStyles = false;
        //Set the name of SEQ field identifier for table of figures.
        tableOfContent.TableOfFiguresLabel = "Figure";
        //Insert the paragraph to the text body.
        document.LastSection.Body.ChildEntities.Insert(1, paragraph);

        //Find all pictures from the document
        List<Entity> pictures = document.FindAllItemsByProperty(EntityType.Picture, null, null);
        // Iterate each picture and add caption.
        foreach (WPicture picture in pictures)
        {
            //Set alternate text as caption for picture.
            WParagraph captionPara = picture.AddCaption("Figure", CaptionNumberingFormat.Number, CaptionPosition.AfterImage) as WParagraph;
            captionPara.AppendText(" " + picture.AlternativeText);
            //Apply formatting to the caption.
            captionPara.ApplyStyle(BuiltinStyle.Caption);
            captionPara.ParagraphFormat.BeforeSpacing = 8;
            captionPara.ParagraphFormat.HorizontalAlignment = HorizontalAlignment.Center;
        }

        // Create a new paragraph
        paragraph = new WParagraph(document);
        paragraph.AppendText("List of Tables");
        // Apply Heading1 style for paragraph.
        paragraph.ApplyStyle(BuiltinStyle.Heading1);
        // Insert the paragraph
        document.LastSection.Body.ChildEntities.Insert(2, paragraph);

        //Create a new paragraph and append TOC.
        paragraph = new WParagraph(document);
        tableOfContent = paragraph.AppendTOC(1, 3);
        //Disable a flag to exclude heading style paragraphs in TOC entries.
        tableOfContent.UseHeadingStyles = false;
        //Set the name of SEQ field identifier for table of tables.
        tableOfContent.TableOfFiguresLabel = "Table";
        // Insert the paragraph to the text body.
        document.LastSection.Body.ChildEntities.Insert(3, paragraph);


        // Find all tables from the document
        List<Entity> tables = document.FindAllItemsByProperty(EntityType.Table, null, null);
        //Iterate each table and add caption.
        foreach (WTable table in tables)
        {
            //Gets the table index
            int tableIndex = table.OwnerTextBody.ChildEntities.IndexOf(table);
            //Create a new paragraph and appends the sequence field to use as a caption.
            WParagraph captionPara = new WParagraph(document);
            captionPara.AppendText("Table ");
            captionPara.AppendField("Table", FieldType.FieldSequence);
            //Set alternate text as caption for table.
            captionPara.AppendText(" " + table.Description);
            // Apply formatting to the paragraph
            captionPara.ApplyStyle(BuiltinStyle.Caption);
            captionPara.ParagraphFormat.BeforeSpacing = 8;
            captionPara.ParagraphFormat.HorizontalAlignment = HorizontalAlignment.Center;
            //Insert the paragraph next to the table
            table.OwnerTextBody.ChildEntities.Insert(tableIndex + 1, captionPara);
        }

        //Update all document fields to update SEQ fields.
        document.UpdateDocumentFields();
        //Update the table of contents.
        document.UpdateTableOfContents();

        //Create a FileStream to save the Word file.
        using (FileStream outputStream = new FileStream("Output.docx", FileMode.Create, FileAccess.ReadWrite, FileShare.ReadWrite))
        {
            //Save the Word document.
            document.Save(outputStream, FormatType.Docx);
        }
    }        
}

C# [Windows-specific]

//Open an existing word document.
using (WordDocument document = new WordDocument("Input.docx",FormatType.Docx))
{
    //Create a new paragraph
    WParagraph paragraph = new WParagraph(document);
    paragraph.AppendText("List of Figures");
    //Apply Heading1 style for paragraph.
    paragraph.ApplyStyle(BuiltinStyle.Heading1);
    //Insert the paragraph. 
    document.LastSection.Body.ChildEntities.Insert(0, paragraph);

    //Create new paragraph and append TOC. 
    paragraph = new WParagraph(document);
    TableOfContent tableOfContent = paragraph.AppendTOC(1, 3);
    //Disable a flag to exclude heading style paragraphs in TOC entries.
    tableOfContent.UseHeadingStyles = false;
    //Set the name of SEQ field identifier for table of figures.
    tableOfContent.TableOfFiguresLabel = "Figure";
    //Insert the paragraph to the text body.
    document.LastSection.Body.ChildEntities.Insert(1, paragraph);

    //Find all pictures from the document.
    List<Entity> pictures = document.FindAllItemsByProperty(EntityType.Picture, null, null);
    // Iterate each picture and add caption.
    foreach (WPicture picture in pictures)
    {
        //Set alternate text as caption for picture.
        WParagraph captionPara = picture.AddCaption("Figure", CaptionNumberingFormat.Number, CaptionPosition.AfterImage) as WParagraph;
        captionPara.AppendText(" " + picture.AlternativeText);
        //Apply formatting to the caption.
        captionPara.ApplyStyle(BuiltinStyle.Caption);
        captionPara.ParagraphFormat.BeforeSpacing = 8;
        captionPara.ParagraphFormat.HorizontalAlignment = HorizontalAlignment.Center;
    }

    // Create a new paragraph.
    paragraph = new WParagraph(document);
    paragraph.AppendText("List of Tables");
    // Apply Heading1 style for paragraph.
    paragraph.ApplyStyle(BuiltinStyle.Heading1);
    // Insert the paragraph.
    document.LastSection.Body.ChildEntities.Insert(2, paragraph);

    //Create a new paragraph and append TOC.
    paragraph = new WParagraph(document);
    tableOfContent = paragraph.AppendTOC(1, 3);
    //Disable a flag to exclude heading style paragraphs in TOC entries.
    tableOfContent.UseHeadingStyles = false;
    //Set the name of SEQ field identifier for table of tables.
    tableOfContent.TableOfFiguresLabel = "Table";
    // Insert the paragraph to the text body.
    document.LastSection.Body.ChildEntities.Insert(3, paragraph);

    // Find all tables from the document.
    List<Entity> tables = document.FindAllItemsByProperty(EntityType.Table, null, null);
    //Iterate each table and add caption.
    foreach (WTable table in tables)
    {
        //Gets the table index.
        int tableIndex = table.OwnerTextBody.ChildEntities.IndexOf(table);
        //Create a new paragraph and appends the sequence field to use as a caption.
        WParagraph captionPara = new WParagraph(document);
        captionPara.AppendText("Table ");
        captionPara.AppendField("Table", FieldType.FieldSequence);
        //Set alternate text as caption for table.
        captionPara.AppendText(" " + table.Description);
        // Apply formatting to the paragraph.
        captionPara.ApplyStyle(BuiltinStyle.Caption);
        captionPara.ParagraphFormat.BeforeSpacing = 8;
        captionPara.ParagraphFormat.HorizontalAlignment = HorizontalAlignment.Center;
        //Insert the paragraph next to the table.
        table.OwnerTextBody.ChildEntities.Insert(tableIndex + 1, captionPara);
    }

    //Update all document fields to update SEQ fields.
    document.UpdateDocumentFields();
    //Update the table of contents.
    document.UpdateTableOfContents();

    //Save the Word document.
    document.Save("Output.docx");
}

VB.NET [Windows-specific]

' Open an existing word document.
Using document As New WordDocument("Input.docx", FormatType.Docx)
    ' Create a new paragraph
    Dim paragraph As New WParagraph(document)
    paragraph.AppendText("List of Figures")
    ' Apply Heading1 style for paragraph.
    paragraph.ApplyStyle(BuiltinStyle.Heading1)
    ' Insert the paragraph. 
    document.LastSection.Body.ChildEntities.Insert(0, paragraph)

    ' Create new paragraph and append TOC. 
    paragraph = New WParagraph(document)
    Dim tableOfContent As TableOfContent = paragraph.AppendTOC(1, 3)
    ' Disable a flag to exclude heading style paragraphs in TOC entries.
    tableOfContent.UseHeadingStyles = False
    ' Set the name of SEQ field identifier for table of figures.
    tableOfContent.TableOfFiguresLabel = "Figure"
    ' Insert the paragraph to the text body.
    document.LastSection.Body.ChildEntities.Insert(1, paragraph)

    ' Find all pictures from the document.
    Dim pictures As List(Of Entity) = document.FindAllItemsByProperty(EntityType.Picture, Nothing, Nothing)
    ' Iterate each picture and add caption.
    For Each picture As WPicture In pictures
        ' Set alternate text as caption for picture.
        Dim captionPara As WParagraph = TryCast(picture.AddCaption("Figure", CaptionNumberingFormat.Number, CaptionPosition.AfterImage), WParagraph)
        captionPara.AppendText(" " + picture.AlternativeText)
        ' Apply formatting to the caption.
        captionPara.ApplyStyle(BuiltinStyle.Caption)
        captionPara.ParagraphFormat.BeforeSpacing = 8
        captionPara.ParagraphFormat.HorizontalAlignment = HorizontalAlignment.Center
    Next

    ' Create a new paragraph.
    paragraph = New WParagraph(document)
    paragraph.AppendText("List of Tables")
    ' Apply Heading1 style for paragraph.
    paragraph.ApplyStyle(BuiltinStyle.Heading1)
    ' Insert the paragraph.
    document.LastSection.Body.ChildEntities.Insert(2, paragraph)

    ' Create a new paragraph and append TOC.
    paragraph = New WParagraph(document)
    tableOfContent = paragraph.AppendTOC(1, 3)
    ' Disable a flag to exclude heading style paragraphs in TOC entries.
    tableOfContent.UseHeadingStyles = False
    ' Set the name of SEQ field identifier for table of tables.
    tableOfContent.TableOfFiguresLabel = "Table"
    ' Insert the paragraph to the text body.
    document.LastSection.Body.ChildEntities.Insert(3, paragraph)

    ' Find all tables from the document.
    Dim tables As List(Of Entity) = document.FindAllItemsByProperty(EntityType.Table, Nothing, Nothing)
    ' Iterate each table and add caption.
    For Each table As WTable In tables
        ' Gets the table index.
        Dim tableIndex As Integer = table.OwnerTextBody.ChildEntities.IndexOf(table)
        ' Create a new paragraph and appends the sequence field to use as a caption.
        Dim captionPara As New WParagraph(document)
        captionPara.AppendText("Table ")
        captionPara.AppendField("Table", FieldType.FieldSequence)
        ' Set alternate text as caption for table.
        captionPara.AppendText(" " + table.Description)
        ' Apply formatting to the paragraph.
        captionPara.ApplyStyle(BuiltinStyle.Caption)
        captionPara.ParagraphFormat.BeforeSpacing = 8
        captionPara.ParagraphFormat.HorizontalAlignment = HorizontalAlignment.Center
        ' Insert the paragraph next to the table.
        table.OwnerTextBody.ChildEntities.Insert(tableIndex + 1, captionPara)
    Next

    ' Update all document fields to update SEQ fields.
    document.UpdateDocumentFields()
    ' Update the table of contents.
    document.UpdateTableOfContents()

    ' Save the document
    document.Save("Output.docx")
End Using

UWP

//DocIO does not support a table of figures directly in the UWP platform. You can achieve this by using the Syncfusion.DocIORenderer.Net.Core NuGet package in UWP.

You can download a complete working sample from GitHub.

By executing the program, you will get the Word document as follows.

Exclude caption label and numbers

Include or exclude the caption’s label and numbers while creating a Table of Contents with a list of captions for figures, tables, charts, or other items.

The following code example illustrates how to add a Table of Figures by excluding the caption’s label and number in a Word document using the IncludeCaptionLabelsAndNumbers API.

C# [Cross-platform]

using (FileStream fileStream = new FileStream("Input.docx", FileMode.Open, FileAccess.Read))
{
    using (WordDocument document = new WordDocument(fileStream, FormatType.Docx))
    {
        WParagraph paragraph = new WParagraph(document);
        paragraph.AppendText("List of Figures");
        //Apply Heading1 style for paragraph.
        paragraph.ApplyStyle(BuiltinStyle.Heading1);
        //Insert the paragraph 
        document.LastSection.Body.ChildEntities.Insert(0, paragraph);
        //Create new paragraph and append TOC 
        paragraph = new WParagraph(document);
        TableOfContent tableOfContent = paragraph.AppendTOC(1, 3);
        //Disable a flag to exclude heading style paragraphs in TOC entries.
        tableOfContent.UseHeadingStyles = false;
        //Set the name of SEQ field identifier for table of figures.
        tableOfContent.TableOfFiguresLabel = "Figure";
        //Disable the flag, to exclude caption's label and number in TOC entries.
        tableOfContent.IncludeCaptionLabelsAndNumbers = false;
        //Insert the paragraph to the text body.
        document.LastSection.Body.ChildEntities.Insert(1, paragraph);

        //Find all pictures from the document
        List<Entity> pictures = document.FindAllItemsByProperty(EntityType.Picture, null, null);
        // Iterate each picture and add caption.
        foreach (WPicture picture in pictures)
        {
            //Set alternate text as caption for picture.
            WParagraph captionPara = picture.AddCaption("Figure", CaptionNumberingFormat.Number, CaptionPosition.AfterImage) as WParagraph;
            captionPara.AppendText(" " + picture.AlternativeText);
            //Apply formatting to the caption.
            captionPara.ApplyStyle(BuiltinStyle.Caption);
            captionPara.ParagraphFormat.BeforeSpacing = 8;
            captionPara.ParagraphFormat.HorizontalAlignment = HorizontalAlignment.Center;
        }

        // Create a new paragraph
        paragraph = new WParagraph(document);
        paragraph.AppendText("List of Tables");
        // Apply Heading1 style for paragraph.
        paragraph.ApplyStyle(BuiltinStyle.Heading1);
        // Insert the paragraph
        document.LastSection.Body.ChildEntities.Insert(2, paragraph);

        //Create a new paragraph and append TOC.
        paragraph = new WParagraph(document);
        tableOfContent = paragraph.AppendTOC(1, 3);
        //Disable a flag to exclude heading style paragraphs in TOC entries.
        tableOfContent.UseHeadingStyles = false;
        //Set the name of SEQ field identifier for table of tables.
        tableOfContent.TableOfFiguresLabel = "Table";
        //Disable the flag, to exclude caption's label and number in TOC entries.
        tableOfContent.IncludeCaptionLabelsAndNumbers = false;
        // Insert the paragraph to the text body.
        document.LastSection.Body.ChildEntities.Insert(3, paragraph);


        // Find all tables from the document
        List<Entity> tables = document.FindAllItemsByProperty(EntityType.Table, null, null);
        //Iterate each table and add caption.
        foreach (WTable table in tables)
        {
            //Gets the table index
            int tableIndex = table.OwnerTextBody.ChildEntities.IndexOf(table);
            //Create a new paragraph and appends the sequence field to use as a caption.
            WParagraph captionPara = new WParagraph(document);
            captionPara.AppendText("Table ");
            captionPara.AppendField("Table", FieldType.FieldSequence);
            //Set alternate text as caption for table.
            captionPara.AppendText(" " + table.Description);
            // Apply formatting to the paragraph
            captionPara.ApplyStyle(BuiltinStyle.Caption);
            captionPara.ParagraphFormat.BeforeSpacing = 8;
            captionPara.ParagraphFormat.HorizontalAlignment = HorizontalAlignment.Center;
            //Insert the paragraph next to the table
            table.OwnerTextBody.ChildEntities.Insert(tableIndex + 1, captionPara);
        }

        //Update all document fields to update SEQ fields.
        document.UpdateDocumentFields();
        //Update the table of contents.
        document.UpdateTableOfContents();

        //Create a FileStream to save the Word file.
        using (FileStream outputStream = new FileStream("Output.docx", FileMode.Create, FileAccess.ReadWrite, FileShare.ReadWrite))
        {
            //Save the Word document.
            document.Save(outputStream, FormatType.Docx);
        }
    }        
}

C# [Windows-specific]

//Open an existing word document.
using (WordDocument document = new WordDocument("Input.docx",FormatType.Docx))
{
    //Create a new paragraph
    WParagraph paragraph = new WParagraph(document);
    paragraph.AppendText("List of Figures");
    //Apply Heading1 style for paragraph.
    paragraph.ApplyStyle(BuiltinStyle.Heading1);
    //Insert the paragraph. 
    document.LastSection.Body.ChildEntities.Insert(0, paragraph);

    //Create new paragraph and append TOC. 
    paragraph = new WParagraph(document);
    TableOfContent tableOfContent = paragraph.AppendTOC(1, 3);
    //Disable a flag to exclude heading style paragraphs in TOC entries.
    tableOfContent.UseHeadingStyles = false;
    //Set the name of SEQ field identifier for table of figures.
    tableOfContent.TableOfFiguresLabel = "Figure";
    //Disable the flag, to exclude caption's label and number in TOC entries.
    tableOfContent.IncludeCaptionLabelsAndNumbers = false;
    //Insert the paragraph to the text body.
    document.LastSection.Body.ChildEntities.Insert(1, paragraph);

    //Find all pictures from the document.
    List<Entity> pictures = document.FindAllItemsByProperty(EntityType.Picture, null, null);
    // Iterate each picture and add caption.
    foreach (WPicture picture in pictures)
    {
        //Set alternate text as caption for picture.
        WParagraph captionPara = picture.AddCaption("Figure", CaptionNumberingFormat.Number, CaptionPosition.AfterImage) as WParagraph;
        captionPara.AppendText(" " + picture.AlternativeText);
        //Apply formatting to the caption.
        captionPara.ApplyStyle(BuiltinStyle.Caption);
        captionPara.ParagraphFormat.BeforeSpacing = 8;
        captionPara.ParagraphFormat.HorizontalAlignment = HorizontalAlignment.Center;
    }

    // Create a new paragraph.
    paragraph = new WParagraph(document);
    paragraph.AppendText("List of Tables");
    // Apply Heading1 style for paragraph.
    paragraph.ApplyStyle(BuiltinStyle.Heading1);
    // Insert the paragraph.
    document.LastSection.Body.ChildEntities.Insert(2, paragraph);

    //Create a new paragraph and append TOC.
    paragraph = new WParagraph(document);
    tableOfContent = paragraph.AppendTOC(1, 3);
    //Disable a flag to exclude heading style paragraphs in TOC entries.
    tableOfContent.UseHeadingStyles = false;
    //Set the name of SEQ field identifier for table of tables.
    tableOfContent.TableOfFiguresLabel = "Table";
    //Disable the flag, to exclude caption's label and number in TOC entries.
    tableOfContent.IncludeCaptionLabelsAndNumbers = false;
    // Insert the paragraph to the text body.
    document.LastSection.Body.ChildEntities.Insert(3, paragraph);

    // Find all tables from the document.
    List<Entity> tables = document.FindAllItemsByProperty(EntityType.Table, null, null);
    //Iterate each table and add caption.
    foreach (WTable table in tables)
    {
        //Gets the table index.
        int tableIndex = table.OwnerTextBody.ChildEntities.IndexOf(table);
        //Create a new paragraph and appends the sequence field to use as a caption.
        WParagraph captionPara = new WParagraph(document);
        captionPara.AppendText("Table ");
        captionPara.AppendField("Table", FieldType.FieldSequence);
        //Set alternate text as caption for table.
        captionPara.AppendText(" " + table.Description);
        // Apply formatting to the paragraph.
        captionPara.ApplyStyle(BuiltinStyle.Caption);
        captionPara.ParagraphFormat.BeforeSpacing = 8;
        captionPara.ParagraphFormat.HorizontalAlignment = HorizontalAlignment.Center;
        //Insert the paragraph next to the table.
        table.OwnerTextBody.ChildEntities.Insert(tableIndex + 1, captionPara);
    }

    //Update all document fields to update SEQ fields.
    document.UpdateDocumentFields();
    //Update the table of contents.
    document.UpdateTableOfContents();

    //Save the Word document.
    document.Save("Output.docx");
}

VB.NET [Windows-specific]

' Open an existing word document.
Using document As New WordDocument("Input.docx", FormatType.Docx)
    ' Create a new paragraph
    Dim paragraph As New WParagraph(document)
    paragraph.AppendText("List of Figures")
    ' Apply Heading1 style for paragraph.
    paragraph.ApplyStyle(BuiltinStyle.Heading1)
    ' Insert the paragraph. 
    document.LastSection.Body.ChildEntities.Insert(0, paragraph)

    ' Create new paragraph and append TOC. 
    paragraph = New WParagraph(document)
    Dim tableOfContent As TableOfContent = paragraph.AppendTOC(1, 3)
    ' Disable a flag to exclude heading style paragraphs in TOC entries.
    tableOfContent.UseHeadingStyles = False
    ' Set the name of SEQ field identifier for table of figures.
    tableOfContent.TableOfFiguresLabel = "Figure"
    ' Disable the flag, to exclude caption's label and number in TOC entries.
    tableOfContent.IncludeCaptionLabelsAndNumbers = False
    ' Insert the paragraph to the text body.
    document.LastSection.Body.ChildEntities.Insert(1, paragraph)

    ' Find all pictures from the document.
    Dim pictures As List(Of Entity) = document.FindAllItemsByProperty(EntityType.Picture, Nothing, Nothing)
    ' Iterate each picture and add caption.
    For Each picture As WPicture In pictures
        ' Set alternate text as caption for picture.
        Dim captionPara As WParagraph = TryCast(picture.AddCaption("Figure", CaptionNumberingFormat.Number, CaptionPosition.AfterImage), WParagraph)
        captionPara.AppendText(" " + picture.AlternativeText)
        ' Apply formatting to the caption.
        captionPara.ApplyStyle(BuiltinStyle.Caption)
        captionPara.ParagraphFormat.BeforeSpacing = 8
        captionPara.ParagraphFormat.HorizontalAlignment = HorizontalAlignment.Center
    Next

    ' Create a new paragraph.
    paragraph = New WParagraph(document)
    paragraph.AppendText("List of Tables")
    ' Apply Heading1 style for paragraph.
    paragraph.ApplyStyle(BuiltinStyle.Heading1)
    ' Insert the paragraph.
    document.LastSection.Body.ChildEntities.Insert(2, paragraph)

    ' Create a new paragraph and append TOC.
    paragraph = New WParagraph(document)
    tableOfContent = paragraph.AppendTOC(1, 3)
    ' Disable a flag to exclude heading style paragraphs in TOC entries.
    tableOfContent.UseHeadingStyles = False
    ' Set the name of SEQ field identifier for table of tables.
    tableOfContent.TableOfFiguresLabel = "Table"
    ' Disable the flag, to exclude caption's label and number in TOC entries.
    tableOfContent.IncludeCaptionLabelsAndNumbers = False
    ' Insert the paragraph to the text body.
    document.LastSection.Body.ChildEntities.Insert(3, paragraph)

    ' Find all tables from the document.
    Dim tables As List(Of Entity) = document.FindAllItemsByProperty(EntityType.Table, Nothing, Nothing)
    ' Iterate each table and add caption.
    For Each table As WTable In tables
        ' Gets the table index.
        Dim tableIndex As Integer = table.OwnerTextBody.ChildEntities.IndexOf(table)
        ' Create a new paragraph and appends the sequence field to use as a caption.
        Dim captionPara As New WParagraph(document)
        captionPara.AppendText("Table ")
        captionPara.AppendField("Table", FieldType.FieldSequence)
        ' Set alternate text as caption for table.
        captionPara.AppendText(" " + table.Description)
        ' Apply formatting to the paragraph.
        captionPara.ApplyStyle(BuiltinStyle.Caption)
        captionPara.ParagraphFormat.BeforeSpacing = 8
        captionPara.ParagraphFormat.HorizontalAlignment = HorizontalAlignment.Center
        ' Insert the paragraph next to the table.
        table.OwnerTextBody.ChildEntities.Insert(tableIndex + 1, captionPara)
    Next

    ' Update all document fields to update SEQ fields.
    document.UpdateDocumentFields()
    ' Update the table of contents.
    document.UpdateTableOfContents()

    ' Save the document
    document.Save("Output.docx")
End Using

You can download a complete working sample from GitHub.

By executing the program, you will get the Word document as follows.

Online Demo

• Explore how to insert and update the table of figures in a Word document using the .NET Word Library (DocIO) in a live demo here.
• See how to insert and update the table of contents in a Word document using the .NET Word Library (DocIO) in a live demo here.

See Also

• How to change the text of TOC Entries in the Table of content in the Word document?
• How to change tab leader of Table Of Contents in Word document
• How to customize the TOC entries style in Word document?