Hinzufügen von Kopf- und Fußzeilen in PDF mit iTextSharp und IronPDF in C# mit Beispiel

Hinzufügen von Kopf- und Fußzeilen zu PDF-Dokumenten in C

Das Hinzufügen von Kopf- und Fußzeilen zu PDF-Dokumenten ist für die Erstellung professioneller Berichte, Rechnungen und Geschäftsdokumente unerlässlich. Entwickler, die nach iTextSharp-Lösungen mit der Methode PdfPageEventHelper und der Methode OnEndPage suchen, werden feststellen, dass moderne .NET Bibliotheken wesentlich einfachere Ansätze bieten, um die gleichen Ergebnisse zu erzielen.

Dieser Leitfaden zeigt, wie man mit C# Kopf- und Fußzeilen in PDF-Dateien einfügt und vergleicht dabei den traditionellen Ansatz von iText 7 mit der prägnanten API von IronPDF . Am Ende werden Sie beide Implementierungen verstehen – von der Erstellung eines neuen Document bis zur Generierung der endgültigen PDF-Datei – und können den Ansatz wählen, der am besten zu Ihren Projektanforderungen passt.

Warum sind PDF-Kopf- und Fußzeilen in Professional Dokumenten wichtig?

Kopf- und Fußzeilen haben in professionellen PDF-Dokumenten eine wichtige Funktion. Sie sorgen für ein konsistentes Branding durch Bildlogos, ermöglichen die Seitennavigation mit Seitenzahlen, zeigen wichtige Metadaten wie Datumsangaben und Dokumententitel an und stellen die Authentizität des Dokuments durch Zeitstempel und Versionsinformationen sicher.

In Unternehmensumgebungen haben Kopf- und Fußzeilen oft eine rechtliche Bedeutung. Bei Finanzberichten sind Zeitstempel für Prüfpfade erforderlich. Die Verträge benötigen eine Seitennummerierung, um die Vollständigkeit zu gewährleisten. Interne Dokumente erfordern möglicherweise Vertraulichkeitshinweise auf jeder Seite. Um diese Anforderungen programmatisch zu erfüllen, ist eine PDF-Bibliothek erforderlich, die die Einfügung von Inhalten auf Seitenebene zuverlässig handhabt.

Wichtige Gründe für das programmatische Hinzufügen von Kopf- und Fußzeilen sind:

• Einhaltung der Prüfvorschriften – Zeitstempel und Versionsnummern auf jeder Seite erfüllen die regulatorischen Anforderungen
• Markenkonsistenz – Firmenlogos und -design werden einheitlich auf alle erstellten Dokumente angewendet.
• Navigation – Seitenzahlen und Abschnittsüberschriften helfen Lesern, Informationen schnell zu finden
• Authentizität – Name des Autors, Erstellungsdatum und Dokumenten-ID verhindern Streitigkeiten über die Integrität des Dokuments.

Wie fügt man in C# eine Textkopf- und -fußzeile hinzu?

IronPDF bietet den direktesten Ansatz zum Hinzufügen von Kopf- und Fußzeilen zu PDF-Dokumenten in .NET Anwendungen. Durch die Verwendung der Klasse ChromePdfRenderer in Kombination mit entweder TextHeaderFooter oder HtmlHeaderFooter können Sie Kopf- und Fußzeilen mit minimalem Code generieren – es ist nicht erforderlich, separate Zellen zu erstellen oder ein contentbyte-Objekt manuell zu verwalten.

Bevor Sie mit dem Programmieren beginnen, fügen Sie IronPDF mithilfe von NuGet zu Ihrem Projekt hinzu:

Install-Package IronPdf
dotnet add package IronPdf

Install-Package IronPdf
dotnet add package IronPdf

Die Bibliothek erfordert keine externen Abhängigkeiten und funktioniert sofort nach der Installation. Es zielt auf .NET 5, 6, 7, 8 und 10 ab und läuft unter Windows, Linux und macOS ohne plattformspezifische Konfiguration.

In älteren iTextSharp-Mustern erstellten Entwickler Hilfsmethoden wie private static void AddContent(), um Kopf- und Fußzeilenlogik manuell einzufügen. IronPDF macht derartige Floskeln völlig überflüssig.

Hier ist ein vollständiges Beispiel, das sowohl eine Textkopfzeile als auch eine Textfußzeile zu einer PDF-Datei hinzufügt:

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

Die Klasse TextHeaderFooter bietet Eigenschaften zum Positionieren von Text links, mittig oder rechts im Kopf- oder Fußzeilenbereich. Die Eigenschaft DrawDividerLine fügt eine Professional Trennlinie zwischen Kopf- oder Fußzeile und dem Hauptdokumentinhalt ein. Zusammenführbare Felder wie {page}, {total-pages} und {date} werden während der PDF-Generierung automatisch mit dynamischen Werten befüllt.

IronPDF übernimmt die Berechnung der Ränder automatisch und stellt so sicher, dass Kopf- und Fußzeilen nicht mit dem Dokumentinhalt überlappen. Die Klasse TextHeaderFooter unterstützt Schriftarten von IronSoftware.Drawing.FontTypes, wodurch Sie die Typografie ohne externe Abhängigkeiten steuern können.

Wie erstellt man Kopf- und Fußzeilen im HTML-Stil?

Für anspruchsvollere Designs ermöglicht die HtmlHeaderFooter-Klasse von IronPDF die vollständige HTML- und CSS-Formatierung. Dieser Ansatz ist besonders wertvoll, wenn Header ein Bildlogo, komplexe Layouts oder markenspezifische Stile enthalten müssen – ohne dass manuell PdfPCell Objekte erstellt oder new Phrase Konstruktoren verwendet werden müssen.

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

Dieses Codebeispiel zeigt, wie HTML-Kopfzeilen neben Text auch Bilder enthalten können. Die Eigenschaft BaseUrl legt den Stammpfad für die Auflösung relativer Bild-URLs fest und vereinfacht so das Einbinden von Firmenlogos oder anderen Grafiken. Die Eigenschaft MaxHeight stellt sicher, dass die Kopfzeile die festgelegten Abmessungen nicht überschreitet und somit ein einheitliches Dokumentlayout gewährleistet ist.

Die zusammenführbaren Felder ({page}, {total-pages}, {url}, {date}, {time}, {html-title}, {pdf-title}) funktionieren in HTML-Kopf- und Fußzeilen identisch und ermöglichen das dynamische Einfügen von Inhalten ohne zusätzlichen Code. Hinweise zur Implementierung verschiedener Header-Stile finden Sie im Leitfaden "Headers and Footers How-To Guide" .

Der HTML-Ansatz spielt seine Stärken besonders bei der Erstellung von Dokumenten mit Markenlogo aus. Marketingteams können HTML-Vorlagen bereitstellen, die von den Entwicklern direkt integriert werden können, um eine pixelgenaue Reproduktion der genehmigten Designs zu gewährleisten. CSS-Eigenschaften wie font-family, color, background-color und border funktionieren wie erwartet und ermöglichen anspruchsvolle visuelle Darstellungen, die in anderen Bibliotheken umfangreichen Low-Level-Code erfordern würden.

Wie kann man Kopfzeilen zu bestehenden PDF-Dokumenten hinzufügen?

Eine häufige Anforderung besteht darin, bereits existierenden PDF-Dateien Kopf- und Fußzeilen hinzuzufügen – egal ob es sich um hochgeladene Dokumente, zusammengeführte Dateien oder von anderen Systemen generierte PDFs handelt. IronPDF behandelt dieses Szenario mit den Methoden AddHtmlHeaders und 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")

Die Klasse PdfDocument repräsentiert ein geladenes oder gerendertes PDF und bietet Methoden für Änderungen nach dem Rendern. Diese Trennung zwischen Rendering und Modifikation ermöglicht Arbeitsabläufe, bei denen PDF-Dokumente mehrere Verarbeitungsstufen durchlaufen. Die Methode AddHtmlHeaders wendet den Header automatisch auf jede Seite an. Sie können aber auch bestimmte Seiten ansprechen, indem Sie eine Sammlung von Seitenindizes übergeben.

Wie fügt man auf verschiedenen Seiten unterschiedliche Überschriften hinzu?

Bei manchen Dokumenten muss die erste Seite eine andere Kopfzeile haben (oder gar keine Kopfzeile), während die nachfolgenden Seiten ein Standardformat verwenden. IronPDF unterstützt dies durch eine seitenindexbasierte Header-Anwendung – es ist nicht erforderlich, Bedingungen innerhalb von void OnEndPage Handlern zu prüfen oder Schleifenzähler manuell zu verwalten:

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

Der zweite Parameter in AddHtmlHeaders gibt die Startseitennummer für das zusammenführbare Feld {page} an, während der dritte Parameter eine Sammlung von Seitenindizes akzeptiert, um den Header zu empfangen. Diese granulare Steuerung ermöglicht komplexe Dokumentenlayouts ohne komplizierte bedingte Logik. Das Beispiel "Erweiterte Kopf- und Fußzeilen" behandelt weitere Szenarien, darunter die Unterscheidung zwischen geraden und ungeraden Seiten.

Wie implementiert man dynamische Inhalte über Seitenzahlen hinaus?

Das System der zusammenführbaren Felder unterstützt mehrere dynamische Werte, die während des Renderns automatisch eingefügt werden. Die folgende Tabelle listet alle verfügbaren Felder und ihre Bedeutungen auf: