How to create a link to table of contents and link that in footer? #ASPOSE.Words

Aspose.Words Product Family
1

We are using ASPOSE.Words. We would like to add a link to TOC(Table of contents) in footer of every page. Couldnt find any resources on how to achieve this. Please help.

2

@hrnallap

To create a link to the Table of Contents (TOC) in the footer of every page using Aspose.Words, you can follow these steps:

  1. Insert the Table of Contents: Use the InsertTableOfContents method to add a TOC field to your document. This method allows you to specify various options for how the TOC should be generated.

  2. Add the TOC to the Footer: After inserting the TOC, you can navigate to the footer section of your document and insert a hyperlink that points to the TOC.

Here’s a code example demonstrating how to achieve this in C#:

// Create a new document and DocumentBuilder
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

// Insert a Table of Contents
builder.InsertTableOfContents("\\o \"1-3\" \\h \\z \\u");
builder.InsertBreak(BreakType.PageBreak);

// Populate the document with headings
builder.ParagraphFormat.StyleIdentifier = StyleIdentifier.Heading1;
builder.Writeln("Heading 1");
builder.ParagraphFormat.StyleIdentifier = StyleIdentifier.Heading2;
builder.Writeln("Heading 1.1");
builder.Writeln("Heading 1.2");
builder.ParagraphFormat.StyleIdentifier = StyleIdentifier.Heading1;
builder.Writeln("Heading 2");
builder.Writeln("Heading 3");

// Update fields to reflect the TOC
doc.UpdateFields();

// Now, add a hyperlink to the footer that links to the TOC
foreach (Section section in doc.Sections)
{
    builder.MoveTo(section.Body.LastParagraph);
    builder.InsertField("HYPERLINK \"#TOC\" \\l \"TOC\"", "Table of Contents");
}

// Save the document
doc.Save("DocumentWithTOC.docx");

Explanation:

  • The InsertTableOfContents method is used to insert a TOC field at the current position in the document.
  • The UpdateFields method is called to ensure that the TOC is populated with the headings you have added.
  • A hyperlink is created in the footer that links to the TOC using the InsertField method.

This approach will ensure that every page in your document has a footer with a link to the Table of Contents, allowing readers to easily navigate back to it.

For more details on the InsertTableOfContents method, you can refer to the official documentation here.

If you have any further questions or need additional assistance, feel free to ask!

3

Wow your support group is too fast and efficient. Thank you.

1 Like