Winnovative HTML to PDF Converter

Template Class

Winnovative HTML to PDF Converter for .NET Documentation
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

SystemObject
  WinnovativeElementsRenderer
    WinnovativeTemplate

Namespace:  Winnovative
Assembly:  wnvhtmltopdf (in wnvhtmltopdf.dll) Version: 17.0.0.0
Syntax

public class Template : ElementsRenderer

The Template type exposes the following members.

Properties

  NameDescription
Public propertyAnchoring
Gets or sets the template anchoring inside the PDF page
Public propertyBounds
Gets or sets the template bounds rectangle. Setting this property for a default template has no effect.
Public propertyBringToFront
When true, this property makes the template to be rendered in front of the page main content. By default this property is true.
Public propertyClientRectangle
Gets the drawable area of the renderer. The margins, document header and footer are excluded.
(Inherited from ElementsRenderer.)
Public propertyDocking
Gets or sets the template docking inside the PDF page
Public propertyDrawOnEvenPages
Set this property to indicate whether the template is drawn or not on the even pages. By default this property is true.
Public propertyDrawOnFirstPage
Set this property to indicate whether the template is drawn or not on the first page. By default this property is true.
Public propertyDrawOnOddPages
Set this property to indicate whether the template is drawn or not on the odd pages. By default this property is true.
Public propertyHeight
Gets or sets template height for a custom template. Setting this property for a default document template has no effect.
Public propertyPageNumberingPageCountIncrement
Gets or sets an increment for the total number of pages displayed using &P; variable in a TextElement added to the template.
Public propertyPageNumberingStartIndex
Gets or sets the start index for page numbering using the &p; variable in a TextElement added to the template.
Public propertyParentDocument
The parent document of this renderer
(Inherited from ElementsRenderer.)
Public propertySendToBackground
When true, this property makes the template to be rendered in the back of the page main content. By default this property is false.
Public propertyWidth
Gets or sets template width for a custom template. Setting this property for a default document template has no effect.
Top
Methods

  NameDescription
Public methodAddElement
Adds a PDF page element to this template repeated in each PDF page
(Overrides ElementsRendererAddElement(PageElement).)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events

  NameDescription
Public eventBeforeRenderInPdfPageEvent
The event is raised right before the template is rendered in a PDF page. The template rendering in PDF page can be canceled by setting the CancelRender property on false
Top
See Also

Reference