Click or drag to resize
Pdf Library for .NET

PdfHeader Class

Handles the properties of the header of the generated pdf document.
Inheritance Hierarchy
SystemObject
  SelectPdf.UniversalPdfHeader

Namespace: SelectPdf.Universal
Assembly: SelectPdf.HtmlToPdf.Universal (in SelectPdf.HtmlToPdf.Universal.dll) Version: 26.4
Syntax
Copy
public class PdfHeader

The PdfHeader type exposes the following members.

Constructors
 NameDescription
Public methodPdfHeader 
Top
Properties
 NameDescription
Public propertyDisplayOnEvenPages Controls the visibility of the header on the even numbered pages of the generated pdf document.
Public propertyDisplayOnFirstPage Controls the visibility of the header on the first page of the generated pdf document.
Public propertyDisplayOnOddPages Controls the visibility of the header on the odd numbered pages of the generated pdf document.
Public propertyFirstPageNumber Controls the page number for the first page being rendered.
Public propertyHeight The height of the pdf document header.
Public propertyTotalPagesOffset Controls the total number of pages offset in the generated pdf document.
Top
Methods
 NameDescription
Public methodCode exampleAdd Adds an element to the header of the pdf document.
Top
Remarks
This class encapsulates the options to control the header in the rendered pdf document. The HtmlToPdf class contains a reference to an object of this type.

The header is displayed only if DisplayHeader property of the Options object is true. If the DisplayHeader property of the Options object is false, the header will not be displayed and all the options set here will have no effect.

Example
Copy
HtmlToPdf converter = new HtmlToPdf();
converter.Options.DisplayHeader = true;
converter.Header.Height = 50;
converter.Header.DisplayOnFirstPage = false;
PdfFont font = PdfFont.CreateStandardFont(PdfStandardFont.Helvetica, 12);
PdfTextSection text = new PdfTextSection(0, 10, "My header", font);
converter.Header.Add(text);
PdfDocument doc = converter.ConvertUrl("https://www.google.com");
doc.Save("out.pdf");
doc.Close();
See Also