addTableContents

Option	Type	Description
autoUpdate	Boolean	If true it will try to update the TOC when first opened.
displayLevels	String	Must be of the form "1-3" where the first number is the start level an the second the end level. If not defined all existing levels are shown.

legend

Key	Type	Description
legend	WordFragment	The placeholder text that will be shown if the autoupdate option is not activated.

stylesTOC

Key	Type	Description
stylesTOC	String	Path to a DOCX. This optional parameter allows to extract the TOC styles from an existing Word document so the embedded TOC can be fully customized.

Code samples

Example #1

package examples.Core.addTableContents;

import com.javadocx.CreateDocx;
import com.javadocx.WordFragment;
import com.javadocx.elements.*;

public class Sample1 {
    public static void main(String[] args) {
        CreateDocx docx = new CreateDocx();
        
        OptionsText textOptions = new OptionsText();
        textOptions.setText("Click here to update the Table of Contents")
                   .setColor("B70000")
                   .setBold(true)
                   .setFontSize(12);
        WordFragment textFragment = new WordFragment(docx);
        textFragment.addText(textOptions);
        
        OptionsTableContents tableContentsOptions = new OptionsTableContents();
        tableContentsOptions.setAutoUpdate(true);
        
        docx.addTableContents(tableContentsOptions, textFragment);

        OptionsParagraph paragraphOptions = new OptionsParagraph();     
        paragraphOptions = new OptionsParagraph();
        paragraphOptions.setpStyle("Heading1JAVADOCX");

        docx.addText("Chapter 1", paragraphOptions);
        
        paragraphOptions = new OptionsParagraph();
        paragraphOptions.setpStyle("Heading2JAVADOCX");

        docx.addText("Section", paragraphOptions);
        
        paragraphOptions = new OptionsParagraph();
        paragraphOptions.setpStyle("Heading3JAVADOCX");

        docx.addText("Another TOC entry", paragraphOptions);
        
        docx.createDocx("example_addTableContents_1");
    }
}

Version 5 Launch Offer:

25% off on all licenses

addTableContents

addTableContents

Inserts a Table of Contents (TOC) into the Word document.