Represents a template element which can be repeated in all PDF document pages.
You can use variables like current PDF page number and the total number of PDF pages in a template.
Inheritance Hierarchy
EvoPdf.HtmlToPdfClientElementsRenderer
EvoPdf.HtmlToPdfClientTemplate
Namespace: EvoPdf.HtmlToPdfClient
Assembly: EvoHtmlToPdfClient (in EvoHtmlToPdfClient.dll) Version: 9.0.0.0 (9.0.0.0)
Syntax
The Template type exposes the following members.
Properties
Name | Description | |
---|---|---|
Anchoring |
Gets or sets the template anchoring inside the PDF page
| |
BringToFront |
When true, this property makes the template to be rendered in front of the
page main content. By default this property is true.
| |
Docking |
Gets or sets the template docking inside the PDF page
| |
DrawOnEvenPages |
Set this property to indicate whether the template is drawn or not on the even pages.
By default this property is true.
| |
DrawOnFirstPage |
Set this property to indicate whether the template is drawn or not on the first page.
By default this property is true.
| |
DrawOnOddPages |
Set this property to indicate whether the template is drawn or not on the odd pages.
By default this property is true.
| |
Height |
Gets template height for a custom template
| |
IsFooter |
Gets a flag indicating if this template was created as document footer
| |
IsHeader |
Gets a flag indicating if this template was created as document header
| |
PageNumberingPageCountIncrement |
Gets or sets an increment for the total number of pages displayed using &P; variable in a TextElement
added to the template.
| |
PageNumberingStartIndex |
Gets or sets the start index for page numbering using the &p; variable in a TextElement
added to the template.
| |
ParentDocument |
The parent document of this renderer
(Inherited from ElementsRenderer.) | |
SendToBackground |
When true, this property makes the template to be rendered in the back of the
page main content. By default this property is false.
| |
Width |
Gets template width for a custom template
| |
X |
Gets template X location for a custom template
| |
Y |
Gets template Y location for a custom template
|
Methods
Name | Description | |
---|---|---|
AddElement |
Adds a PDF page element to this template repeated in each PDF page
(Overrides ElementsRendererAddElement(PageElement).) | |
Equals | (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.) | |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also