Class TextHeaderFooter

Defines PDF Header and Footer display options.

TextHeaderFooter uses a logical approach to rendering Headers and Footers for the most common use cases.

Inheritance
System.Object
TextHeaderFooter
HtmlHeaderFooter
Implements
System.ICloneable
Namespace: IronPdf
Assembly: IronPdf.dll
Syntax
public class TextHeaderFooter : Object, ITextHeaderFooter

Constructors

TextHeaderFooter()

Declaration
public TextHeaderFooter()

Properties

CenterText

Sets the centered header text for the PDF document.

Merge meta-data into your header using any of these placeholder strings: {page} {total-pages} {url} {date} {time} {html-title} {pdf-title}

Declaration
public string CenterText { get; set; }
Property Value
Type Description
System.String

DrawDividerLine

Adds a horizontal line divider between the header / footer and the page content on every page of the PDF document.

Declaration
public bool DrawDividerLine { get; set; }
Property Value
Type Description
System.Boolean

DrawDividerLineColor

A Color of divider line DrawDividerLine

Declaration
public Color DrawDividerLineColor { get; set; }
Property Value
Type Description
IronSoftware.Drawing.Color

Font

Font family IronSoftware.Drawing.FontTypes. Default is IronSoftware.Drawing.FontTypes.Helvetica

Declaration
public PdfFont Font { get; set; }
Property Value
Type Description
PdfFont

FontSize

Font size in px.

Declaration
public double FontSize { get; set; }
Property Value
Type Description
System.Double

LeftText

Sets the left hand side header text for the PDF document.

Merge meta-data into your header using any of these placeholder strings: {page} {total-pages} {url} {date} {time} {html-title} {pdf-title}

Declaration
public string LeftText { get; set; }
Property Value
Type Description
System.String

RightText

Sets the right hand side header text for the PDF document.

Merge meta-data into your header using any of these placeholder strings: {page} {total-pages} {url} {date} {time} {html-title} {pdf-title}

Declaration
public string RightText { get; set; }
Property Value
Type Description
System.String

Methods

Clone()

Clones this instance.

Declaration
public object Clone()
Returns
Type Description
System.Object

System.Object of type SimpleHeaderFooter

Implements

System.ICloneable

See Also