Vollständiges funktionierendes Beispiel zum Hinzufügen eines Inhaltsverzeichnisses zu einem Word-Dokument in Java

Das folgende Beispiel zeigt, wie man ein Inhaltsverzeichnis in eine bestehende DOCX‑Datei einfügt, indem man Conholdate.Total for Java verwendet.

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);
        }
    }
}

Hinweis: Dieses Codebeispiel demonstriert die Kernfunktionalität. Bevor Sie es in Ihrem Projekt verwenden, stellen Sie sicher, dass Sie die Dateipfade (input.docx, output.docx, usw.) an Ihre tatsächlichen Dateistandorte anpassen, dass alle erforderlichen Abhängigkeiten ordnungsgemäß installiert sind und testen Sie gründlich in Ihrer Entwicklungsumgebung. Wenn Sie auf Probleme stoßen, lesen Sie bitte die offizielle Dokumentation oder wenden Sie sich an das Support-Team für Unterstützung.

Verstehen des Hinzufügens eines Inhaltsverzeichnisses zu einem Word-Dokument im Java-Code

Im Folgenden finden Sie eine Aufschlüsselung der wichtigsten Schritte, die vom Beispielcode ausgeführt werden:

1. Laden des Quelldokuments - Die Document-Klasse liest die vorhandene DOCX-Datei.

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

2. Erstellen Sie einen DocumentBuilder - DocumentBuilder stellt Methoden zum Bearbeiten des Dokumentinhalts bereit.

DocumentBuilder builder = new DocumentBuilder(doc);

3. Positionieren Sie den Cursor - moveToDocumentStart() verschiebt den Einfügepunkt an den ganz Anfang der Datei und stellt sicher, dass das Inhaltsverzeichnis vor jeglichem Inhalt erscheint.

builder.moveToDocumentStart();

4. TOC-Optionen konfigurieren - TableOfContentsOptions ermöglicht es Ihnen, Überschriftenebenen, die Ausrichtung der Seitenzahlen, die Verwendung von Hyperlinks und den Tab‑Führungszeichenstil festzulegen.

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

   Detaillierte API-Referenz ist auf der Seite API Reference verfügbar.

5. Inhaltsverzeichnis einfügen und speichern - insertTableOfContents fügt das Feld hinzu und doc.save schreibt die aktualisierte Datei im DOCX-Format.

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

Installation und Konfiguration von Conholdate.Total für Java

Fügen Sie das Conholdate Maven-Repository und die SDK-Abhängigkeit zu Ihrer pom.xml hinzu:

<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 das neueste SDK‑Paket von der Download‑Seite. Das SDK erfordert Java 8 oder höher und läuft auf jeder Standard‑JVM. Zusätzliche Laufzeitkomponenten werden nicht benötigt.

Best Practices für die Generierung von Word‑TOC mit Java

• Verwenden Sie konsistente Überschriftenstile – Das TOC erkennt Absätze, die mit integrierten Überschriftenebenen (Heading 1, Heading 2 usw.) formatiert sind. Stellen Sie sicher, dass Ihr Quelldokument diese Stile für eine zuverlässige Eintragsgenerierung verwendet.
• Begrenzen Sie die Tiefe der Überschriften – Das Einbeziehen zu vieler Ebenen kann das TOC unhandlich machen. Typische Berichte verwenden Ebenen 1‑3, wie im Beispiel gezeigt.
• Hyperlinks aktivieren – Das Setzen setUseHyperlinks(true) erzeugt anklickbare Einträge und verbessert die Navigation im endgültigen Dokument.
• Nach dem Einfügen validieren – Öffnen Sie das erzeugte DOCX und aktualisieren Sie die Felder (Strg +A, F9), um zu bestätigen, dass die Seitenzahlen korrekt sind, insbesondere nach weiteren Änderungen.
• Das TOC-Optionen-Objekt wiederverwenden – Wenn Sie mehrere Dokumente in einem Batch erzeugen, konfigurieren Sie die Optionen einmal und verwenden Sie sie erneut, um den Overhead bei der Objekterstellung zu reduzieren.

Fazit

Das Hinzufügen eines Inhaltsverzeichnisses zu einem Word‑Dokument in Java wird mit Conholdate.Total for Java unkompliziert. Durch das Laden einer DOCX, das Konfigurieren von TableOfContentsOptions und das Einfügen des Feldes können Sie die Erstellung professioneller Berichte und Handbücher automatisieren. Denken Sie daran, das SDK zu installieren, den Best‑Practice‑Empfehlungen zu folgen und das erzeugte Inhaltsverzeichnis in Ihrer Zielumgebung zu testen. Für Produktionsbereitstellungen benötigen Sie eine lizenzierte Kopie; Preisinformationen finden Sie auf der Preisübersichtsseite und eine temporäre Lizenz kann über die temporäre Lizenzseite bezogen werden.

FAQs

• Was ist der einfachste Weg, ein Inhaltsverzeichnis zu einem Word‑Dokument in Java hinzuzufügen?
  Verwenden Sie DocumentBuilder.moveToDocumentStart() gefolgt von insertTableOfContents mit einem konfigurierten TableOfContentsOptions‑Objekt, wie im Codebeispiel gezeigt.

• Wie kann ich steuern, welche Überschriftsebenen im Inhaltsverzeichnis erscheinen?
  Setzen Sie setUpperHeadingLevel und setLowerHeadingLevel auf der TableOfContentsOptions-Instanz, um nur die gewünschten Ebenen einzuschließen.

• Ist es möglich, ein Inhaltsverzeichnis für eine Word‑Vorlage zu erzeugen, die später ausgefüllt wird?
  Ja. Fügen Sie das Inhaltsverzeichnis in die Vorlagendatei ein, bevor Sie dynamische Inhalte einfügen; das Inhaltsverzeichnis verweist dann automatisch auf die später hinzugefügten Überschriften.

• Brauche ich eine Internetverbindung, um dieses SDK zu verwenden?
  Nein. Conholdate.Total for Java ist eine lokale Bibliothek, die auf Ihrem Server oder Desktop läuft, ohne externe Serviceaufrufe.

Mehr lesen

• Formen zu PDF in Java hinzufügen
• Inhaltsverzeichnis in Word mit Java einfügen
• Ein Inhaltsverzeichnis in Word mit C# hinzufügen