PDF TOC Generator

The Documentize PDF TOC Generator for .NET is a powerful plugin designed to enhance the organization and navigation of PDF documents by dynamically generating a Table of Contents (TOC). This plugin simplifies the process of adding TOCs to your PDFs, making documents easier to navigate and manage.

How to Generate a TOC for a PDF

To create a Table of Contents in a PDF file, follow these steps:

  1. Create an instance of the TocGenerator class.
  2. Create an instance of TocOptions to configure TOC generation settings.
  3. Add the input PDF file using the AddInput method.
  4. Specify the output PDF file with the TOC using the AddOutput method.
  5. Call the Process method to generate the TOC.
​
1var tocGenerator = new TocGenerator();
2var tocOptions = new TocOptions();
3
4// Add input and output files
5tocOptions.AddInput(new FileDataSource(@"C:\Samples\input.pdf"));
6tocOptions.AddOutput(new FileDataSource(@"C:\Samples\output_with_toc.pdf"));
7
8// Generate the TOC
9tocGenerator.Process(tocOptions);

Customizing the TOC

You can customize the Table of Contents by modifying the TocOptions class. For example, you can control the level of depth for the TOC entries, set specific formatting options, and more:

​
 1var tocOptions = new TocOptions
 2{
 3    Depth = 3,  // Set TOC depth level to 3
 4    FontSize = 12,  // Set font size for TOC entries
 5    Title = "Table of Contents"  // Customize the TOC title
 6};
 7
 8// Add input and output files
 9tocOptions.AddInput(new FileDataSource(@"C:\Samples\input.pdf"));
10tocOptions.AddOutput(new FileDataSource(@"C:\Samples\output_with_toc.pdf"));
11
12// Generate the TOC with customized options
13tocGenerator.Process(tocOptions);

How to Handle Results

After processing, the Process method returns a ResultContainer object that holds details about the TOC generation. You can retrieve and print the output details:

​
1var resultContainer = tocGenerator.Process(tocOptions);
2
3// Access the result collection and print the output file path
4var result = resultContainer.ResultCollection[0];
5Console.WriteLine(result);

Batch Processing for Multiple PDFs

The PDF TOC Generator plugin supports batch processing, enabling you to add TOCs to multiple PDF documents simultaneously.

​
 1var tocGenerator = new TocGenerator();
 2var tocOptions = new TocOptions();
 3
 4// Add multiple input PDFs
 5tocOptions.AddInput(new FileDataSource(@"C:\Samples\file1.pdf"));
 6tocOptions.AddInput(new FileDataSource(@"C:\Samples\file2.pdf"));
 7
 8// Add the output PDFs with TOC
 9tocOptions.AddOutput(new FileDataSource(@"C:\Samples\output1_with_toc.pdf"));
10tocOptions.AddOutput(new FileDataSource(@"C:\Samples\output2_with_toc.pdf"));
11
12// Process the batch TOC generation
13tocGenerator.Process(tocOptions);

Key Features:

  • Dynamic TOC Generation: Create a TOC for any PDF file with automatically generated entries based on headings or bookmarks.
  • Batch Processing: Generate TOCs for multiple PDF documents at once.
  • Customization: Control the appearance and structure of the TOC, including styles, formatting, and levels of depth.
  • Efficient Workflow: Minimize time spent manually creating TOCs, especially for large or complex documents.