HTML to PDF Converter ASP.NET Core samples · .NET 10 and .NET 11

ExpertPdf Html To Pdf Converter for .NET - Pdf Headers and Footers with Html to Pdf Converter - C# / ASP.NET Sample

This sample shows how to convert an url to pdf using ExpertPdf Pdf Library for .NET and how to set html headers and footers for the generated pdf document.

This sample will also show how to add page numbers in the footer of the generated pdf document and how to modify the document header to be different for a specific page.

Url:

Header:
Show on First Page
Show on Odd Numbered Pages
Show on Even Numbered Pages
Height:  px
Sample header

Footer:
Show on First Page
Show on Odd Numbered Pages
Show on Even Numbered Pages
Height:  px
Add page numbers
Sample footer

Rendering engine:


C# code of this sample

Pages/HtmlToPdfHeadersAndFooters.cshtml.cs
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.RazorPages;
using Microsoft.AspNetCore.Mvc.Rendering;
using ExpertPdf.HtmlToPdf;
using ExpertPdf.HtmlToPdf.PdfDocument;

namespace ExpertPdf.Samples.Pages
{
    public class HtmlToPdfHeadersAndFootersModel : PageModel
    {
        public void OnGet()
        {
        }

        [BindProperty]
        public string TxtUrl { get; set; }

        [BindProperty]
        public bool showHeaderOnFirstPage { get; set; }

        [BindProperty]
        public bool showHeaderOnOddPages { get; set; }

        [BindProperty]
        public bool showHeaderOnEvenPages { get; set; }

        [BindProperty]
        public int headerHeight { get; set; }

        [BindProperty]
        public bool showFooterOnFirstPage { get; set; }

        [BindProperty]
        public bool showFooterOnOddPages { get; set; }

        [BindProperty]
        public bool showFooterOnEvenPages { get; set; }

        [BindProperty]
        public int footerHeight { get; set; }

        [BindProperty]
        public bool showPageNumbering { get; set; }

[BindProperty]
        public string DdlRenderingEngine { get; set; } = "Chromium";

        public List<SelectListItem> RenderingEngines { get; } = Helper.RenderingEngines();

        public IActionResult OnPost()
        {
            // get parameters
            string headerUrl = Startup.ServerPath + @"\wwwroot\files\header.html";
            string footerUrl = Startup.ServerPath + @"\wwwroot\files\footer.html";

            // instantiate a html to pdf converter object
            PdfConverter converter = new PdfConverter() { AllowLocalAccess = false };
            // the rendering engine: Chromium is the recommended engine for modern pages
            converter.RenderingEngine = (RenderingEngine)Enum.Parse(typeof(RenderingEngine), DdlRenderingEngine);

            // header settings
            converter.PdfDocumentOptions.ShowHeader = showHeaderOnFirstPage ||
                showHeaderOnOddPages || showHeaderOnEvenPages;
            converter.PdfHeaderOptions.ShowOnFirstPage = showHeaderOnFirstPage;
            converter.PdfHeaderOptions.ShowOnOddPages = showHeaderOnOddPages;
            converter.PdfHeaderOptions.ShowOnEvenPages = showHeaderOnEvenPages;
            converter.PdfHeaderOptions.HeaderHeight = headerHeight;
            converter.PdfHeaderOptions.DrawHeaderLine = false;

            HtmlToPdfArea headerHtml = new HtmlToPdfArea(headerUrl);
            headerHtml.RenderingEngine = converter.RenderingEngine;
            converter.PdfHeaderOptions.AddHtmlToPdfArea(headerHtml);

            // footer settings
            converter.PdfDocumentOptions.ShowFooter = showFooterOnFirstPage ||
                showFooterOnOddPages || showFooterOnEvenPages;
            converter.PdfFooterOptions.ShowOnFirstPage = showFooterOnFirstPage;
            converter.PdfFooterOptions.ShowOnOddPages = showFooterOnOddPages;
            converter.PdfFooterOptions.ShowOnEvenPages = showFooterOnEvenPages;
            converter.PdfFooterOptions.FooterHeight = footerHeight;
            converter.PdfFooterOptions.DrawFooterLine = false;

            HtmlToPdfArea footerHtml = new HtmlToPdfArea(footerUrl);
            footerHtml.RenderingEngine = converter.RenderingEngine;
            converter.PdfFooterOptions.AddHtmlToPdfArea(footerHtml);

            // add page numbering element to the footer
            if (showPageNumbering)
            {
                // page numbers can be added using a PdfTextSection object
                TextArea text = new TextArea(0, 10,
                    "Page: &p; of &P;  ",
                    new System.Drawing.Font("Arial", 8));
                text.TextAlign = HorizontalTextAlign.Right;
                converter.PdfFooterOptions.AddTextArea(text);
            }

            // create a new pdf document converting an url
            Document doc = converter.GetPdfDocumentObjectFromUrl(TxtUrl);

            // custom header on page 3
            if (doc.Pages.Count >= 3)
            {
                PdfPage page = doc.Pages[2];

                Template customHeader = doc.AddTemplate(
                    page.PageSize.Width, headerHeight);
                HtmlToPdfElement customHtml = new HtmlToPdfElement(
                    "<div><b>This is the custom header that will " +
                    "appear only on page 3!</b></div>",
                    string.Empty) { AllowLocalAccess = false };
                customHtml.RenderingEngine = (RenderingEngine)Enum.Parse(typeof(RenderingEngine), DdlRenderingEngine);
                customHeader.AddElement(customHtml);

                page.CustomHeaderTemplate = customHeader;
            }

            // save pdf document
            byte[] pdf = doc.Save();

            // close pdf document
            doc.Close();

            // return resulted pdf document
            FileResult fileResult = new FileContentResult(pdf, "application/pdf");
            fileResult.FileDownloadName = "Sample.pdf";
            return fileResult;

        }

    }
}