Class PdfFooterOptions

Namespace

EvoPdf

Assembly

evohtmltopdf.dll

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

[ClassInterface(ClassInterfaceType.AutoDual)]
public class PdfFooterOptions

Inheritance

object

PdfFooterOptions

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PdfFooterOptions()

public PdfFooterOptions()

Properties

FooterBackColor

The background color of the footer.

public Color FooterBackColor { get; set; }

Property Value

Color

FooterHeight

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

public float FooterHeight { get; set; }

Property Value

float

PageNumberingPageCountIncrement

Gets or sets an increment for the total number of pages displayed using &P; variable in a TextElement object added to the footer.

public int PageNumberingPageCountIncrement { get; set; }

Property Value

int

PageNumberingStartIndex

Gets or sets the start index for page numbering using the &p; variable in a TextElement object added to the footer.

public int PageNumberingStartIndex { get; set; }

Property Value

int

Methods

AddElement(PageElement)

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

public void AddElement(PageElement pdfElement)

Parameters

pdfElement PageElement

The PDF element to be rendered in footer