Ajouter un en-tête et un pied de page dans un PDF en utilisant iTextSharp et IronPDF en C# avec exemple

Ajout d'en-têtes et de pieds de page aux documents PDF en C

L'ajout d'en-têtes et de pieds de page aux documents PDF est essentiel pour créer des rapports, des factures et des documents commerciaux professionnels. Les développeurs à la recherche de solutions iTextSharp utilisant PdfPageEventHelper et la méthode OnEndPage constateront que les bibliothèques .NET modernes offrent des approches beaucoup plus simples pour obtenir les mêmes résultats.

Ce guide explique comment ajouter des en-têtes et des pieds de page dans les fichiers PDF en utilisant C#, en comparant l'approche traditionnelle d'iText 7 avec l'API concise d' IronPDF . À la fin, vous comprendrez les deux implémentations -- de la création d'un nouveau Document à la génération du fichier PDF final -- et vous pourrez choisir l'approche qui correspond le mieux aux exigences de votre projet.

Pourquoi les en-têtes et pieds de page PDF sont-ils importants dans les documents Professional ?

Les en-têtes et les pieds de page remplissent des fonctions essentielles dans les documents PDF professionnels. Ils assurent une image de marque cohérente grâce aux logos, facilitent la navigation grâce aux numéros de page, affichent des métadonnées importantes telles que les dates et les titres de documents, et établissent l'authenticité des documents grâce aux horodatages et aux informations de version.

Dans les environnements d'entreprise, les en-têtes et les pieds de page ont souvent une signification juridique. Les rapports financiers nécessitent des horodatages pour les pistes d'audit. Les contrats doivent être numérotés pour garantir leur exhaustivité. Les documents internes peuvent nécessiter des avis de confidentialité sur chaque page. Pour répondre à ces exigences au niveau programmatique, il faut une bibliothèque PDF qui gère de manière fiable l'injection de contenu au niveau de la page.

Les principales raisons d'ajouter des en-têtes et des pieds de page par programmation sont les suivantes :

• Conformité aux audits : les horodatages et les numéros de version sur chaque page satisfont aux exigences réglementaires
• Cohérence de la marque : logos et style de l'entreprise appliqués uniformément à tous les documents générés
• Navigation : les numéros de page et les titres des sections aident les lecteurs à trouver rapidement l'information.
• Authenticité : le nom de l'auteur, la date de création et l'identifiant du document préviennent les litiges relatifs à son intégrité.

Comment ajouter un en-tête et un pied de page de texte en C# ?

IronPDF offre la méthode la plus directe pour ajouter des en-têtes et des pieds de page aux documents PDF dans les applications .NET . En utilisant la classe ChromePdfRenderer combinée avec TextHeaderFooter ou HtmlHeaderFooter, vous pouvez générer des en-têtes et des pieds de page avec un minimum de code - pas besoin de créer des cellules séparées ni de gérer manuellement un objet contentbyte.

Avant d'écrire le moindre code, ajoutez IronPDF à votre projet à l'aide de NuGet:

Install-Package IronPdf
dotnet add package IronPdf

Install-Package IronPdf
dotnet add package IronPdf

La bibliothèque ne nécessite aucune dépendance externe et fonctionne immédiatement après son installation. Il cible .NET 5, 6, 7, 8 et 10 et fonctionne sous Windows, Linux et macOS sans configuration spécifique à la plateforme.

Dans les anciens modèles iTextSharp, les développeurs créaient des méthodes d'assistance telles que private static void AddContent() pour injecter manuellement la logique d'en-tête et de pied de page. IronPDF élimine totalement la nécessité d'utiliser ce type de texte passe-partout.

Voici un exemple complet qui ajoute un en-tête et un pied de page à un fichier 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 classe TextHeaderFooter fournit des propriétés pour positionner le texte à gauche, au centre ou à droite de la zone d'en-tête ou de pied de page. La propriété DrawDividerLine ajoute une ligne de séparation Professional entre l'en-tête ou le pied de page et le contenu principal du document. Les champs fusionnables comme {page}, {total-pages} et {date} se remplissent automatiquement avec des valeurs dynamiques lors de la génération du PDF.

IronPDF gère automatiquement les calculs de marges, garantissant ainsi que les en-têtes et les pieds de page ne chevauchent pas le contenu de votre document. La classe TextHeaderFooter prend en charge les types de polices de IronSoftware.Drawing.FontTypes, vous donnant le contrôle sur la typographie sans dépendances externes.

Comment créer des en-têtes et des pieds de page au format HTML ?

Pour des designs plus sophistiqués, la classe HtmlHeaderFooter d'IronPDF permet une mise en forme HTML et CSS complète. Cette approche est particulièrement précieuse lorsque les en-têtes doivent inclure un logo image, des mises en page complexes ou un style spécifique à la marque, sans créer manuellement des objets PdfPCell ou utiliser des constructeurs 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")

Cet exemple de code montre comment les en-têtes HTML peuvent incorporer des images à côté du texte. La propriété BaseUrl établit le chemin racine pour la résolution des URL d'images relatives, ce qui simplifie l'inclusion des logos d'entreprise ou d'autres graphiques. La propriété MaxHeight garantit que l'en-tête ne dépasse pas les dimensions spécifiées, maintenant ainsi des mises en page de document cohérentes.

Les champs fusionnables ({page}, {total-pages}, {url}, {date}, {time}, {html-title}, {pdf-title}) fonctionnent de manière identique dans les en-têtes et les pieds de page HTML, permettant l'insertion dynamique de contenu sans code supplémentaire. Pour obtenir des conseils sur la mise en œuvre de différents styles d'en-tête, consultez le guide pratique En-têtes et pieds de page .

L'approche HTML excelle dans la création de documents de marque. Les équipes marketing peuvent fournir des modèles HTML que les développeurs intègrent directement, garantissant ainsi une reproduction au pixel près des conceptions approuvées. Les propriétés CSS comme font-family, color, background-color et border fonctionnent comme prévu, permettant des traitements visuels sophistiqués qui nécessiteraient un code de bas niveau important dans d'autres bibliothèques.

Comment ajouter des en-têtes à des documents PDF existants ?

Une exigence courante consiste à ajouter des en-têtes et des pieds de page aux fichiers PDF existants, qu'il s'agisse de documents téléchargés, de fichiers fusionnés ou de PDF générés par d'autres systèmes. IronPDF gère ce scénario avec les méthodes AddHtmlHeaders et 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 classe PdfDocument représente un PDF chargé ou rendu et fournit des méthodes pour les modifications post-rendu. Cette séparation entre le rendu et la modification permet des flux de travail où les documents PDF passent par plusieurs étapes de traitement. La méthode AddHtmlHeaders applique automatiquement l'en-tête à chaque page, bien que vous puissiez également cibler des pages spécifiques en passant une collection d'index de page.

Comment ajouter des en-têtes différents sur des pages différentes ?

Certains documents exigent que la première page comporte un en-tête différent (ou pas d'en-tête du tout), tandis que les pages suivantes utilisent un format standard. IronPDF prend en charge cette fonctionnalité grâce à l'application d'en-têtes basée sur l'index de page ; il n'est pas nécessaire de vérifier les conditions à l'intérieur des gestionnaires void OnEndPage ni de gérer manuellement les compteurs de boucle :

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")

Le deuxième paramètre dans AddHtmlHeaders spécifie le numéro de page de départ pour le champ fusionnable {page}, tandis que le troisième paramètre accepte une collection d'indices de page pour recevoir l'en-tête. Ce contrôle granulaire permet des mises en page de documents complexes sans logique conditionnelle alambiquée. L' exemple des en-têtes et pieds de page avancés couvre des scénarios supplémentaires, notamment la différenciation des pages paires/impaires.

Comment mettre en œuvre un contenu dynamique au-delà des numéros de page ?

Le système de champs fusionnables prend en charge plusieurs valeurs dynamiques qui se remplissent automatiquement lors du rendu. Le tableau suivant répertorie tous les champs disponibles et leur signification :