Class PdfHeaderOptions

Namespace

EvoPdf

Assembly

evohtmltopdf.dll

This class encapsulates the options to control the appearance of the header in the rendered PDF document. The HtmlToPdfConverter class exposes a a reference to an object of this type in PdfHeaderOptions property. If the ShowHeader property of the PdfDocumentOptions object exposed by the PdfDocumentOptions property is false, the header options have no effect.

[ClassInterface(ClassInterfaceType.AutoDual)]
public class PdfHeaderOptions

Inheritance

object

PdfHeaderOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PdfHeaderOptions()

public PdfHeaderOptions()

Properties

HeaderBackColor

The background color of the header.

public Color HeaderBackColor { get; set; }

Property Value

Color

HeaderHeight

Gets or sets the height in points of PDF header. 1 point is 1/72 inch.

public float HeaderHeight { get; set; }

Property Value

float

PageNumberingPageCountIncrement

Gets or sets an increment for the total number of pages displayed using &P; variable in a TextArea element added to the header.

public int PageNumberingPageCountIncrement { get; set; }

Property Value

int

PageNumberingStartIndex

Gets or sets the start index for page numbering using the &p; variable in a TextArea element added to the header.

public int PageNumberingStartIndex { get; set; }

Property Value

int

Methods

AddElement(PageElement)

Add a PDF element to be rendered in header by the HTML to PDF converter

public void AddElement(PageElement pdfElement)

Parameters

pdfElement PageElement

The PDF element to be rendered in header