Headers And Footers


Headers And Footers

Headers and Footers are custom types of pdf templates. They can be handled using the Header and Footer properties of the PdfDocument object.

Header is displayed at the top of the page. Footer is displayed at the bottom of the page. They contains elements that repeat on each page of the pdf document.

Sample Code

This sample code shows how to create a new PDF document using Select.Pdf, how to add several pages and set the header and footer of the pdf document.

Copy

// create a new pdf document
PdfDocument doc = new PdfDocument();
doc.Margins = new PdfMargins(10, 10, 0, 0);

// create a new pdf font
PdfFont font = doc.AddFont(PdfStandardFont.Helvetica);
font.Size = 24;

// create a new pdf font
PdfFont font2 = doc.AddFont(PdfStandardFont.Helvetica);
font2.Size = 12;
font2.IsUnderline = true;

// add a new page to the document
PdfPage page = doc.AddPage();

// get image path
string imgFile = Server.MapPath("~/files/logo.png");

// header template (100 points in height) with image element
doc.Header = doc.AddTemplate(doc.Pages[0].ClientRectangle.Width, 100);
PdfImageElement img1 = new PdfImageElement(0, 0, imgFile);
doc.Header.Add(img1);

// footer template (100 points in height) with text element
doc.Footer = doc.AddTemplate(doc.Pages[0].ClientRectangle.Width, 100);
PdfTextElement text1 = new PdfTextElement(0, 50, 
    "Footer text: Document generated by Select.Pdf", font2);
text1.ForeColor = System.Drawing.Color.Blue;
doc.Footer.Add(text1);

// create a new text element and add it to the page if page elements are added 
// after header and footer is set, they will not be displayed in those areas.
PdfTextElement text = new PdfTextElement(0, 0, Helper.SomeLongText(), font);
page.Add(text);

// save pdf document
doc.Save(Response, false, "Sample.pdf");

// close pdf document
doc.Close();

' create a new pdf document
Dim doc As New PdfDocument()
doc.Margins = New PdfMargins(10, 10, 0, 0)

' create a new pdf font
Dim font As PdfFont = doc.AddFont(PdfStandardFont.Helvetica)
font.Size = 24

' create a new pdf font
Dim font2 As PdfFont = doc.AddFont(PdfStandardFont.Helvetica)
font2.Size = 12
font2.IsUnderline = True

' add a new page to the document
Dim page As PdfPage = doc.AddPage()

' get image path
Dim imgFile As String = Server.MapPath("~/files/logo.png")

' header template (100 points in height) with image element
doc.Header = doc.AddTemplate(doc.Pages(0).ClientRectangle.Width, 100)
Dim img1 As New PdfImageElement(0, 0, imgFile)
doc.Header.Add(img1)

' footer template (100 points in height) with text element
doc.Footer = doc.AddTemplate(doc.Pages(0).ClientRectangle.Width, 100)
Dim text1 As New PdfTextElement(0, 50, _
        "Footer text: Document generated by Select.Pdf", font2)
text1.ForeColor = System.Drawing.Color.Blue
doc.Footer.Add(text1)

' create a new text element and add it to the page
' if page elements are added after header and footer is set, 
' they will not be displayed in those areas.
Dim text As New PdfTextElement(0, 0, Helper.SomeLongText(), font)
page.Add(text)

' save pdf document
doc.Save(Response, False, "Sample.pdf")

' close pdf document
doc.Close()

Reference

PdfDocument

PdfTemplate

Other Resources

Pdf Templates