Click or drag to resize

PdfFooterOptions Class

This class encapsulates the options to control the appearance of the footer in the rendered PDF document. The PDFConverter class contains a reference to an object of this type. If the ShowFooter property from PDFDocumentOptions object is false, the footer options have no efect
Inheritance Hierarchy
SystemObject
  ExpertPdf.HtmlToPdfPdfFooterOptions

Namespace: ExpertPdf.HtmlToPdf
Assembly: ephtmltopdf (in ephtmltopdf.dll) Version: 21.1.0
Syntax
Copy
public class PdfFooterOptions

The PdfFooterOptions type exposes the following members.

Constructors
 NameDescription
Public methodPdfFooterOptions 
Top
Properties
 NameDescription
Public propertyDrawFooterLine When true, a line is displayed above the footer area. The default value is true.
Public propertyFooterBackColor The background color of the footer.
Public propertyFooterHeight The height in points of PDF footer.
Public propertyFooterImage The image to be displayed in the footer. The image will be displayed at the location specified by the FooterImageLocation and its width in PDF is specified by the FooterImageWidth property. This property is obsolete and it was preserved for backward compatibility. The preferred property is ImageArea.
Public propertyFooterImageLocation The location in points inside the footer where to display the image. By default it is displayed in the top left corner of the header.
Public propertyFooterImageWidth Gets or sets the footer image width in PDF. The value is in points and the image will be resized if necessary to fit the specified width. When the width is negative, the image will be displayed at real size in PDF.
Public propertyFooterText The text to appear in the rendered PDF document footer.
Public propertyFooterTextColor The color of the text displayed in the footer.
Public propertyFooterTextFontName The font family name of the true type font used to display the footer text.
Public propertyFooterTextFontSize The font size in points of the text displayed in the footer.
Public propertyFooterTextFontStyle The style of the true type font used to display the footer text. This property has effect only when FooterTextFontType is None.
Public propertyFooterTextFontType The standard PDF font type of the text displayed in the footer. The standard PDF fonts don't support unicode texts. In order to use a Unicode text you have to set this propery to None and define the true type font using the FooterTextFontName propery. Default this property is None and the FooterTextFontName true type font is used.
Public propertyFooterTextWidth The footer text width in points. Default is -1 which means the width of the text is the footer width.
Public propertyFooterTextYLocation The Y location in points of the footer text.
Public propertyHtmlToPdfArea Set this property with a HtmlToPdfElement object to render HTML code or URL in footer.
Public propertyImageArea Set this property with an ImageArea object to render an image in header.
Public propertyPageNumberingFormatString The custom format string used by the predefined page numbering element. By default this property is null and the default formatting string is used for the predefined page numbering element. The page numbering formatting string can display the current page number using the &p; tag and the total number of pages using the &P; tag. An example of formatting string is "Page &p; of &P; pages". The same formatting tags can be used in a TextArea element added to the footer. When this property is set with a value, the PageNumberText property used to customize the default formatting string is not used anymore. The predefined page numbering element is displayed in the footer only when ShowPageNumber is true.
Public propertyPageNumberingPageCountIncrement Gets or sets an increment for the total number of pages displayed using &P; variable in a TextArea element added to the header or in the predefined numbering element.
Public propertyPageNumberingStartIndex Gets or sets the start index for page numbering using the &p; variable in a TextArea element added to the footer or in the predefined numbering element.
Public propertyPageNumberText The text to be displayed before the page number. The default value is 'Page'.
Public propertyPageNumberTextColor The color of the text displayed in the footer page number text
Public propertyPageNumberTextFontName The font family name of the true type font used to display the footer page numbering text.
Public propertyPageNumberTextFontSize The font size in points of the text displayed in the footer page numbering text.
Public propertyPageNumberTextFontStyle The style of the true type font used to display the page numbering text in footer. This property has effect only when PageNumberTextFontType is None.
Public propertyPageNumberTextFontType The standard PDF font type of the text displayed in the footer page number text. The standard PDF fonts don't support unicode texts. In order to use a Unicode text you have to set this propery to None and define the true type font using the PageNumberTextFontName propery. Default this property is None and the PageNumberTextFontName true type font is used.
Public propertyPageNumberYLocation The Y location in points of the page numbering text.
Public propertyShowOnEvenPages Show or not the header on even pages. By default the header is displayed both on odd and even pages.
Public propertyShowOnFirstPage When this property is true the footer will be shown on the first page otherwise it will not be shown. This property has priority over ShowOnOddPages. The default value is true.
Public propertyShowOnOddPages Show or not the header on odd pages. By default the header is displayed both on odd and even pages. The ShowOnFirstPage property has priority over ShowOnOddPages.
Public propertyShowPageNumber When true, the default page numbering element is displayed in the footer. The default value is false and the default page numbering element is not displayed. The text displayed by the default page numbering element can be customized using the PageNumberingFormatString property. The page numbering formatting string can display the current page number using the &p; tag and the total number of pages using the &P; tag. An example of formatting string is "Page &p; of &P; pages".
Public propertyTextArea Set this property with a TextArea object to render a text in header. If &p; tag is appears in the TextArea text, it will be replaced with the current PDF page number. By default the page numbering starts with 1. The start index of the page numbering can be changed using the PageNumberingStartIndex property. If &P; tag appears in the TextArea text, it will be replaced with the total number of pages in the PDF document. Optionally, a constat value given by the PageNumberingPageCountIncrement can be added to the total number of pages.
Top
Methods
 NameDescription
Public methodAddHtmlToPdfArea Adds a HtmlToPdfArea element to the additional elements list rendered after the predefined footer elements. The additional elements are rendered in the order they are added to the list.
Public methodAddImageArea Adds an ImageArea element to the additional elements list rendered after the predefined footer elements. The additional elements are rendered in the order they are added to the list.
Public methodAddTextArea Adds a TextArea element to the additional elements list rendered after the predefined footer elements. The additional elements are rendered in the order they are added to the list.
Top
See Also