Click or drag to resize

PdfHeaderOptions Class

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

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

The PdfHeaderOptions type exposes the following members.

Constructors
  NameDescription
Public methodPdfHeaderOptions
Top
Properties
  NameDescription
Public propertyDrawHeaderLine
When true, a line is displayed under the header area. The default value is true.
Public propertyHeaderBackColor
The background color of the header.
Public propertyHeaderHeight
The height in points of PDF header.
Public propertyHeaderImage
The image to be displayed in the header. The image will be displayed at the location specified by the HeaderImageLocation and its width in PDF is specified by the HeaderImageWidth property. This property is obsolete and it was preserved for backward compatibility. The preferred property is ImageArea.
Public propertyHeaderImageLocation
The location in points inside the header where to display the image. By default it is displayed in the top left corner of the header.
Public propertyHeaderImageWidth
Gets or sets the header 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 propertyHeaderSubtitleText
A PDF document header subtitle.
Public propertyHeaderSubtitleTextColor
The color of the text displayed in the header subtitle
Public propertyHeaderSubtitleTextFontName
The font family name of the true type font used to display the header subtitle text.
Public propertyHeaderSubtitleTextFontSize
The font size in points of the text displayed in the header subtitle.
Public propertyHeaderSubtitleTextFontStyle
The style of the true type font used to display the header subtitle text. This property has effect only when HeaderSubtitleTextFontType is None.
Public propertyHeaderSubtitleTextFontType
The standard PDF font type of the text displayed in the header subtitle. 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 HeaderSubtitleTextFontName propery. Default this property is None and the HeaderSubtitleTextFontName true type font is used.
Public propertyHeaderText
The text to appear in the rendered PDF document title.
Public propertyHeaderTextAlign
The header text alignment.
Public propertyHeaderTextColor
The color of the text displayed in the header.
Public propertyHeaderTextFontName
The font family name of the true type font used to display the header text.
Public propertyHeaderTextFontSize
The font size in points of the text displayed in the header.
Public propertyHeaderTextFontStyle
The style of the true type font used to display the header text. This property has effect only when HeaderTextFontType is None.
Public propertyHeaderTextFontType
The standard PDF font type of the text displayed in the header. 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 HeaderTextFontName propery. Default this property is None and the HeaderTextFontName true type font is used.
Public propertyHeaderTextYLocation
The Y location of the header text in points.
Public propertyHeaderTitleSubtitleYSpacing
The Y distance in points between the title and the subtitle.
Public propertyHtmlToPdfArea
Set this property with a HtmlToPdfArea object to render HTML code or URL in header.
Public propertyImageArea
Set this property with an ImageArea object to render an image in header.
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.
Public propertyPageNumberingStartIndex
Gets or sets the start index for page numbering using the &p; variable in a TextArea element added to the header.
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 header 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 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 header 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 header 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 header elements. The additional elements are rendered in the order they are added to the list.
Top
See Also