Het genereren van een navigeerbare inhoudsopgave is essentieel bij het maken van grote Word‑rapporten of handleidingen die gebruikers snel moeten kunnen doorbladeren. Conholdate.Total for Java biedt een robuuste SDK die het werken met DOCX‑bestanden direct vanuit Java‑applicaties vereenvoudigt. In deze stapsgewijze gids leer je hoe je een inhoudsopgave toevoegt aan een Word‑document in Java, met uitleg over de installatie, de code en best practices.

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

Het volgende voorbeeld laat zien hoe u een inhoudsopgave in een DOCX‑bestand kunt invoegen met Conholdate.Total for Java.

import com.aspose.words.Document;
import com.aspose.words.DocumentBuilder;
import com.aspose.words.BreakType;
import com.aspose.words.StyleIdentifier;

public class AddTableOfContentsExample {
    public static void main(String[] args) throws Exception {
        // Directory where the output document will be saved
        String dataDir = "output/";

// Create a new document and a builder to work with it
        Document doc = new Document();
        DocumentBuilder builder = new DocumentBuilder(doc);

// Insert a table of contents field at the current cursor position.
        // "\o \"1-3\" \h \z \u" includes heading levels 1-3, makes entries
        // clickable hyperlinks, hides tab leaders in Web layout, and uses
        // outline levels applied to non-heading styles.
        builder.insertTableOfContents("\\o \"1-3\" \\h \\z \\u");

// Start the actual document content on the second page.
        builder.insertBreak(BreakType.PAGE_BREAK);

builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
        builder.writeln("Heading 1");

builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_2);
        builder.writeln("Heading 1.1");
        builder.writeln("Heading 1.2");

builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
        builder.writeln("Heading 2");
        builder.writeln("Heading 3");

builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_2);
        builder.writeln("Heading 3.1");

builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_3);
        builder.writeln("Heading 3.1.1");
        builder.writeln("Heading 3.1.2");
        builder.writeln("Heading 3.1.3");

builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_2);
        builder.writeln("Heading 3.2");
        builder.writeln("Heading 3.3");

// The newly inserted table of contents is initially empty.
        // It needs to be populated by updating the fields in the document.
        doc.updateFields();

doc.save(dataDir + "TableOfContents.docx");
    }
}

Opmerking: Dit codevoorbeeld toont de kernfunctionaliteit. Voordat u het in uw project gebruikt, moet u ervoor zorgen dat u de uitvoermap (dataDir) bijwerkt zodat deze overeenkomt met uw werkelijke bestandslocatie, controleer of alle vereiste afhankelijkheden correct zijn geïnstalleerd, en test grondig in uw ontwikkelomgeving. Als u problemen ondervindt, raadpleeg dan de officiële documentatie of neem contact op met het ondersteuningsteam voor hulp.

Begrijpen van 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. Maak het document en een builder - Document vertegenwoordigt het in‑memory Word‑bestand, en DocumentBuilder biedt je methoden om inhoud en velden in te voegen.

    Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);

  2. Voeg het TOC-veld in - insertTableOfContents schrijft een TOC-veld op de cursorpositie. De switch‑string bepaalt het gedrag: \o "1-3" omvat kopniveaus 1 tot 3, \h maakt items klikbare hyperlinks, \z verbergt tab‑leiders en paginanummers in de weergave Web‑layout, en \u gebruikt het outline‑niveau dat op alinea’s is toegepast.

builder.insertTableOfContents("\\o \"1-3\" \\h \\z \\u");
  1. Start inhoud op een nieuwe pagina - insertBreak(BreakType.PAGE_BREAK) duwt het daadwerkelijke documentinhoud naar de pagina na de TOC, zodat de inhoudsopgave een eigen pagina heeft.
builder.insertBreak(BreakType.PAGE_BREAK);

  1. Kopstijlinhoud toevoegen - Het instellen van setStyleIdentifier op het alineaformaat van de builder op HEADING_1, HEADING_2 of HEADING_3 vóór het aanroepen van writeln genereert alinea’s met de overeenkomstige ingebouwde kopstijl, die het TOC‑veld scant op items.

    builder.getParagraphFormat().setStyleIdentifier(StyleIdentifier.HEADING_1);
builder.writeln("Heading 1");

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

  2. Velden bijwerken en opslaan - doc.updateFields() vult de TOC met items en paginanummers nu de koppen bestaan, en doc.save schrijft het document naar de schijf.

doc.updateFields();
doc.save(dataDir + "TableOfContents.docx");

Installeren en configureren Conholdate.Total for 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 draait 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 generatie van items.
  • Beperk de diepte van koppen - Het opnemen van te veel niveaus kan de TOC onhandig maken. Typische rapporten gebruiken niveaus 1‑3, zoals te zien is in de voorbeeld‑\\o "1-3"‑schakelaar.
  • Schakel hyperlinks in - Het opnemen van de \\h‑schakelaar creëert klikbare items, waardoor de navigatie in het uiteindelijke document verbetert.
  • Roep altijd updateFields aan na invoegen - Een nieuw ingevoegd TOC‑veld is leeg totdat doc.updateFields() wordt uitgevoerd, dus roep het aan nadat alle kopinhoud is toegevoegd.
  • Valideer na invoegen - Open de gegenereerde DOCX en werk de velden bij (Ctrl +A, F9) om te bevestigen dat paginanummers numbers correct zijn, vooral na verdere bewerkingen.
  • Herbruik de schakelaar‑string - Als u meerdere documenten in één batch genereert, bouw dan de schakelaar‑string één keer en hergebruik deze bij opeenvolgende aanroepen om de opmaak consistent te houden.

Conclusie

Het toevoegen van een inhoudsopgave aan een Word‑document in Java wordt eenvoudig met Conholdate.Total for Java. Door een document te maken, een TOC‑veld met de juiste switches in te voegen, inhoud met kop‑stijlen toe te voegen en updateFields aan te roepen, kun je het genereren van professionele rapporten en handleidingen automatiseren. Vergeet niet de SDK te installeren, de best‑practice‑aanbevelingen te volgen en de gegenereerde inhoudsopgave in je doelomgeving te testen. Voor productie‑implementaties heb je een gelicentieerde kopie nodig; prijsdetails zijn beschikbaar op de prijspagina en een tijdelijke licentie kan worden verkregen via de pagina voor tijdelijke licentie.

Veelgestelde vragen

  • Wat is de eenvoudigste manier om een inhoudsopgave toe te voegen aan een Word-document in Java? Roep builder.insertTableOfContents("\\o \"1-3\" \\h \\z \\u") aan, voeg alinea’s met kopstijl toe, roep vervolgens doc.updateFields() aan vóór het opslaan, zoals getoond in het code‑voorbeeld.

  • Hoe kan ik bepalen welke kopniveaus in de inhoudsopgave verschijnen? Wijzig het niveau‑bereik binnen de \o‑schakelaar van de tekenreeks die wordt doorgegeven aan insertTableOfContents, bijvoorbeeld \o "1-2" om alleen de niveaus 1 en 2 op te nemen.

  • Is het mogelijk om een TOC te genereren voor een Word-sjabloon dat later wordt ingevuld? Ja. Voeg het TOC‑veld toe aan het sjabloonbestand voordat dynamische inhoud wordt ingevuld; het aanroepen van updateFields() nadat de koppen zijn toegevoegd, vult de TOC automatisch.

  • 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 service‑aanroepen.

Lees meer