Click or drag to resize
Pdf Library for .NET

PdfTemplateCollection Class

Represents the collection of templates of a pdf document. A template is repeated on more than one page of the pdf document. Reached via Templates.
Inheritance Hierarchy
SystemObject
  SelectPdf.UniversalPdfTemplateCollection

Namespace: SelectPdf.Universal
Assembly: SelectPdf.Universal (in SelectPdf.Universal.dll) Version: 26.4
Syntax
Copy
public class PdfTemplateCollection : IEnumerable

The PdfTemplateCollection type exposes the following members.

Properties
 NameDescription
Public propertyCount The number of templates added via Add(Single, Single) / Add(RectangleF).
Public propertyFooter Represents the default pdf document footer template. It is automatically docked to the bottom of the page and its height is reserved when laying out page content.
Public propertyHeader Represents the default pdf document header template. It is automatically docked to the top of the page and its height is reserved when laying out page content.
Public propertyItem Gets the template at the specified zero based index in the templates collection.
Top
Methods
 NameDescription
Public methodAdd(RectangleF) Adds a new template with the specified bounds.
Public methodCode exampleAdd(Single, Single) Adds a new template with the specified width and height. The template location is the top-left corner of the page; use Add(RectangleF) to specify another location.
Public methodGetEnumerator Gets the collection enumerator (over the templates added via Add(Single, Single)).
Top
Example
Copy
PdfDocument doc = new PdfDocument();
doc.AddPage();
PdfTemplate header = doc.Templates.Add(doc.Pages[0].PageSize.Width, 40);
header.Add(new PdfTextElement(0, 10, "REPORT",
    PdfFont.CreateStandardFont(PdfStandardFont.HelveticaBold, 14),
    new PdfColor(0, 0, 0)));
doc.Templates.Header = header;
doc.Save("report.pdf");
See Also