Working with PDF Headers and Footers

Essential^® PDF supports to draw the header and footer in PDF document using PdfPageTemplateElement class. The header and footer can contain any types of element including dynamic fields.

To quickly get started with adding headers and footers to PDF files using the Syncfusion^® PDF library for .NET, refer to this video tutorial:

Adding an automatic field in header and footer

Essential^® PDF supports to add page count, page numbers, date and time using dynamic fields such as PdfPageCountField, PdfPageNumberField etc.

The below code snippet explains how to draw the page numbers in footer using automatic fields.

C# [Cross-platform]

//Create a new PDF document.
PdfDocument pdfDocument = new PdfDocument();
//Add a page to the PDF document
PdfPage pdfPage = pdfDocument.Pages.Add();
//Create a header and draw the image.
RectangleF bounds = new RectangleF(0, 0, pdfDocument.Pages[0].GetClientSize().Width, 50);
PdfPageTemplateElement header = new PdfPageTemplateElement(bounds);
//Load the PDF document
FileStream imageStream = new FileStream("Logo.png", FileMode.Open, FileAccess.Read);
PdfImage image = new PdfBitmap(imageStream);
//Draw the image in the header.
header.Graphics.DrawImage(image, new PointF(0, 0), new SizeF(100, 50));
//Add the header at the top.
pdfDocument.Template.Top = header;
//Create a Page template that can be used as footer.
PdfPageTemplateElement footer = new PdfPageTemplateElement(bounds);
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 7);
PdfBrush brush = new PdfSolidBrush(Color.Black);
//Create page number field.
PdfPageNumberField pageNumber = new PdfPageNumberField(font, brush);
//Create page count field.
PdfPageCountField count = new PdfPageCountField(font, brush);
//Add the fields in composite fields.
PdfCompositeField compositeField = new PdfCompositeField(font, brush, "Page {0} of {1}", pageNumber, count);
compositeField.Bounds = footer.Bounds;
//Draw the composite field in footer.
compositeField.Draw(footer.Graphics, new PointF(470, 40));
//Add the footer template at the bottom.
pdfDocument.Template.Bottom = footer;

//Save the document into stream.
MemoryStream stream = new MemoryStream();
pdfDocument.Save(stream);
//Closes the document.
pdfDocument.Close(true);

C# [Windows-specific]

//Create a new PDF document.
PdfDocument pdfDocument = new PdfDocument();
//Add a page to the PDF document
PdfPage pdfPage = pdfDocument.Pages.Add();
//Create a header and draw the image.
RectangleF bounds = new RectangleF(0, 0, pdfDocument.Pages[0].GetClientSize().Width, 50);
PdfPageTemplateElement header = new PdfPageTemplateElement(bounds);
PdfImage image = new PdfBitmap(@"Logo.png");
//Draw the image in the header.
header.Graphics.DrawImage(image, new PointF(0, 0), new SizeF(100, 50));
//Add the header at the top.
pdfDocument.Template.Top = header;
//Create a Page template that can be used as footer.
PdfPageTemplateElement footer = new PdfPageTemplateElement(bounds);
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 7);
PdfBrush brush = new PdfSolidBrush(Color.Black);
//Create page number field.
PdfPageNumberField pageNumber = new PdfPageNumberField(font, brush);
//Create page count field.
PdfPageCountField count = new PdfPageCountField(font, brush);
//Add the fields in composite fields.
PdfCompositeField compositeField = new PdfCompositeField(font, brush, "Page {0} of {1}", pageNumber, count);
compositeField.Bounds = footer.Bounds;
//Draw the composite field in footer.
compositeField.Draw(footer.Graphics, new PointF(470, 40));
//Add the footer template at the bottom.
pdfDocument.Template.Bottom = footer;

//Save and close the document.
pdfDocument.Save("Output.pdf");
pdfDocument.Close(true);

VB.NET [Windows-specific]

'Create a new PDF document.
Dim pdfDocument As New PdfDocument()
'Add a page to the PDF document.
Dim pdfPage As PdfPage = pdfDocument.Pages.Add()
'Create a header and draw the image.
Dim bounds As New RectangleF(0, 0, pdfDocument.Pages(0).GetClientSize().Width, 50)
Dim header As New PdfPageTemplateElement(bounds)
Dim image As PdfImage = New PdfBitmap("Logo.jpg")
'Draw the image in the Header.
header.Graphics.DrawImage(image, New PointF(0, 0), New SizeF(100, 50))
'Add the header at the top.
pdfDocument.Template.Top = header
'Create a page template that can be used as footer.
Dim footer As New PdfPageTemplateElement(bounds)
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Helvetica, 7)
Dim brush As PdfBrush = New PdfSolidBrush(Color.Black)
'Create page number field.
Dim pageNumber As New PdfPageNumberField(font, brush)
'Create page count field.
Dim count As New PdfPageCountField(font, brush)
'Add the fields in composite fields.
Dim compositeField As New PdfCompositeField(font, brush, "Page {0} of {1}", pageNumber, count)
compositeField.Bounds = footer.Bounds
'Draw the composite field in footer.
compositeField.Draw(footer.Graphics, New PointF(470, 40))
'Add the footer template at the bottom.
pdfDocument.Template.Bottom = footer

'Save and close the document.
pdfDocument.Save("Output.pdf")
pdfDocument.Close(True)

You can download a complete working sample from GitHub.

Adding dynamic headers and footers in PDF documents

You can add unique, dynamic headers and footers like page numbers or dates to each page in a PDF by handling the PageAdded event. By also using the BeginPageLayout event to reserve space, you ensure your main content doesn’t overlap with headers or footers.

The example below illustrates how to implement a dynamic footer that updates uniquely for every page in a PDF document.

C# [Cross-platform]

// Create a new PDF document.
PdfDocument document = new PdfDocument();

// Subscribe to the PageAdded event to add header and footer for every page.
document.Pages.PageAdded += (sender, e) => PageAddedHandler(sender, e);

// Define content font and brush for main text.
PdfFont contentFont = new PdfStandardFont(PdfFontFamily.TimesRoman, 18);
PdfBrush contentBrush = new PdfSolidBrush(Color.Black);

// Define the main instructional text.
string overflowText =
@"Creating PDF documentation programmatically with Syncfusion .NET libraries enables automation of reports, invoices, and technical manuals.

Key Features:
- Multi-page automatic content flow using pagination
- Support for rich text formatting: headers, bullets, and tables
- Insert images, tables, and charts seamlessly
- Add interactive elements: bookmarks, hyperlinks, and attachments
- Control layout: margins, page breaks, and dynamic footers

Usage Example:
This project demonstrates how to paginate multiple paragraphs of text describing PDF functionality. When the content exceeds a single page, Syncfusion’s PdfTextElement automatically creates new pages and triggers the PageAdded event. This allows you to attach custom footers, such as page numbers or custom codes, to each page for improved navigation and professional document appearance.

Adding dynamic footers is useful for:
- Section labeling in large documents
- Including secure or traceable codes for each page
- Ensuring readers always know their page context

Other advanced scenarios:
- Creating Table of Contents with page navigation
- Inserting named destinations for quick jumps
- Using graphics and interactive elements within the same document

Experiment by updating this program to add headers, watermarks, or section-based page numbers based on your specific requirements.

For more information, visit:
https://help.syncfusion.com/file-formats/pdf/working-with-text
https://help.syncfusion.com/file-formats/pdf/working-with-graphics

This concludes the instructional workflow for auto-paginated, footer-enhanced PDF generation in .NET.";

// Set the header and footer height
float headerHeight = 40f;
float footerHeight = 30f;

// Create a text element for automatic pagination.
PdfTextElement textElement = new PdfTextElement(overflowText, contentFont, contentBrush);

// Subscribe to the BeginPageLayout event to offset text on each new page below the header.
textElement.BeginPageLayout += (sender, args) =>
{
    // Always start content below the header on every page.
    args.Bounds = new RectangleF(
        0, headerHeight,
        args.Page.GetClientSize().Width,
        args.Page.GetClientSize().Height - headerHeight - footerHeight
    );
};

// Add the first page.
PdfPage firstPage = document.Pages.Add();

// Start drawing content (pagination and event will handle the rest).
textElement.Draw(firstPage, new PointF(0, headerHeight));

// Save and close the document.
using (FileStream outputFileStream = new FileStream(Path.GetFullPath(@"Output/Output.pdf"), FileMode.Create, FileAccess.Write))
{
    document.Save(outputFileStream);
}
document.Close(true);

// Add header and footer to every page.
static void PageAddedHandler(object sender, PageAddedEventArgs e)
{
    PdfPage page = e.Page;
    int currentPage = page.Section.Pages.IndexOf(page) + 1;

    // Draw header at the top (within reserved header bounds).
    string headerText = $"This is the header - Page {currentPage}";
    page.Graphics.DrawString(
        headerText,
        new PdfStandardFont(PdfFontFamily.Helvetica, 14, PdfFontStyle.Bold),
        new PdfSolidBrush(Color.DimGray),
        new PointF(10, 10) // Within header area
    );

    // Draw footer at the bottom (within reserved footer area).
    string timestamp = DateTime.Now.ToString("'Date:' yyyy-MM-dd 'Time:' HH:mm:ss");
    string footerText = $"Page {currentPage} {timestamp}";
    page.Graphics.DrawString(
        footerText,
        new PdfStandardFont(PdfFontFamily.Helvetica, 12),
        new PdfSolidBrush(Color.Black),
        new PointF(10, page.GetClientSize().Height - 30)
    );
}

C# [Windows-specific]

// Create a new PDF document.
PdfDocument document = new PdfDocument();

// Subscribe to the PageAdded event to add header and footer for every page.
document.Pages.PageAdded += (sender, e) => PageAddedHandler(sender, e);

// Define content font and brush for main text.
PdfFont contentFont = new PdfStandardFont(PdfFontFamily.TimesRoman, 18);
PdfBrush contentBrush = new PdfSolidBrush(Color.Black);

// Define the main instructional text.
string overflowText =
@"Creating PDF documentation programmatically with Syncfusion .NET libraries enables automation of reports, invoices, and technical manuals.

Key Features:
- Multi-page automatic content flow using pagination
- Support for rich text formatting: headers, bullets, and tables
- Insert images, tables, and charts seamlessly
- Add interactive elements: bookmarks, hyperlinks, and attachments
- Control layout: margins, page breaks, and dynamic footers

Usage Example:
This project demonstrates how to paginate multiple paragraphs of text describing PDF functionality. When the content exceeds a single page, Syncfusion’s PdfTextElement automatically creates new pages and triggers the PageAdded event. This allows you to attach custom footers, such as page numbers or custom codes, to each page for improved navigation and professional document appearance.

Adding dynamic footers is useful for:
- Section labeling in large documents
- Including secure or traceable codes for each page
- Ensuring readers always know their page context

Other advanced scenarios:
- Creating Table of Contents with page navigation
- Inserting named destinations for quick jumps
- Using graphics and interactive elements within the same document

Experiment by updating this program to add headers, watermarks, or section-based page numbers based on your specific requirements.

For more information, visit:
https://help.syncfusion.com/file-formats/pdf/working-with-text
https://help.syncfusion.com/file-formats/pdf/working-with-graphics

This concludes the instructional workflow for auto-paginated, footer-enhanced PDF generation in .NET.";

// Set the header and footer height
float headerHeight = 40f;
float footerHeight = 30f;

// Create a text element for automatic pagination.
PdfTextElement textElement = new PdfTextElement(overflowText, contentFont, contentBrush);

// Subscribe to the BeginPageLayout event to offset text on each new page below the header.
textElement.BeginPageLayout += (sender, args) =>
{
    // Always start content below the header on every page.
    args.Bounds = new RectangleF(
        0, headerHeight,
        args.Page.GetClientSize().Width,
        args.Page.GetClientSize().Height - headerHeight - footerHeight
    );
};

// Add the first page.
PdfPage firstPage = document.Pages.Add();

// Start drawing content (pagination and event will handle the rest).
textElement.Draw(firstPage, new PointF(0, headerHeight));

// Save and close the document.
document.Save("Output.pdf");
document.Close(true);

// Add header and footer to every page.
static void PageAddedHandler(object sender, PageAddedEventArgs e)
{
    PdfPage page = e.Page;
    int currentPage = page.Section.Pages.IndexOf(page) + 1;

    // Draw header at the top (within reserved header bounds).
    string headerText = $"This is the header - Page {currentPage}";
    page.Graphics.DrawString(
        headerText,
        new PdfStandardFont(PdfFontFamily.Helvetica, 14, PdfFontStyle.Bold),
        new PdfSolidBrush(Color.DimGray),
        new PointF(10, 10) // Within header area
    );

    // Draw footer at the bottom (within reserved footer area).
    string timestamp = DateTime.Now.ToString("'Date:' yyyy-MM-dd 'Time:' HH:mm:ss");
    string footerText = $"Page {currentPage} {timestamp}";
    page.Graphics.DrawString(
        footerText,
        new PdfStandardFont(PdfFontFamily.Helvetica, 12),
        new PdfSolidBrush(Color.Black),
        new PointF(10, page.GetClientSize().Height - 30)
    );
}

VB.NET [Windows-specific]

' Create a new PDF document.
Dim document As New PdfDocument()

' Subscribe to the PageAdded event to add header and footer for every page.
AddHandler document.Pages.PageAdded, AddressOf PageAddedHandler

' Define content font and brush for main text.
Dim contentFont As New PdfStandardFont(PdfFontFamily.TimesRoman, 18)
Dim contentBrush As New PdfSolidBrush(Color.Black)

' Define the main instructional text.
Dim overflowText As String =
"Creating PDF documentation programmatically with Syncfusion .NET libraries enables automation of reports, invoices, and technical manuals." & vbCrLf & vbCrLf &
"Key Features:" & vbCrLf &
"- Multi-page automatic content flow using pagination" & vbCrLf &
"- Support for rich text formatting: headers, bullets, and tables" & vbCrLf &
"- Insert images, tables, and charts seamlessly" & vbCrLf &
"- Add interactive elements: bookmarks, hyperlinks, and attachments" & vbCrLf &
"- Control layout: margins, page breaks, and dynamic footers" & vbCrLf & vbCrLf &
"Usage Example:" & vbCrLf &
"This project demonstrates how to paginate multiple paragraphs of text describing PDF functionality. When the content exceeds a single page, Syncfusion’s PdfTextElement automatically creates new pages and triggers the PageAdded event. This allows you to attach custom footers, such as page numbers or custom codes, to each page for improved navigation and professional document appearance." & vbCrLf & vbCrLf &
"Adding dynamic footers is useful for:" & vbCrLf &
"- Section labeling in large documents" & vbCrLf &
"- Including secure or traceable codes for each page" & vbCrLf &
"- Ensuring readers always know their page context" & vbCrLf & vbCrLf &
"Other advanced scenarios:" & vbCrLf &
"- Creating Table of Contents with page navigation" & vbCrLf &
"- Inserting named destinations for quick jumps" & vbCrLf &
"- Using graphics and interactive elements within the same document" & vbCrLf & vbCrLf &
"Experiment by updating this program to add headers, watermarks, or section-based page numbers based on your specific requirements." & vbCrLf & vbCrLf &
"For more information, visit:" & vbCrLf &
"https://help.syncfusion.com/file-formats/pdf/working-with-text" & vbCrLf &
"https://help.syncfusion.com/file-formats/pdf/working-with-graphics" & vbCrLf &
"This concludes the instructional workflow for auto-paginated, footer-enhanced PDF generation in .NET."

' Set the header and footer height
Dim headerHeight As Single = 40.0F
Dim footerHeight As Single = 30.0F

' Create a text element for automatic pagination.
Dim textElement As New PdfTextElement(overflowText, contentFont, contentBrush)

' Subscribe to the BeginPageLayout event to offset text on each new page below the header.
AddHandler textElement.BeginPageLayout, Sub(sender As Object, args As BeginPageLayoutEventArgs)
    ' Always start content below the header on every page.
    args.Bounds = New RectangleF(0, headerHeight, args.Page.GetClientSize().Width, args.Page.GetClientSize().Height - headerHeight - footerHeight)
End Sub

' Add the first page.
Dim firstPage As PdfPage = document.Pages.Add()

' Start drawing content (pagination and event will handle the rest).
textElement.Draw(firstPage, New PointF(0, headerHeight))

' Save and close the document.
document.Save("Output.pdf")
document.Close(True)

' Add header and footer to every page.
Sub PageAddedHandler(sender As Object, e As PageAddedEventArgs)
    Dim page As PdfPage = e.Page
    Dim currentPage As Integer = page.Section.Pages.IndexOf(page) + 1

    ' Draw header at the top (within reserved header bounds).
    Dim headerText As String = $"This is the header - Page {currentPage}"
    page.Graphics.DrawString(
        headerText,
        New PdfStandardFont(PdfFontFamily.Helvetica, 14, PdfFontStyle.Bold),
        New PdfSolidBrush(Color.DimGray),
        New PointF(10, 10)
    )

    ' Draw footer at the bottom (within reserved footer area).
    Dim timestamp As String = DateTime.Now.ToString("'Date:' yyyy-MM-dd 'Time:' HH:mm:ss")
    Dim footerText As String = $"Page {currentPage} {timestamp}"
    page.Graphics.DrawString(
        footerText,
        New PdfStandardFont(PdfFontFamily.Helvetica, 12),
        New PdfSolidBrush(Color.Black),
        New PointF(10, page.GetClientSize().Height - 30)
    )
End Sub

You can download a complete working sample from GitHub.