Ejemplo completo de funcionamiento para agregar tabla de contenido a un documento Word en Java

El siguiente ejemplo muestra cómo insertar una tabla de contenido en un archivo DOCX existente utilizando 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);
        }
    }
}

Nota: Este ejemplo de código demuestra la funcionalidad principal. Antes de usarlo en su proyecto, asegúrese de actualizar las rutas de los archivos (input.docx, output.docx, etc.) para que coincidan con sus ubicaciones reales, verifique que todas las dependencias requeridas estén correctamente instaladas y pruebe exhaustivamente en su entorno de desarrollo. Si encuentra algún problema, consulte la documentación oficial o póngase en contacto con el equipo de soporte para obtener ayuda.

Comprender la adición de tabla de contenido a documento Word en código Java

A continuación se muestra un desglose de los pasos principales realizados por el código de ejemplo:

1. Cargar el documento de origen - La clase Document lee el archivo DOCX existente.

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

2. Crear un DocumentBuilder - DocumentBuilder proporciona métodos para editar el contenido del documento.

DocumentBuilder builder = new DocumentBuilder(doc);

3. Posicionar el cursor - moveToDocumentStart() mueve el punto de inserción al comienzo del archivo, asegurando que el TOC aparezca antes de cualquier contenido.

   builder.moveToDocumentStart();
   

4. Configurar opciones de TOC - TableOfContentsOptions le permite definir los niveles de encabezado, la alineación de los números de página, el uso de hipervínculos y el estilo del líder de tabulación.

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

La referencia detallada de la API está disponible en la página API Reference .

5. Insertar el índice y guardar - insertTableOfContents agrega el campo, y doc.save escribe el archivo actualizado en formato DOCX.

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

Instalación y configuración de Conholdate.Total for Java

Agregue el repositorio Maven de Conholdate y la dependencia del SDK a su 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>

Descargue el paquete SDK más reciente desde la página de descarga. El SDK requiere Java 8 o superior y se ejecuta en cualquier JVM estándar. No se necesitan componentes de tiempo de ejecución adicionales.

Mejores prácticas para generar la tabla de contenido de Word con Java

• Utilice estilos de encabezado consistentes - La tabla de contenido (TOC) detecta los párrafos con estilos de encabezado incorporados (Encabezado 1, Encabezado 2, etc.). Asegúrese de que su documento fuente utilice estos estilos para una generación fiable de entradas.
• Limite la profundidad de los encabezados - Incluir demasiados niveles puede hacer que la tabla de contenido sea difícil de manejar. Los informes típicos usan los niveles 1‑3, como se muestra en el ejemplo.
• Habilite los hipervínculos - Configurar setUseHyperlinks(true) crea entradas clicables, mejorando la navegación en el documento final.
• Valide después de la inserción - Abra el DOCX generado y actualice los campos (Ctrl +A, F9) para confirmar que los números de página son correctos, especialmente después de ediciones adicionales.
• Reutilice el objeto de opciones de la tabla de contenido - Si genera varios documentos en lote, configure las opciones una vez y reutilícelas para reducir la sobrecarga de creación de objetos.

Conclusión

Agregar una tabla de contenido a un documento Word en Java se vuelve sencillo con Conholdate.Total for Java. Al cargar un DOCX, configurar TableOfContentsOptions e insertar el campo, puedes automatizar la creación de informes y manuales profesionales. Recuerda instalar el SDK, seguir las recomendaciones de buenas prácticas y probar la tabla de contenido generada en tu entorno objetivo. Para implementaciones en producción necesitarás una copia con licencia; los detalles de precios están disponibles en la página de precios y una licencia temporal se puede obtener en la página de licencia temporal.

Preguntas frecuentes

• ¿Cuál es la forma más sencilla de agregar una tabla de contenido a un documento Word en Java?
  Utilice DocumentBuilder.moveToDocumentStart() seguido de insertTableOfContents con un objeto TableOfContentsOptions configurado, como se muestra en el ejemplo de código.

• ¿Cómo puedo controlar qué niveles de encabezado aparecen en el TOC?
  Establezca setUpperHeadingLevel y setLowerHeadingLevel en la instancia de TableOfContentsOptions para incluir solo los niveles deseados.

• ¿Es posible generar un TOC para una plantilla de Word que se completará más tarde?
  Sí. Inserte el TOC en el archivo de plantilla antes de rellenar el contenido dinámico; el TOC hará referencia automáticamente a los encabezados añadidos posteriormente.

• ¿Necesito una conexión a internet para usar este SDK?
  No. Conholdate.Total for Java es una biblioteca local que se ejecuta en su servidor o escritorio sin llamadas a servicios externos.

Leer más

• Agregar formas a PDF en Java
• Insertar tabla de contenido en Word usando Java
• Agregar una tabla de contenido en Word usando C#