Add Headers/Footers on Specific Pages

import {PdfDocument} from "@ironsoftware/ironpdf";

(async () => {
    const multi_page_html = `
    <p> This is 1st Page</p>
    <div style='page-break-after: always;'></div>
    <p> This is 2nd Page</p>
    <div style='page-break-after: always;'></div>
    <p> This is 3rd Page</p>
    <div style='page-break-after: always;'></div>
    <p> This is 4th Page</p>
    <div style='page-break-after: always;'></div>
    <p> This is 5th Page</p>
    <div style='page-break-after: always;'></div>
    <p> This is 6th Page</p>
    <div style='page-break-after: always;'></div>
    <p> This is 7th Page</p>`;

    // Create a PDF or Load an existing PDF using PdfDocument.fromFile
    const pdf = await PdfDocument.fromHtml(multi_page_html);

    // Create a header
    const header = {
        htmlFragment: "THIS IS HEADER {page} of {total-pages}",
    };

    // Get page count
    const pageCount = await pdf.getPageCount();

    // Create a Page Range 0 .. 7
    const allPageIndexes = Array.from({ length: pageCount }, (_, index) => index);

    // Example 1
    // Apply header to even page index only. (page number will be odd number because index starts at 0 but page number starts at 1)
    const evenPageIndexes = allPageIndexes.filter(number => number % 2 === 0);
    await pdf.addHtmlHeader(header, evenPageIndexes);
    await pdf.saveAs("EvenPages.pdf");
    
    // Example 2
    // Apply header to odd page index only. (page number will be even number because index starts at 0 but page number starts at 1)
    const oddPageIndexes = allPageIndexes.filter(number => number % 2 !== 0);
    await pdf.addHtmlHeader(header, oddPageIndexes);
    await pdf.saveAs("OddPages.pdf");
    
    // Example 3
    // Apply header to the last page only.
    const lastPageIndex = [pageCount - 1];
    await pdf.addHtmlHeader(header, lastPageIndex);
    await pdf.saveAs("LastPageOnly.pdf");
    
    // Example 4
    // Apply header to the first page only.
    const firstPageIndex = [0];
    await pdf.addHtmlHeader(header, firstPageIndex);
    await pdf.saveAs("FirstPageOnly.pdf");
    
    // Example 5
    // Skip the first page.
    const skipFirstPageIndexes5 = allPageIndexes.slice(1);
    await pdf.addHtmlHeader(header, skipFirstPageIndexes5);
    await pdf.saveAs("SkipFirstPage.pdf");
})();

Add Headers/Footers on Specific Pages

Adding headers and footers to freshly rendered PDFs or existing PDF documents is straightforward with IronPDF.

You can use the addHtmlHeader method to add a header and the addHtmlFooter method to add a footer. These methods require an object that contains the following properties: dividerLine, dividerLineColor, htmlFragment, loadStylesAndCSSFromMainHtmlDocument, and maxHeight.

dividerLine: Applies a divider line after the header or footer.
dividerLineColor: Customizes the divider color.
htmlFragment: Specifies the HTML string to be used for the header or footer.
loadStylesAndCSSFromMainHtmlDocument: Enables loading CSS from the main HTML document. This feature only works when rendering from HTML to PDF.
maxHeight: Sets a maximum height for the header and footer.

Below is an example demonstrating how you could use IronPDF to add headers and footers:

// Import the necessary libraries
using IronPdf;

class PdfExample
{
    static void Main()
    {
        // Create a new PDF document
        var pdf = new PdfDocument();

        // Add HTML content to the PDF
        pdf.AddHtml("<h1>Hello, World!</h1>");

        // Define header properties
        var header = new HtmlHeaderFooter()
        {
            HtmlFragment = "<h2>Header Content</h2>",
            DividerLine = true,
            DividerLineColor = "#000000",
            LoadStylesAndCSSFromMainHtmlDocument = false,
            MaxHeight = 50
        };

        // Define footer properties
        var footer = new HtmlHeaderFooter()
        {
            HtmlFragment = "<p>Page footer</p>",
            DividerLine = true,
            DividerLineColor = "#888888",
            LoadStylesAndCSSFromMainHtmlDocument = false,
            MaxHeight = 50
        };

        // Apply the header and footer to the PDF
        pdf.AddHtmlHeader(header, "all"); // Specify "all" to apply to all pages or specify a particular page range
        pdf.AddHtmlFooter(footer, "all");

        // Save the PDF to a file
        pdf.SaveAs("DocumentWithHeaderFooter.pdf");
    }
}

// Import the necessary libraries
using IronPdf;

class PdfExample
{
    static void Main()
    {
        // Create a new PDF document
        var pdf = new PdfDocument();

        // Add HTML content to the PDF
        pdf.AddHtml("<h1>Hello, World!</h1>");

        // Define header properties
        var header = new HtmlHeaderFooter()
        {
            HtmlFragment = "<h2>Header Content</h2>",
            DividerLine = true,
            DividerLineColor = "#000000",
            LoadStylesAndCSSFromMainHtmlDocument = false,
            MaxHeight = 50
        };

        // Define footer properties
        var footer = new HtmlHeaderFooter()
        {
            HtmlFragment = "<p>Page footer</p>",
            DividerLine = true,
            DividerLineColor = "#888888",
            LoadStylesAndCSSFromMainHtmlDocument = false,
            MaxHeight = 50
        };

        // Apply the header and footer to the PDF
        pdf.AddHtmlHeader(header, "all"); // Specify "all" to apply to all pages or specify a particular page range
        pdf.AddHtmlFooter(footer, "all");

        // Save the PDF to a file
        pdf.SaveAs("DocumentWithHeaderFooter.pdf");
    }
}

' Import the necessary libraries
Imports IronPdf

Friend Class PdfExample
	Shared Sub Main()
		' Create a new PDF document
		Dim pdf = New PdfDocument()

		' Add HTML content to the PDF
		pdf.AddHtml("<h1>Hello, World!</h1>")

		' Define header properties
		Dim header = New HtmlHeaderFooter() With {
			.HtmlFragment = "<h2>Header Content</h2>",
			.DividerLine = True,
			.DividerLineColor = "#000000",
			.LoadStylesAndCSSFromMainHtmlDocument = False,
			.MaxHeight = 50
		}

		' Define footer properties
		Dim footer = New HtmlHeaderFooter() With {
			.HtmlFragment = "<p>Page footer</p>",
			.DividerLine = True,
			.DividerLineColor = "#888888",
			.LoadStylesAndCSSFromMainHtmlDocument = False,
			.MaxHeight = 50
		}

		' Apply the header and footer to the PDF
		pdf.AddHtmlHeader(header, "all") ' Specify "all" to apply to all pages or specify a particular page range
		pdf.AddHtmlFooter(footer, "all")

		' Save the PDF to a file
		pdf.SaveAs("DocumentWithHeaderFooter.pdf")
	End Sub
End Class

$vbLabelText $csharpLabel

Afterward, you can specify the second parameter, which is the page number to which the header or footer will be applied. The specification can be for a single page, multiple pages, or all pages using the string "all". If the page number has not been specified, the method will apply the header or footer to all pages.