Agregar encabezados y pies de página en PDF usando C## y IronPDF

¿Cómo puedo añadir encabezados/pies de página durante la renderización?

Como alternativa, puede añadir directamente un encabezado/pie utilizando las RenderingOptions del renderizador. Esto añade el encabezado y el pie de página del texto durante el proceso de renderizado, lo que resulta más eficaz que añadirlos una vez creado el PDF. Este enfoque es recomendable cuando se conoce de antemano el contenido del encabezado y el pie de página, ya que reduce el tiempo de procesamiento y garantiza un formato coherente desde el principio.

:path=/static-assets/pdf/content-code-examples/how-to/headers-and-footers-render-with-textheaderfooter.cs

using IronPdf;

// Instantiate renderer
ChromePdfRenderer renderer = new ChromePdfRenderer();

// Create header and add to rendering options
renderer.RenderingOptions.TextHeader = new TextHeaderFooter
{
    CenterText = "This is the header!",
};


// Create footer and add to rendering options
renderer.RenderingOptions.TextFooter = new TextHeaderFooter
{
    CenterText = "This is the footer!",
};

// Render PDF with header and footer
PdfDocument pdf = renderer.RenderHtmlAsPdf("<h1>Hello World!</h1>");
pdf.SaveAs("renderWithTextHeaderFooter.pdf");

¿Qué aspecto tiene el encabezado de texto personalizado?

¿Qué fuentes están disponibles por defecto?

Puede ver qué tipos de fuentes están disponibles por defecto en la Referencia de la API de IronPDF. IronPDF es compatible con una amplia gama de fuentes estándar, como Arial, Times New Roman, Helvetica, Courier y sus variantes. Si necesita fuentes personalizadas, obtenga más información sobre la gestión de fuentes en IronPDF.

¿Cómo aplico márgenes a través de las opciones de renderizado?

Si añade valores de margen en RenderingOptions de ChromePdfRenderer, estos márgenes también se aplicarán a la cabecera y al pie de página. Este enfoque proporciona una forma centralizada de gestionar los márgenes en todo el documento, incluidos los encabezados, los pies de página y el contenido principal. Para una personalización más avanzada de los márgenes, consulta nuestra guía sobre la configuración de márgenes personalizados.

:path=/static-assets/pdf/content-code-examples/how-to/headers-and-footers-rendering-options-margins.cs

using IronPdf;

// Instantiate renderer and create PDF
ChromePdfRenderer renderer = new ChromePdfRenderer();

TextHeaderFooter header = new TextHeaderFooter
{
    CenterText = "This is the header!",
};

TextHeaderFooter footer = new TextHeaderFooter
{
    CenterText = "This is the footer!",
};

// Margin values are in mm
renderer.RenderingOptions.MarginRight = 30;
renderer.RenderingOptions.MarginLeft = 30;
renderer.RenderingOptions.MarginTop = 25;
renderer.RenderingOptions.MarginBottom = 25;

// Add header and footer to renderer
renderer.RenderingOptions.TextHeader = header;
renderer.RenderingOptions.TextFooter = footer;

PdfDocument pdf = renderer.RenderHtmlAsPdf("<h1>Hello World!</h1>");

¿Por qué debería evitar UseMarginsOnHeaderAndFooter?

La propiedad UseMarginsOnHeaderAndFooter de RenderingOptions no es adecuada para este caso de uso. Aplica los mismos valores de margen al encabezado, pie de página y contenido principal, lo que puede causar que el encabezado se superponga con el cuerpo del documento. Esta propiedad está principalmente destinada a aplicar encabezados y pies de página a PDFs existentes usando el método AddTextHeadersAndFooters. Para controlar mejor la maquetación, considere la posibilidad de utilizar saltos de página para gestionar el flujo de contenidos.

¿Qué es el dimensionamiento dinámico de márgenes?

Los márgenes estáticos planteaban un problema cuando el contenido de las cabeceras variaba de un documento a otro. Hubo que hacer ajustes no solo en los márgenes de cabecera y pie de página, sino también en el margen HTML principal para adaptarse a los distintos tamaños de cabecera y pie de página. En consecuencia, hemos implementado una función de dimensionamiento dinámico de los márgenes en la que la altura de la cabecera y el pie de página se ajustan dinámicamente en función del contenido, y el HTML principal se reposiciona en consecuencia. Esta función es especialmente útil cuando se trabaja con diseños CSS adaptables. Utilice el código siguiente para probar esta función:

:path=/static-assets/pdf/content-code-examples/how-to/headers-and-footers-dynamic-marigns.cs

using IronPdf;

ChromePdfRenderer renderer = new ChromePdfRenderer();

renderer.RenderingOptions.HtmlHeader = new HtmlHeaderFooter()
{
    HtmlFragment = @"<div style='background-color: #4285f4; color: white; padding: 15px; text-align: center;'>
                    <h1>Example header</h1> <br>
                    <p>Header content</p>
                    </div>",
    // Enable the dynamic height feature
    MaxHeight = HtmlHeaderFooter.FragmentHeight,
};

PdfDocument pdf = renderer.RenderHtmlAsPdf("<h1>Main HTML content</h1>");
pdf.SaveAs("dynamicHeaderSize.pdf");

¿Qué marcadores de posición debo utilizar con más frecuencia?

Para obtener más información sobre {page} y {total-pages}, visite la Guía de números de página de IronPDF. Estos marcadores de posición son los más utilizados, ya que proporcionan información esencial para la navegación. Los marcadores de fecha y hora son especialmente útiles para documentos que necesitan un seguimiento de la fecha y hora, como informes o facturas.

:path=/static-assets/pdf/content-code-examples/how-to/headers-and-footers-mail-merge.cs

using IronPdf;

// Create header and footer
TextHeaderFooter textHeader = new TextHeaderFooter
{
    CenterText = "{page} of {total-pages}",
    LeftText = "Today's date: {date}",
    RightText = "The time: {time}",
};

TextHeaderFooter textFooter = new TextHeaderFooter
{
    CenterText = "Current URL: {url}",
    LeftText = "Title of the HTML: {html-title}",
    RightText = "Title of the PDF: {pdf-title}",
};

¿Cómo controlo los márgenes del encabezado/pie de página HTML?

Al igual que los encabezados y pies de página de texto, los métodos AddHtmlHeaders y AddHtmlFooters tienen márgenes predefinidos aplicados. Para aplicar márgenes personalizados, use una sobrecarga de las funciones con los valores de margen especificados. Para abarcar todo el contenido sin márgenes, establezca los márgenes en la función de sobrecarga en 0. Este nivel de control es esencial a la hora de crear documentos profesionales con requisitos de maquetación específicos.

:path=/static-assets/pdf/content-code-examples/how-to/headers-and-footers-htmlheaderfooter-margins.cs

// Add to PDF
pdf.AddHtmlHeaders(header, 0, 0, 0);
pdf.AddHtmlFooters(footer, 0, 0, 0);

¿Puedo añadir encabezados/pies de página HTML durante la renderización?

También se pueden añadir encabezados y pies de página directamente a través de las RenderingOptions del renderizador. Esto añade el encabezado y el pie de página HTML durante el proceso de renderización, lo que resulta más eficaz que el procesamiento posterior. Este método es especialmente útil cuando se generan PDF a partir de archivos HTML o conversiones de URL a PDF.

:path=/static-assets/pdf/content-code-examples/how-to/headers-and-footers-htmlheaderfooter.cs

using IronPdf;

string headerHtml = @"
    <html>
    <head>
        <link rel='stylesheet' href='style.css'>
    </head>
    <body>
        <h1>This is a header!</h1>
    </body>
    </html>";

string footerHtml = @"
    <html>
    <head>
        <link rel='stylesheet' href='style.css'>
    </head>
    <body>
        <h1>This is a footer!</h1>
    </body>
    </html>";

// Instantiate renderer and create PDF
ChromePdfRenderer renderer = new ChromePdfRenderer();
PdfDocument pdf = renderer.RenderHtmlAsPdf("<h1>Hello World!</h1>");

// Create header and footer
HtmlHeaderFooter htmlHeader = new HtmlHeaderFooter
{
    HtmlFragment = headerHtml,
    LoadStylesAndCSSFromMainHtmlDocument = true,
};

HtmlHeaderFooter htmlFooter = new HtmlHeaderFooter
{
    HtmlFragment = footerHtml,
    LoadStylesAndCSSFromMainHtmlDocument = true,
};

// Add to PDF
pdf.AddHtmlHeaders(htmlHeader);
pdf.AddHtmlFooters(htmlFooter);

¿Cuáles son las implicaciones para el rendimiento?

Las cabeceras y pies de página de texto se renderizan más rápido porque no requieren el análisis sintáctico de HTML ni el procesamiento de CSS. Las cabeceras/pies de página HTML ofrecen más flexibilidad, pero requieren un tiempo de renderizado adicional proporcional a su complejidad. Cuando se trabaja con documentos de gran tamaño o procesamiento por lotes, la diferencia de rendimiento se hace más notable. Para obtener un rendimiento óptimo en situaciones de gran volumen, tenga en cuenta nuestra guía sobre la generación asíncrona de PDF.

¿Listo para ver qué más puedes hacer? Consulte nuestra página de tutoriales aquí: Crear PDF