PdfTemplate Class

Represents a reusable template object

Definition

Namespace: HiQPdf.Next
Assembly: HiQPdf.Next (in HiQPdf.Next.dll) Version: 18.9.2
C#
public class PdfTemplate
Inheritance
Object    PdfTemplate

Properties

Height Gets the template height in points
HorizontalAlign Specifies the horizontal alignment of the template on the PDF page. Takes precedence over the X coordinate when set to a value other than None. The default value is None. This property cannot be changed after document rendering has started
OnPageRendering Optional callback invoked before the template is rendered on a page. Return true to allow rendering or false to skip rendering on the current page. This callback is evaluated after the ShowInFirstPage, ShowInOddPages and ShowInEvenPages conditions are applied. The callback receives the final placement of the template on the current page
Opacity The opacity as a value between 0 and 1 to be applied to entire template. For example, setting this property to 0.75 will lower the opacity to 75% . The default value is 1 and the rendered PDF content will have its original opacity
RotationDegrees Rotation angle in degrees applied to the entire template. Positive values rotate counter-clockwise. Default is 0 (no rotation). This property cannot be changed after document rendering has started
RotationPivot Pivot used when rotating the template. The default value is TopLeft. This property cannot be changed after document rendering has started
ShowInEvenPages Specifies whether the template should be displayed on even-numbered pages of the PDF document The default value is true
ShowInFirstPage Specifies whether the template should be displayed on the first page of the PDF document The default value is true
ShowInOddPages Specifies whether the template should be displayed on odd-numbered pages of the PDF document The default value is true
VerticalAlign Specifies the vertical alignment of the template on the PDF page. Takes precedence over the Y coordinate when set to a value other than None. The default value is None. This property cannot be changed after document rendering has started
Width Gets the template width in points
X Gets or sets the X position of the template in the PDF pages relative to the top left of the page. This property is ignored for header and footer templates. This property cannot be changed after document rendering has started
Y Gets or sets the Y position of the template in the PDF pages relative to the top left of the page. This property is ignored for header and footer templates. This property cannot be changed after document rendering has started

Methods

AddArc Draws an elliptical arc into this template
AddCircle Draws a circle defined by center and radius into this template
AddEllipse Draws an ellipse inscribed in a bounding rectangle into this template
AddImage Adds an image element to the PDF template. Supports byte array or file path images, scaling and alignment. The image is rendered into the template coordinate space; the returned bounding box is relative to the template, not to any page where the template is later placed
AddLine Draws a straight line between two points into this template
AddPath Draws a generic path composed of move, line and curve operations into this template
AddPolygon Draws a closed polygon through a sequence of vertices into this template
AddPolyline Draws an open polyline through a sequence of points into this template
AddRectangle Draws a rectangle into this template
AddRoundedRectangle Draws a rectangle with rounded corners into this template
AddText Adds a text element to the PDF template. Supports placeholder variables such as {page_number} and {total_pages}, which are replaced with their actual values in the rendered PDF. When placeholder variables are used, the text element is rendered when the document is saved
Equals
(Inherited from Object)
Finalize
(Inherited from Object)
GetHashCode
(Inherited from Object)
GetType
(Inherited from Object)
MemberwiseClone
(Inherited from Object)
ToString
(Inherited from Object)

See Also