PdfHeader Class


PdfHeader Class

Handles the properties of the header of the generated pdf document.

Inheritance Hierarchy

SystemObject
SelectPdfPdfHeader

Namespace: SelectPdf
Assembly: Select.HtmlToPdf (in Select.HtmlToPdf.dll) Version: 26.2

Syntax

Copy

public class PdfHeader

Public Class PdfHeader

The PdfHeader type exposes the following members.

Constructors

	Name	Description
	PdfHeader

Top

Properties

	Name	Description
	DisplayOnEvenPages	Controls the visibility of the header on the even numbered pages of the generated pdf document.
	DisplayOnFirstPage	Controls the visibility of the header on the first page of the generated pdf document.
	DisplayOnOddPages	Controls the visibility of the header on the odd numbered pages of the generated pdf document.
	FirstPageNumber	Controls the page number for the first page being rendered.
	Height	The height of the pdf document header.
	TotalPagesOffset	Controls the total number of pages offset in the generated pdf document.

Top

Methods

	Name	Description
	Add	Adds an additional 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.

Reference

SelectPdf Namespace