Añadir encabezado y pie de página en PDF con iTextSharp y IronPDF en C# con ejemplo

Cómo agregar encabezados y pies de página a documentos PDF en C

Añadir encabezados y pies de página a los documentos PDF es esencial para crear informes, facturas y documentos comerciales profesionales. Los desarrolladores que buscan soluciones de iTextSharp utilizando PdfPageEventHelper y el método OnEndPage encontrarán que las bibliotecas modernas de .NET ofrecen enfoques significativamente más simples para lograr los mismos resultados.

Esta guía demuestra cómo agregar encabezados y pies de página en archivos PDF usando C#, comparando el enfoque tradicional de iText 7 con la API concisa de IronPDF . Al final, comprenderás ambas implementaciones, desde crear un nuevo Document hasta generar el archivo PDF final, y podrás elegir el enfoque que mejor se adapte a los requerimientos de tu proyecto.

¿Por qué son importantes los encabezados y pies de página en documentos PDF?

Los encabezados y pies de página desempeñan funciones críticas en los documentos PDF profesionales. Las traducciones deben ser coherentes con la marca mediante logotipos de imágenes, permitir la navegación por páginas con números de página, mostrar metadatos importantes como fechas y títulos de documentos, y establecer la autenticidad del documento mediante marcas de tiempo e información sobre la versión.

En entornos empresariales, los encabezados y pies de página suelen tener importancia jurídica. Los informes financieros requieren marcas de tiempo para realizar auditorías. Los contratos necesitan una numeración de páginas para garantizar su integridad. Los documentos internos pueden requerir avisos de confidencialidad en cada página. Cumplir estos requisitos mediante programación requiere una biblioteca PDF que gestione de forma fiable la inyección de contenido a nivel de página.

Las razones principales para agregar encabezados y pies de página mediante programación incluyen:

• Cumplimiento de auditoría : las marcas de tiempo y los números de versión en cada página satisfacen los requisitos reglamentarios
• Coherencia de marca : los logotipos y el estilo de la empresa se aplican de manera uniforme en todos los documentos generados
• Navegación : los números de página y los títulos de las secciones ayudan a los lectores a localizar la información rápidamente.
• Autenticidad : el nombre del autor, la fecha de creación y la identificación del documento evitan disputas sobre la integridad del documento.

¿Cómo agregar un encabezado y pie de página de texto en C#?

IronPDF proporciona el enfoque más directo para agregar encabezados y pies de página a documentos PDF en aplicaciones .NET . Usando la clase ChromePdfRenderer combinada con TextHeaderFooter o HtmlHeaderFooter, se pueden generar encabezados y pies de página con código mínimo, sin necesidad de crear celdas separadas o gestionar manualmente un objeto contentbyte.

Antes de escribir cualquier código, agregue IronPDF a su proyecto usando NuGet:

Install-Package IronPdf
dotnet add package IronPdf

Install-Package IronPdf
dotnet add package IronPdf

La biblioteca no requiere dependencias externas y funciona inmediatamente después de su instalación. Está dirigido a .NET 5, 6, 7, 8 y 10, y se ejecuta en Windows, Linux y macOS sin configuración específica de la plataforma.

En patrones más antiguos de iTextSharp, los desarrolladores creaban métodos auxiliares como private static void AddContent() para inyectar manualmente la lógica de encabezados y pies de página. IronPDF elimina por completo la necesidad de este tipo de repeticiones.

A continuación se muestra un ejemplo completo que agrega un encabezado de texto y un pie de página a un archivo PDF:

using IronPdf;

// Initialize the PDF renderer
var renderer = new ChromePdfRenderer();

// Configure the text header
renderer.RenderingOptions.TextHeader = new TextHeaderFooter
{
    CenterText = "Quarterly Sales Report",
    DrawDividerLine = true,
    FontSize = 14
};

// Configure the text footer with page number and date
renderer.RenderingOptions.TextFooter = new TextHeaderFooter
{
    LeftText = "{date}",
    RightText = "Page {page} of {total-pages}",
    DrawDividerLine = true,
    FontSize = 10
};

// Set margins to accommodate header and footer
renderer.RenderingOptions.MarginTop = 25;
renderer.RenderingOptions.MarginBottom = 25;

// Generate PDF from HTML content
var pdf = renderer.RenderHtmlAsPdf("<h1>Sales Data</h1><p>Content goes here...</p>");
pdf.SaveAs("report-with-headers.pdf");

using IronPdf;

// Initialize the PDF renderer
var renderer = new ChromePdfRenderer();

// Configure the text header
renderer.RenderingOptions.TextHeader = new TextHeaderFooter
{
    CenterText = "Quarterly Sales Report",
    DrawDividerLine = true,
    FontSize = 14
};

// Configure the text footer with page number and date
renderer.RenderingOptions.TextFooter = new TextHeaderFooter
{
    LeftText = "{date}",
    RightText = "Page {page} of {total-pages}",
    DrawDividerLine = true,
    FontSize = 10
};

// Set margins to accommodate header and footer
renderer.RenderingOptions.MarginTop = 25;
renderer.RenderingOptions.MarginBottom = 25;

// Generate PDF from HTML content
var pdf = renderer.RenderHtmlAsPdf("<h1>Sales Data</h1><p>Content goes here...</p>");
pdf.SaveAs("report-with-headers.pdf");

Imports IronPdf

' Initialize the PDF renderer
Dim renderer = New ChromePdfRenderer()

' Configure the text header
renderer.RenderingOptions.TextHeader = New TextHeaderFooter With {
    .CenterText = "Quarterly Sales Report",
    .DrawDividerLine = True,
    .FontSize = 14
}

' Configure the text footer with page number and date
renderer.RenderingOptions.TextFooter = New TextHeaderFooter With {
    .LeftText = "{date}",
    .RightText = "Page {page} of {total-pages}",
    .DrawDividerLine = True,
    .FontSize = 10
}

' Set margins to accommodate header and footer
renderer.RenderingOptions.MarginTop = 25
renderer.RenderingOptions.MarginBottom = 25

' Generate PDF from HTML content
Dim pdf = renderer.RenderHtmlAsPdf("<h1>Sales Data</h1><p>Content goes here...</p>")
pdf.SaveAs("report-with-headers.pdf")

La clase TextHeaderFooter proporciona propiedades para posicionar texto a la izquierda, centro o derecha del área de encabezado o pie de página. La propiedad DrawDividerLine añade una línea de separación profesional entre el encabezado o pie de página y el contenido principal del documento. Los campos fusionables como {page}, {total-pages} y {date} se completan automáticamente con valores dinámicos durante la generación del PDF.

IronPDF maneja los cálculos de márgenes automáticamente, garantizando que los encabezados y pies de página no se superpongan con el contenido del documento. La clase TextHeaderFooter admite tipos de fuente de IronSoftware.Drawing.FontTypes, brindando control sobre la tipografía sin dependencias externas.

¿Cómo crear encabezados y pies de página con estilo HTML?

Para diseños más sofisticados, la clase HtmlHeaderFooter de IronPDF permite un estilo HTML y CSS completo. Este enfoque es particularmente valioso cuando los encabezados necesitan incluir un logotipo de imagen, diseños complejos o estilo específico de la marca, sin crear manualmente objetos PdfPCell ni utilizar constructores new Phrase.

using IronPdf;
using System;

var renderer = new ChromePdfRenderer();

// Create an HTML header with logo and styling
renderer.RenderingOptions.HtmlHeader = new HtmlHeaderFooter
{
    HtmlFragment = @"
        <div style='width: 100%; font-family: Arial, sans-serif;'>
            <img src='logo.png' style='height: 30px; float: left;' />
            <span style='float: right; font-size: 12px; color: #666;'>
                Confidential Document
            </span>
        </div>",
    MaxHeight = 25,
    DrawDividerLine = true,
    BaseUrl = new Uri(@"C:\assets\").AbsoluteUri
};

// Create an HTML footer with page numbering
renderer.RenderingOptions.HtmlFooter = new HtmlHeaderFooter
{
    HtmlFragment = @"
        <div style='text-align: center; font-size: 10px; color: #999;'>
            <span>Generated on {date} at {time}</span>
            <br/>
            <span>Page {page} of {total-pages}</span>
        </div>",
    MaxHeight = 20
};

renderer.RenderingOptions.MarginTop = 30;
renderer.RenderingOptions.MarginBottom = 25;

var pdf = renderer.RenderHtmlAsPdf("<h1>Project Proposal</h1><p>Document content...</p>");
pdf.SaveAs("styled-document.pdf");

using IronPdf;
using System;

var renderer = new ChromePdfRenderer();

// Create an HTML header with logo and styling
renderer.RenderingOptions.HtmlHeader = new HtmlHeaderFooter
{
    HtmlFragment = @"
        <div style='width: 100%; font-family: Arial, sans-serif;'>
            <img src='logo.png' style='height: 30px; float: left;' />
            <span style='float: right; font-size: 12px; color: #666;'>
                Confidential Document
            </span>
        </div>",
    MaxHeight = 25,
    DrawDividerLine = true,
    BaseUrl = new Uri(@"C:\assets\").AbsoluteUri
};

// Create an HTML footer with page numbering
renderer.RenderingOptions.HtmlFooter = new HtmlHeaderFooter
{
    HtmlFragment = @"
        <div style='text-align: center; font-size: 10px; color: #999;'>
            <span>Generated on {date} at {time}</span>
            <br/>
            <span>Page {page} of {total-pages}</span>
        </div>",
    MaxHeight = 20
};

renderer.RenderingOptions.MarginTop = 30;
renderer.RenderingOptions.MarginBottom = 25;

var pdf = renderer.RenderHtmlAsPdf("<h1>Project Proposal</h1><p>Document content...</p>");
pdf.SaveAs("styled-document.pdf");

Imports IronPdf
Imports System

Dim renderer As New ChromePdfRenderer()

' Create an HTML header with logo and styling
renderer.RenderingOptions.HtmlHeader = New HtmlHeaderFooter With {
    .HtmlFragment = "
        <div style='width: 100%; font-family: Arial, sans-serif;'>
            <img src='logo.png' style='height: 30px; float: left;' />
            <span style='float: right; font-size: 12px; color: #666;'>
                Confidential Document
            </span>
        </div>",
    .MaxHeight = 25,
    .DrawDividerLine = True,
    .BaseUrl = New Uri("C:\assets\").AbsoluteUri
}

' Create an HTML footer with page numbering
renderer.RenderingOptions.HtmlFooter = New HtmlHeaderFooter With {
    .HtmlFragment = "
        <div style='text-align: center; font-size: 10px; color: #999;'>
            <span>Generated on {date} at {time}</span>
            <br/>
            <span>Page {page} of {total-pages}</span>
        </div>",
    .MaxHeight = 20
}

renderer.RenderingOptions.MarginTop = 30
renderer.RenderingOptions.MarginBottom = 25

Dim pdf = renderer.RenderHtmlAsPdf("<h1>Project Proposal</h1><p>Document content...</p>")
pdf.SaveAs("styled-document.pdf")

Este código de ejemplo muestra cómo las cabeceras HTML pueden incorporar imágenes junto con el texto. La propiedad BaseUrl establece la ruta raíz para resolver URLs de imágenes relativas, facilitando la inclusión de logotipos de la empresa u otros gráficos. La propiedad MaxHeight asegura que el encabezado no exceda las dimensiones especificadas, manteniendo diseños de documentos consistentes.

Los campos fusionables ({page}, {total-pages}, {url}, {date}, {time}, {html-title}, {pdf-title}) funcionan de manera idéntica en encabezados y pies de página HTML, proporcionando inserciones de contenido dinámico sin código adicional. Para obtener orientación sobre cómo implementar varios estilos de encabezado, consulte la Guía práctica de encabezados y pies de página .

El enfoque HTML brilla al crear documentos de marca. Los equipos de marketing pueden proporcionar plantillas HTML que los desarrolladores integran directamente, garantizando una reproducción perfecta de los diseños aprobados. Las propiedades CSS como font-family, color, background-color y border funcionan como se espera, permitiendo tratamientos visuales sofisticados que requerirían un extenso código de bajo nivel en otras bibliotecas.

¿Cómo se pueden añadir encabezados a documentos PDF existentes?

Un requisito común implica agregar encabezados y pies de página a archivos PDF que ya existen, ya sean documentos cargados, archivos fusionados o PDF generados por otros sistemas. IronPDF maneja este escenario con los métodos AddHtmlHeaders y AddHtmlFooters.

using IronPdf;

// Load an existing PDF document
var pdf = PdfDocument.FromFile("customer-profile.pdf");

// Define the header to add
var header = new HtmlHeaderFooter
{
    HtmlFragment = "<div style='text-align: center;'>REVISED COPY - {date}</div>",
    MaxHeight = 20
};

// Define the footer to add
var footer = new HtmlHeaderFooter
{
    HtmlFragment = "<div style='text-align: right;'>Page {page}</div>",
    MaxHeight = 15
};

// Apply headers and footers to all pages
pdf.AddHtmlHeaders(header);
pdf.AddHtmlFooters(footer);
pdf.SaveAs("document-with-new-headers.pdf");

using IronPdf;

// Load an existing PDF document
var pdf = PdfDocument.FromFile("customer-profile.pdf");

// Define the header to add
var header = new HtmlHeaderFooter
{
    HtmlFragment = "<div style='text-align: center;'>REVISED COPY - {date}</div>",
    MaxHeight = 20
};

// Define the footer to add
var footer = new HtmlHeaderFooter
{
    HtmlFragment = "<div style='text-align: right;'>Page {page}</div>",
    MaxHeight = 15
};

// Apply headers and footers to all pages
pdf.AddHtmlHeaders(header);
pdf.AddHtmlFooters(footer);
pdf.SaveAs("document-with-new-headers.pdf");

Imports IronPdf

' Load an existing PDF document
Dim pdf = PdfDocument.FromFile("customer-profile.pdf")

' Define the header to add
Dim header As New HtmlHeaderFooter With {
    .HtmlFragment = "<div style='text-align: center;'>REVISED COPY - {date}</div>",
    .MaxHeight = 20
}

' Define the footer to add
Dim footer As New HtmlHeaderFooter With {
    .HtmlFragment = "<div style='text-align: right;'>Page {page}</div>",
    .MaxHeight = 15
}

' Apply headers and footers to all pages
pdf.AddHtmlHeaders(header)
pdf.AddHtmlFooters(footer)
pdf.SaveAs("document-with-new-headers.pdf")

La clase PdfDocument representa un PDF cargado o renderizado y proporciona métodos para modificaciones posteriores al renderizado. Esta separación entre renderización y modificación permite flujos de trabajo en los que los documentos PDF pasan por varias etapas de procesamiento. El método AddHtmlHeaders aplica automáticamente el encabezado a cada página, aunque también puedes dirigirte a páginas específicas pasando una colección de índices de página.

¿Cómo agregar diferentes encabezados en diferentes páginas?

Algunos documentos requieren que la primera página tenga un encabezado diferente (o ningún encabezado), mientras que las páginas posteriores utilizan un formato estándar. IronPDF permite esto a través de la aplicación de encabezados basada en índices de página, sin necesidad de verificar condiciones dentro de los manejadores void OnEndPage o gestionar contadores de bucles manualmente:

using IronPdf;
using System.Collections.Generic;
using System.Linq;
using System.Text;

var renderer = new ChromePdfRenderer();

// Build multi-page HTML with print page-breaks between pages
var pages = new List<string>
{
    "<section><h1>Title Page</h1><p>Intro text on page 1.</p></section>",
    "<section><h2>Report</h2><p>Detailed report content on page 2.</p></section>",
    "<section><h2>Appendix</h2><p>Appendix content on page 3.</p></section>"
};

var sb = new StringBuilder();
sb.AppendLine("<!doctype html><html><head><meta charset='utf-8'>");
sb.AppendLine("<style>");
sb.AppendLine("  body { font-family: Arial, sans-serif; margin: 20px; }");
sb.AppendLine("  .page-break { page-break-after: always; }");
sb.AppendLine("</style>");
sb.AppendLine("</head><body>");

for (int i = 0; i < pages.Count; i++)
{
    sb.AppendLine(pages[i]);
    if (i < pages.Count - 1)
        sb.AppendLine("<div class='page-break'></div>");
}
sb.AppendLine("</body></html>");

var pdf = renderer.RenderHtmlAsPdf(sb.ToString());

// Create the standard header for pages 2 onwards
var standardHeader = new HtmlHeaderFooter
{
    HtmlFragment = "<div style='text-align: center;'>Standard Header - Page {page}</div>",
    MaxHeight = 20
};

// Apply to all pages except the first (index 0)
var pageIndices = Enumerable.Range(1, pdf.PageCount - 1).ToList();
pdf.AddHtmlHeaders(standardHeader, 1, pageIndices);
pdf.SaveAs("document-skip-first-page-header.pdf");

using IronPdf;
using System.Collections.Generic;
using System.Linq;
using System.Text;

var renderer = new ChromePdfRenderer();

// Build multi-page HTML with print page-breaks between pages
var pages = new List<string>
{
    "<section><h1>Title Page</h1><p>Intro text on page 1.</p></section>",
    "<section><h2>Report</h2><p>Detailed report content on page 2.</p></section>",
    "<section><h2>Appendix</h2><p>Appendix content on page 3.</p></section>"
};

var sb = new StringBuilder();
sb.AppendLine("<!doctype html><html><head><meta charset='utf-8'>");
sb.AppendLine("<style>");
sb.AppendLine("  body { font-family: Arial, sans-serif; margin: 20px; }");
sb.AppendLine("  .page-break { page-break-after: always; }");
sb.AppendLine("</style>");
sb.AppendLine("</head><body>");

for (int i = 0; i < pages.Count; i++)
{
    sb.AppendLine(pages[i]);
    if (i < pages.Count - 1)
        sb.AppendLine("<div class='page-break'></div>");
}
sb.AppendLine("</body></html>");

var pdf = renderer.RenderHtmlAsPdf(sb.ToString());

// Create the standard header for pages 2 onwards
var standardHeader = new HtmlHeaderFooter
{
    HtmlFragment = "<div style='text-align: center;'>Standard Header - Page {page}</div>",
    MaxHeight = 20
};

// Apply to all pages except the first (index 0)
var pageIndices = Enumerable.Range(1, pdf.PageCount - 1).ToList();
pdf.AddHtmlHeaders(standardHeader, 1, pageIndices);
pdf.SaveAs("document-skip-first-page-header.pdf");

Imports IronPdf
Imports System.Collections.Generic
Imports System.Linq
Imports System.Text

Dim renderer As New ChromePdfRenderer()

' Build multi-page HTML with print page-breaks between pages
Dim pages As New List(Of String) From {
    "<section><h1>Title Page</h1><p>Intro text on page 1.</p></section>",
    "<section><h2>Report</h2><p>Detailed report content on page 2.</p></section>",
    "<section><h2>Appendix</h2><p>Appendix content on page 3.</p></section>"
}

Dim sb As New StringBuilder()
sb.AppendLine("<!doctype html><html><head><meta charset='utf-8'>")
sb.AppendLine("<style>")
sb.AppendLine("  body { font-family: Arial, sans-serif; margin: 20px; }")
sb.AppendLine("  .page-break { page-break-after: always; }")
sb.AppendLine("</style>")
sb.AppendLine("</head><body>")

For i As Integer = 0 To pages.Count - 1
    sb.AppendLine(pages(i))
    If i < pages.Count - 1 Then
        sb.AppendLine("<div class='page-break'></div>")
    End If
Next
sb.AppendLine("</body></html>")

Dim pdf = renderer.RenderHtmlAsPdf(sb.ToString())

' Create the standard header for pages 2 onwards
Dim standardHeader As New HtmlHeaderFooter With {
    .HtmlFragment = "<div style='text-align: center;'>Standard Header - Page {page}</div>",
    .MaxHeight = 20
}

' Apply to all pages except the first (index 0)
Dim pageIndices = Enumerable.Range(1, pdf.PageCount - 1).ToList()
pdf.AddHtmlHeaders(standardHeader, 1, pageIndices)
pdf.SaveAs("document-skip-first-page-header.pdf")

El segundo parámetro en AddHtmlHeaders especifica el número de página inicial para el campo fusionable {page}, mientras que el tercer parámetro acepta una colección de índices de página para recibir el encabezado. Este control granular permite diseñar documentos complejos sin una lógica condicional enrevesada. El ejemplo de Encabezados y pies de página avanzados cubre escenarios adicionales, incluida la diferenciación de páginas pares e impares.

¿Cómo implementar contenido dinámico más allá de los números de página?

El sistema de campos fusionables admite varios valores dinámicos que se completan automáticamente durante la representación. La siguiente tabla enumera todos los campos disponibles y sus significados: