Volledig werkend voorbeeld voor het toevoegen van een inhoudsopgave aan een Word‑document in Java

Het volgende voorbeeld toont hoe u een inhoudsopgave kunt invoegen in een bestaand DOCX‑bestand met behulp van Conholdate.Total for Java.

import com.groupdocs.words.Document;
import com.groupdocs.words.DocumentBuilder;
import com.groupdocs.words.TableOfContentsOptions;
import com.groupdocs.words.SaveFormat;
import com.groupdocs.words.TabLeader;

public class AddTableOfContentsExample {
    public static void main(String[] args) throws Exception {
        // Paths to the source and destination Word documents
        String inputPath = "input.docx";
        String outputPath = "output.docx";

// Load the existing document, add a TOC, and save the result
        try (Document doc = new Document(inputPath)) {
            DocumentBuilder builder = new DocumentBuilder(doc);

// Move cursor to the beginning of the document where the TOC will be inserted
            builder.moveToDocumentStart();

// Configure TOC options
            TableOfContentsOptions tocOptions = new TableOfContentsOptions();
            tocOptions.setUpperHeadingLevel(1);          // Include headings from level 1
            tocOptions.setLowerHeadingLevel(3);          // up to level 3
            tocOptions.setRightAlignPageNumbers(true);  // Align page numbers to the right
            tocOptions.setUseHyperlinks(true);           // Make entries clickable
            tocOptions.setTabLeader(TabLeader.DOTS);     // Use dotted leader

// Insert the Table of Contents
            builder.insertTableOfContents(tocOptions);

// Save the modified document
            doc.save(outputPath, SaveFormat.DOCX);
        }
    }
}

Opmerking: Dit codevoorbeeld toont de kernfunctionaliteit. Voordat u het in uw project gebruikt, moet u ervoor zorgen dat de bestandenpaden (input.docx, output.docx, enz.) worden aangepast aan uw werkelijke bestandslocaties, dat alle vereiste afhankelijkheden correct zijn geïnstalleerd, en dat u grondig test in uw ontwikkelomgeving. Als u problemen ondervindt, raadpleeg dan de officiële documentatie of neem contact op met het ondersteuningsteam voor hulp.

Inzicht in het toevoegen van een inhoudsopgave aan een Word‑document in Java‑code

Hieronder staat een overzicht van de belangrijkste stappen die door de voorbeeldcode worden uitgevoerd:

1. Laad het brondocument - De Document-klasse leest het bestaande DOCX‑bestand.

try (Document doc = new Document(inputPath)) {

2. Maak een DocumentBuilder - DocumentBuilder biedt methoden om de documentinhoud te bewerken.

DocumentBuilder builder = new DocumentBuilder(doc);

3. Plaats de cursor - moveToDocumentStart() verplaatst het invoegpunt naar het allereerste begin van het bestand, waardoor de inhoudsopgave vóór alle inhoud verschijnt.

builder.moveToDocumentStart();

4. Configureer TOC-opties - TableOfContentsOptions stelt je in staat om kopniveaus, uitlijning van paginanummers, gebruik van hyperlinks en de tab‑leiderstijl te definiëren.

TableOfContentsOptions tocOptions = new TableOfContentsOptions();
tocOptions.setUpperHeadingLevel(1);
tocOptions.setLowerHeadingLevel(3);
tocOptions.setRightAlignPageNumbers(true);
tocOptions.setUseHyperlinks(true);
tocOptions.setTabLeader(TabLeader.DOTS);

Gedetailleerde API-referentie is beschikbaar op de API-referentie pagina.

5. Voeg de inhoudsopgave in en sla op - insertTableOfContents voegt het veld toe, en doc.save schrijft het bijgewerkte bestand in DOCX-formaat.

builder.insertTableOfContents(tocOptions);
doc.save(outputPath, SaveFormat.DOCX);

Installeren en configureren van Conholdate.Total voor Java

Voeg de Conholdate Maven-repository en de SDK-afhankelijkheid toe aan uw pom.xml:

<repositories>
    <repository>
        <id>conholdate-repo</id>
        <name>Conholdate Maven Repository</name>
        <url>https://repository.conholdate.com/repo/</url>
    </repository>
</repositories>

<dependency>
    <groupId>com.conholdate</groupId>
    <artifactId>conholdate-total</artifactId>
    <version>24.9</version>
    <type>pom</type>
</dependency>

Download het nieuwste SDK‑pakket van de downloadpagina. De SDK vereist Java 8 of hoger en werkt op elke standaard JVM. Er zijn geen extra runtime‑componenten nodig.

Beste praktijken voor het genereren van een Word-inhoudsopgave met Java

• Gebruik consistente kopstijlen – De TOC haalt alinea’s op die zijn opgemaakt met ingebouwde kopniveaus (Heading 1, Heading 2, enz.). Zorg ervoor dat uw brondocument deze stijlen gebruikt voor betrouwbare entry‑generatie.
• Beperk de diepte van koppen – Het opnemen van te veel niveaus kan de TOC onhandig maken. Typische rapporten gebruiken niveaus 1‑3, zoals in het voorbeeld wordt getoond.
• Schakel hyperlinks in – Het instellen van setUseHyperlinks(true) maakt klikbare items aan, waardoor de navigatie in het einddocument verbetert.
• Valideer na invoegen – Open het gegenereerde DOCX en werk de velden bij (Ctrl +A, F9) om te bevestigen dat paginanummers nummers correct zijn, vooral na verdere bewerkingen.
• Hergebruik het TOC‑optiesobject – Als u meerdere documenten in één batch genereert, configureer de opties dan één keer en hergebruik ze om de overhead van objectcreatie te verminderen.

Conclusie

Het toevoegen van een inhoudsopgave aan een Word‑document in Java wordt eenvoudig met Conholdate.Total for Java. Door een DOCX te laden, TableOfContentsOptions te configureren en het veld in te voegen, kun je de creatie van professionele rapporten en handleidingen automatiseren. Vergeet niet de SDK te installeren, de best‑practice‑aanbevelingen te volgen en de gegenereerde inhoudsopgave te testen in je doelomgeving. Voor productie‑implementaties heb je een gelicentieerde kopie nodig; prijsdetails zijn beschikbaar op de prijspagina en een tijdelijke licentie kan worden verkregen via de tijdelijke licentiepagina.

Veelgestelde vragen

• Wat is de eenvoudigste manier om een inhoudsopgave toe te voegen aan een Word‑document in Java?
  Gebruik DocumentBuilder.moveToDocumentStart() gevolgd door insertTableOfContents met een geconfigureerd TableOfContentsOptions‑object, zoals gedemonstreerd in het codevoorbeeld.

• Hoe kan ik bepalen welke kopniveaus verschijnen in de inhoudsopgave?
  Stel setUpperHeadingLevel en setLowerHeadingLevel in op de TableOfContentsOptions-instantie om alleen de gewenste niveaus op te nemen.

• Is het mogelijk om een TOC te genereren voor een Word‑sjabloon dat later wordt ingevuld?
  Ja. Voeg de TOC toe aan het sjabloonbestand voordat u dynamische inhoud invoegt; de TOC zal automatisch verwijzen naar de later toegevoegde koppen.

• Heb ik een internetverbinding nodig om deze SDK te gebruiken?
  Nee. Conholdate.Total for Java is een lokale bibliotheek die op uw server of desktop draait zonder externe serviceaanroepen.

Lees meer

• Vormen toevoegen aan PDF in Java
• Inhoudsopgave invoegen in Word met Java
• Een inhoudsopgave toevoegen in Word met C#