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
Declaration Syntax| C# | Visual Basic | Visual C++ |
public class PdfHeaderOptions
Public Class PdfHeaderOptions
public ref class PdfHeaderOptions
Members| All Members | Constructors | Methods | Properties | ||
| Icon | Member | Description |
|---|---|---|
 | PdfHeaderOptions()()()() | |
| AddHtmlToPdfArea(HtmlToPdfArea) |
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.
|
| AddImageArea(ImageArea) |
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.
|
| AddTextArea(TextArea) |
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.
|
 | DrawHeaderLine |
When true, a line is displayed under the header area. The default value is true.
|
| Equals(Object) | (Inherited from Object.) |
 | Finalize()()()() | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType()()()() | Gets the type of the current instance. (Inherited from Object.) |
| HeaderBackColor |
The background color of the header.
|
| HeaderHeight |
The height in points of PDF header.
|
| HeaderImage |
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.
|
| HeaderImageLocation |
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.
|
| HeaderImageWidth |
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.
|
| HeaderSubtitleText |
A PDF document header subtitle.
|
| HeaderSubtitleTextColor |
The color of the text displayed in the header subtitle
|
| HeaderSubtitleTextFontName |
The font family name of the true type font used to display the header subtitle text.
|
| HeaderSubtitleTextFontSize |
The font size in points of the text displayed in the header subtitle.
|
| HeaderSubtitleTextFontStyle |
The style of the true type font used to display the header subtitle text. This property has effect only
when HeaderSubtitleTextFontType is None.
|
| HeaderSubtitleTextFontType |
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.
|
| HeaderText |
The text to appear in the rendered PDF document title.
|
| HeaderTextAlign |
The header text alignment.
|
| HeaderTextColor |
The color of the text displayed in the header.
|
| HeaderTextFontName |
The font family name of the true type font used to display the header text.
|
| HeaderTextFontSize |
The font size in points of the text displayed in the header.
|
| HeaderTextFontStyle |
The style of the true type font used to display the header text. This property has effect only
when HeaderTextFontType is None.
|
| HeaderTextFontType |
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.
|
| HeaderTextYLocation |
The Y location of the header text in points.
|
| HeaderTitleSubtitleYSpacing |
The Y distance in points between the title and the subtitle.
|
| HtmlToPdfArea |
Set this property with a HtmlToPdfArea object to render HTML code or URL in header.
|
| ImageArea |
Set this property with an ImageArea object to render an image in header.
|
| MemberwiseClone()()()() | Creates a shallow copy of the current Object. (Inherited from Object.) |
| PageNumberingPageCountIncrement |
Gets or sets an increment for the total number of pages displayed using &P; variable in a TextArea element
added to the header.
|
| PageNumberingStartIndex |
Gets or sets the start index for page numbering using the &p; variable in a TextArea element
added to the header.
|
| ShowOnEvenPages |
Show or not the header on even pages. By default the header is displayed both on odd and even pages.
|
| ShowOnFirstPage |
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.
|
| ShowOnOddPages |
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.
|
| TextArea |
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.
|
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) |
Inheritance Hierarchy| Object | |
 | PdfHeaderOptions |
Assembly: ExpertPdf.HtmlToPdf (Module: ExpertPdf.HtmlToPdf.dll) Version: 9.2.0.25824 (9.2.0.0)