EVO HTML to PDF Converter offers a great flexibility in adding headers and footers to the generated PDF document. You can add in header and footer any PDF element that you can normally add in a PDF page: HTML, text, image.
The most important options related to adding HTML in header and footer:
HTML Page to Convert
HTML Page URL or Local File to Convert. The URL of the HTML page to convert must be accessible from the computer where the converter runs. If the page requires authentication or if you are using a proxy server to access the Internet then you have to set the converter properties accordingly as described in documentation. The method you can use to convert a URL to PDF is HtmlToPdfConverterConvertUrl(String)
Enable Header and Footer
Add Header. Using this option you can enable or disable the header in the generated PDF document. The property you can set in your code to control this option is PdfDocumentOptionsShowHeader. An object of PdfDocumentOptions type is exposed by the HtmlToPdfConverterPdfDocumentOptions property
Add Footer. Using this option you can enable or disable the footer in the generated PDF document. The property you can set in your code to control this option is PdfDocumentOptionsShowFooter. An object of PdfDocumentOptions type is exposed by the HtmlToPdfConverterPdfDocumentOptions property
Header Options
Show in First Page. Using this feature you can enable or disable the header in the first page of the generated PDF document. This feature can be implemented in the HtmlToPdfConverterPrepareRenderPdfPageEvent event handler setting the PdfPageShowHeader property of the EvoPdfPdfPage object exposed by the event parameters.
Show in Odd Pages. Using this feature you can enable or disable the header in the odd pages of the generated PDF document. This feature can be implemented in the HtmlToPdfConverterPrepareRenderPdfPageEvent event handler setting the PdfPageShowHeader property of the EvoPdfPdfPage object exposed by the event parameters.
Show in Even Pages. Using this feature you can enable or disable the header in the even pages of the generated PDF document. This feature can be implemented in the HtmlToPdfConverterPrepareRenderPdfPageEvent event handler setting the PdfPageShowHeader property of the EvoPdfPdfPage object exposed by the event parameters.
Draw Header Line. This feature controls if a thin line will be drawn at the bottom of the header and it can be implemented by adding a EvoPdfLineElement object at the bottom of the header template.
Spacing. This option represents the space between the header and the PDF page body. The property you can set in your code for this option is PdfDocumentOptionsTopSpacing. An object of PdfDocumentOptions type is exposed by the HtmlToPdfConverterPdfDocumentOptions property
First Page Spacing. This option represents the space between the header and the PDF page body in the first page of the generated PDF document. The property you can set in your code for this option is PdfDocumentOptionsY. An object of PdfDocumentOptions type is exposed by the HtmlToPdfConverterPdfDocumentOptions property
Footer Options
Show in First Page. Using this feature you can enable or disable the footer in the first page of the generated PDF document. This feature can be implemented in the HtmlToPdfConverterPrepareRenderPdfPageEvent event handler setting the PdfPageShowFooter property of the EvoPdfPdfPage object exposed by the event parameters.
Show in Odd Pages. Using this feature you can enable or disable the footer in the odd pages of the generated PDF document. This feature can be implemented in the HtmlToPdfConverterPrepareRenderPdfPageEvent event handler setting the PdfPageShowFooter property of the EvoPdfPdfPage object exposed by the event parameters.
Show in Even Pages. Using this feature you can enable or disable the footer in the even pages of the generated PDF document. This feature can be implemented in the HtmlToPdfConverterPrepareRenderPdfPageEvent event handler setting the PdfPageShowFooter property of the EvoPdfPdfPage object exposed by the event parameters.
Add Page Numbers. This feature controls if the page numbering will be added in footer and it can be implemented by using the &p; and &P; placeholders for current page number and the total number of pages of the PDF document in a EvoPdfTextElement added to the footer template.
Draw Footer Line. This feature controls if a thin line will be drawn at the top of the footer and it can be implemented by adding a EvoPdfLineElement object at the top of the footer template.
Spacing. This option represents the space between the footer and the PDF page body. The property you can set in your code for this option is PdfDocumentOptionsBottomSpacing. An object of PdfDocumentOptions type is exposed by the HtmlToPdfConverterPdfDocumentOptions property
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Hosting;
using System.Drawing;
// Use EVO PDF Namespace
using EvoPdf;
namespace EvoHtmlToPdfDemo.Controllers.HTML_to_PDF.Headers_and_Footers
{
public class HTML_in_Header_FooterController : Controller
{
IFormCollection formCollection;
private readonly Microsoft.AspNetCore.Hosting.IHostingEnvironment m_hostingEnvironment;
public HTML_in_Header_FooterController(IHostingEnvironment hostingEnvironment)
{
m_hostingEnvironment = hostingEnvironment;
}
[HttpPost]
public ActionResult ConvertHtmlToPdf(IFormCollection collection)
{
formCollection = collection;
// Create a HTML to PDF converter object with default settings
HtmlToPdfConverter htmlToPdfConverter = new HtmlToPdfConverter();
// Set license key received after purchase to use the converter in licensed mode
// Leave it not set to use the converter in demo mode
htmlToPdfConverter.LicenseKey = "4W9+bn19bn5ue2B+bn1/YH98YHd3d3c=";
// Set an adddional delay in seconds to wait for JavaScript or AJAX calls after page load completed
// Set this property to 0 if you don't need to wait for such asynchcronous operations to finish
htmlToPdfConverter.ConversionDelay = 2;
// Install a handler where you can set header and footer visibility or create a custom header and footer in each page
htmlToPdfConverter.PrepareRenderPdfPageEvent += new PrepareRenderPdfPageDelegate(htmlToPdfConverter_PrepareRenderPdfPageEvent);
// Add Header
// Enable header in the generated PDF document
htmlToPdfConverter.PdfDocumentOptions.ShowHeader = collection["addHeaderCheckBox"].Count > 0;
// Optionally add a space between header and the page body
// The spacing for first page and the subsequent pages can be set independently
// Leave this option not set for no spacing
htmlToPdfConverter.PdfDocumentOptions.Y = float.Parse(collection["firstPageSpacingTextBox"]);
htmlToPdfConverter.PdfDocumentOptions.TopSpacing = float.Parse(collection["headerSpacingTextBox"]);
// Draw header elements
if (htmlToPdfConverter.PdfDocumentOptions.ShowHeader)
DrawHeader(htmlToPdfConverter, collection["drawHeaderLineCheckBox"].Count > 0);
// Add Footer
// Enable footer in the generated PDF document
htmlToPdfConverter.PdfDocumentOptions.ShowFooter = collection["addFooterCheckBox"].Count > 0;
// Optionally add a space between footer and the page body
// Leave this option not set for no spacing
htmlToPdfConverter.PdfDocumentOptions.BottomSpacing = float.Parse(collection["footerSpacingTextBox"]);
// Draw footer elements
if (htmlToPdfConverter.PdfDocumentOptions.ShowFooter)
DrawFooter(htmlToPdfConverter, collection["addPageNumbersInFooterCheckBox"].Count > 0, collection["drawFooterLineCheckBox"].Count > 0);
// Convert the HTML page to a PDF document in a memory buffer
byte[] outPdfBuffer = htmlToPdfConverter.ConvertUrl(collection["urlTextBox"]);
// Send the PDF file to browser
FileResult fileResult = new FileContentResult(outPdfBuffer, "application/pdf");
fileResult.FileDownloadName = "HTML_in_Header_Footer.pdf";
return fileResult;
}
/// <summary>
/// The handler for HtmlToPdfConverter.PrepareRenderPdfPageEvent event where you can set the visibility of header and footer
/// in each page or you can add a custom header or footer in a page
/// </summary>
/// <param name="eventParams">The event parameter containin the PDF page to customize before rendering</param>
void htmlToPdfConverter_PrepareRenderPdfPageEvent(PrepareRenderPdfPageParams eventParams)
{
// Set the header visibility in first, odd and even pages
if (formCollection["addHeaderCheckBox"].Count > 0)
{
if (eventParams.PageNumber == 1)
eventParams.Page.ShowHeader = formCollection["showHeaderInFirstPageCheckBox"].Count > 0;
else if ((eventParams.PageNumber % 2) == 0 && !(formCollection["showHeaderInEvenPagesCheckBox"].Count > 0))
eventParams.Page.ShowHeader = false;
else if ((eventParams.PageNumber % 2) == 1 && !(formCollection["showHeaderInOddPagesCheckBox"].Count > 0))
eventParams.Page.ShowHeader = false;
}
// Set the footer visibility in first, odd and even pages
if (formCollection["addFooterCheckBox"].Count > 0)
{
if (eventParams.PageNumber == 1)
eventParams.Page.ShowFooter = formCollection["showFooterInFirstPageCheckBox"].Count > 0;
else if ((eventParams.PageNumber % 2) == 0 && !(formCollection["showFooterInEvenPagesCheckBox"].Count > 0))
eventParams.Page.ShowFooter = false;
else if ((eventParams.PageNumber % 2) == 1 && !(formCollection["showFooterInOddPagesCheckBox"].Count > 0))
eventParams.Page.ShowFooter = false;
}
}
/// <summary>
/// Draw the header elements
/// </summary>
/// <param name="htmlToPdfConverter">The HTML to PDF Converter object</param>
/// <param name="drawHeaderLine">A flag indicating if a line should be drawn at the bottom of the header</param>
private void DrawHeader(HtmlToPdfConverter htmlToPdfConverter, bool drawHeaderLine)
{
string headerHtmlUrl = m_hostingEnvironment.ContentRootPath + "/wwwroot" + "/DemoAppFiles/Input/HTML_Files/Header_HTML.html";
// Set the header height in points
htmlToPdfConverter.PdfHeaderOptions.HeaderHeight = 60;
// Set header background color
htmlToPdfConverter.PdfHeaderOptions.HeaderBackColor = Color.White;
// Create a HTML element to be added in header
HtmlToPdfElement headerHtml = new HtmlToPdfElement(headerHtmlUrl);
// Set the HTML element to fit the container height
headerHtml.FitHeight = true;
// Add HTML element to header
htmlToPdfConverter.PdfHeaderOptions.AddElement(headerHtml);
if (drawHeaderLine)
{
// Calculate the header width based on PDF page size and margins
float headerWidth = htmlToPdfConverter.PdfDocumentOptions.PdfPageSize.Width -
htmlToPdfConverter.PdfDocumentOptions.LeftMargin - htmlToPdfConverter.PdfDocumentOptions.RightMargin;
// Calculate header height
float headerHeight = htmlToPdfConverter.PdfHeaderOptions.HeaderHeight;
// Create a line element for the bottom of the header
LineElement headerLine = new LineElement(0, headerHeight - 1, headerWidth, headerHeight - 1);
// Set line color
headerLine.ForeColor = Color.Gray;
// Add line element to the bottom of the header
htmlToPdfConverter.PdfHeaderOptions.AddElement(headerLine);
}
}
/// <summary>
/// Draw the footer elements
/// </summary>
/// <param name="htmlToPdfConverter">The HTML to PDF Converter object</param>
/// <param name="addPageNumbers">A flag indicating if the page numbering is present in footer</param>
/// <param name="drawFooterLine">A flag indicating if a line should be drawn at the top of the footer</param>
private void DrawFooter(HtmlToPdfConverter htmlToPdfConverter, bool addPageNumbers, bool drawFooterLine)
{
string footerHtmlUrl = m_hostingEnvironment.ContentRootPath + "/wwwroot" + "/DemoAppFiles/Input/HTML_Files/Footer_HTML.html";
// Set the footer height in points
htmlToPdfConverter.PdfFooterOptions.FooterHeight = 60;
// Set footer background color
htmlToPdfConverter.PdfFooterOptions.FooterBackColor = Color.WhiteSmoke;
// Create a HTML element to be added in footer
HtmlToPdfElement footerHtml = new HtmlToPdfElement(footerHtmlUrl);
// Set the HTML element to fit the container height
footerHtml.FitHeight = true;
// Add HTML element to footer
htmlToPdfConverter.PdfFooterOptions.AddElement(footerHtml);
// Add page numbering
if (addPageNumbers)
{
// Create a text element with page numbering place holders &p; and & P;
TextElement footerText = new TextElement(0, 30, "Page &p; of &P; ",
new System.Drawing.Font(new System.Drawing.FontFamily("Times New Roman"), 10, System.Drawing.GraphicsUnit.Point));
// Align the text at the right of the footer
footerText.TextAlign = HorizontalTextAlign.Right;
// Set page numbering text color
footerText.ForeColor = Color.Navy;
// Embed the text element font in PDF
footerText.EmbedSysFont = true;
// Add the text element to footer
htmlToPdfConverter.PdfFooterOptions.AddElement(footerText);
}
if (drawFooterLine)
{
// Calculate the footer width based on PDF page size and margins
float footerWidth = htmlToPdfConverter.PdfDocumentOptions.PdfPageSize.Width -
htmlToPdfConverter.PdfDocumentOptions.LeftMargin - htmlToPdfConverter.PdfDocumentOptions.RightMargin;
// Create a line element for the top of the footer
LineElement footerLine = new LineElement(0, 0, footerWidth, 0);
// Set line color
footerLine.ForeColor = Color.Gray;
// Add line element to the bottom of the footer
htmlToPdfConverter.PdfFooterOptions.AddElement(footerLine);
}
}
}
}