PdfPageOptions.HeaderTemplate Property

Gets or sets the HTML template for page header.

Namespace:  BitMiracle.Docotic.Pdf.HtmlToPdf
Assembly:  BitMiracle.Docotic.Pdf.HtmlToPdf (in BitMiracle.Docotic.Pdf.HtmlToPdf.dll)

Syntax

C#
public string HeaderTemplate { get; set; }
VB
Public Property HeaderTemplate As String
	Get
	Set

Property Value

Type: String
The HTML template for page header.

Remarks

Default value: null.

The template should be valid HTML. The conversion engine won't wait for external resources to load. Therefore, it is recommended to use inline styles. Data URIs are recommended for images.

You might want to specify a top margin for the page using the MarginTop property. Without the margin, the header may be obscured by the page contents.

When creating PDF pages, the library will inject values into HTML entities with the following classes:

  • date (formatted creation date).
  • title (document title).
  • url (document location).
  • pageNumber (current page number)
  • totalPages (total pages in the document)

The library won't add header and footer if both this and FooterTemplate property values are null or empty strings.

See Also