Adicionar cabeçalho e rodapé em PDF usando iTextSharp e IronPDF em C# com exemplo

Adicionando cabeçalhos e rodapés a documentos PDF em C

Adicionar cabeçalhos e rodapés a documentos PDF é essencial para criar relatórios, faturas e documentos comerciais profissionais. Desenvolvedores que procuram soluções iTextSharp usando PdfPageEventHelper e o método OnEndPage descobrirão que as bibliotecas modernas do .NET oferecem abordagens significativamente mais simples para alcançar os mesmos resultados.

Este guia demonstra como adicionar cabeçalhos e rodapés em arquivos PDF usando C#, comparando a abordagem tradicional do iText 7 com a API concisa do IronPDF . No final, você compreenderá ambas as implementações -- desde a criação de um novo Document até a geração do arquivo PDF final -- e poderá escolher a abordagem que melhor se adapta aos requisitos do seu projeto.

Como adicionar cabeçalho e rodapé em PDF usando iTextSharp e IronPDF em C# com exemplo: Imagem 1 - IronPDF

Por que os cabeçalhos e rodapés de PDFs são importantes em documentos profissionais?

Cabeçalhos e rodapés desempenham funções essenciais em documentos PDF profissionais. Eles proporcionam uma identidade visual consistente por meio de logotipos com imagens, permitem a navegação entre páginas com números de página, exibem metadados importantes, como datas e títulos de documentos, e estabelecem a autenticidade do documento por meio de carimbos de data/hora e informações de versão.

Em ambientes corporativos, cabeçalhos e rodapés geralmente têm significado legal. Os relatórios financeiros exigem registros de data e hora para fins de auditoria. Os contratos precisam de numeração de páginas para garantir que estejam completos. Documentos internos podem exigir avisos de confidencialidade em todas as páginas. Para atender a esses requisitos programaticamente, é necessária uma biblioteca PDF que lide de forma confiável com a injeção de conteúdo em nível de página.

Os principais motivos para adicionar cabeçalhos e rodapés programaticamente incluem:

• Conformidade com auditorias -- os registros de data e hora e os números de versão em todas as páginas atendem aos requisitos regulamentares.
• Consistência da marca -- logotipos e estilo da empresa aplicados uniformemente em todos os documentos gerados.
• Navegação -- números de página e títulos de seção ajudam os leitores a localizar informações rapidamente
• Autenticidade -- o nome do autor, a data de criação e o ID do documento evitam disputas sobre a integridade do documento.

Como adicionar cabeçalho e rodapé em PDF usando iTextSharp e IronPDF em C# com exemplo: Imagem 2 - Recursos

Como adicionar um cabeçalho e rodapé de texto em C#?

O IronPDF oferece a abordagem mais direta para adicionar cabeçalhos e rodapés a documentos PDF em aplicações .NET . Usando a classe ChromePdfRenderer combinada com TextHeaderFooter ou HtmlHeaderFooter, você pode gerar cabeçalhos e rodapés com um mínimo de código -- não há necessidade de criar células separadas ou gerenciar um objeto contentbyte manualmente.

Antes de escrever qualquer código, adicione o IronPDF ao seu projeto usando o NuGet:

Install-Package IronPdf
dotnet add package IronPdf

Install-Package IronPdf
dotnet add package IronPdf

A biblioteca não requer dependências externas e funciona imediatamente após a instalação. É compatível com .NET 5, 6, 7, 8 e 10 e funciona em Windows, Linux e macOS sem necessidade de configuração específica da plataforma.

Em padrões mais antigos do iTextSharp, os desenvolvedores criavam métodos auxiliares como private static void AddContent() para injetar manualmente a lógica de cabeçalho e rodapé. O IronPDF elimina completamente a necessidade desse tipo de código repetitivo.

Aqui está um exemplo completo que adiciona um cabeçalho e um rodapé de texto a um arquivo 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")

A classe TextHeaderFooter fornece propriedades para posicionar texto à esquerda, centro ou direita da área de cabeçalho ou rodapé. A propriedade DrawDividerLine adiciona uma linha de separação profissional entre o cabeçalho ou rodapé e o conteúdo principal do documento. Campos mescláveis como {page}, {total-pages} e {date} são preenchidos automaticamente com valores dinâmicos durante a geração de PDF.

O IronPDF calcula as margens automaticamente, garantindo que cabeçalhos e rodapés não se sobreponham ao conteúdo do documento. A class TextHeaderFooter suporta tipos de fonte de IronSoftware.Drawing.FontTypes, dando a você controle sobre a tipografia sem dependências externas.

Como criar cabeçalhos e rodapés com estilo HTML?

Para designs mais sofisticados, a classe HtmlHeaderFooter do IronPDF permite estilização completa em HTML e CSS. Essa abordagem é particularmente valiosa quando os cabeçalhos precisam incluir um logotipo de imagem, layouts complexos ou estilo específico de marca -- sem criar objetos PdfPCell manualmente ou usar construtores 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 exemplo demonstra como os cabeçalhos HTML podem incorporar imagens juntamente com o texto. A propriedade BaseUrl estabelece o caminho raiz para resolver URLs de imagem relativos, facilitando a inclusão de logotipos de empresas ou outros gráficos. A propriedade MaxHeight garante que o cabeçalho não exceda as dimensões especificadas, mantendo layouts de documento consistentes.

Os campos mescláveis ({page}, {total-pages}, {url}, {date}, {time}, {html-title}, {pdf-title}) funcionam da mesma forma em cabeçalhos e rodapés HTML, fornecendo inserção de conteúdo dinâmico sem código adicional. Para obter orientações sobre como implementar vários estilos de cabeçalho, consulte o Guia Prático de Cabeçalhos e Rodapés .

A abordagem HTML se destaca na criação de documentos personalizados com a identidade visual da marca. As equipes de marketing podem fornecer modelos HTML que os desenvolvedores integram diretamente, garantindo a reprodução perfeita dos designs aprovados. Propriedades CSS como font-family, color, background-color e border funcionam conforme esperado, permitindo tratamentos visuais sofisticados que exigiriam código de baixo nível extensivo em outras bibliotecas.

Como adicionar cabeçalho e rodapé em PDF usando iTextSharp e IronPDF em C# com exemplo: Imagem 3 - Como adicionar cabeçalho e rodapé em PDF - IronPDF

Como adicionar cabeçalhos a documentos PDF existentes?

Uma necessidade comum envolve adicionar cabeçalhos e rodapés a arquivos PDF já existentes — sejam documentos carregados, arquivos mesclados ou PDFs gerados por outros sistemas. O IronPDF lida com esse cenário com os métodos AddHtmlHeaders e 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")

A classe PdfDocument representa um PDF carregado ou renderizado e fornece métodos para modificações pós-renderização. Essa separação entre renderização e modificação possibilita fluxos de trabalho em que documentos PDF passam por múltiplas etapas de processamento. O método AddHtmlHeaders aplica automaticamente o cabeçalho a todas as páginas, embora você também possa direcionar páginas específicas passando uma coleção de índices de página.

Como adicionar cabeçalhos diferentes em páginas diferentes?

Alguns documentos exigem que a primeira página tenha um cabeçalho diferente (ou nenhum cabeçalho), enquanto as páginas subsequentes utilizam um formato padrão. O IronPDF oferece suporte a isso através da aplicação de cabeçalhos baseados em índice de página -- não há necessidade de verificar condições dentro de manipuladores void OnEndPage ou gerenciar contadores de loop 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")

O segundo parâmetro em AddHtmlHeaders especifica o número da página inicial para o campo mesclável {page}, enquanto o terceiro parâmetro aceita uma coleção de índices de página para receber o cabeçalho. Esse controle granular permite layouts de documentos complexos sem lógica condicional intrincada. O exemplo de Cabeçalhos e Rodapés Avançados abrange cenários adicionais, incluindo a diferenciação entre páginas pares e ímpares.

Como implementar conteúdo dinâmico além da numeração de páginas?

O sistema de campos mescláveis ​​suporta diversos valores dinâmicos que são preenchidos automaticamente durante a renderização. A tabela a seguir lista todos os campos disponíveis e seus significados: