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

Use TextHeaderFooter in IronPDF when a C# application works with PDF generation. It represents PDF Header and Footer display options.

TextHeaderFooter matters when an application needs to configure or invoke PDF generation from C# code. The class encapsulates the related options and behavior in a single object that is set up once and reused across render or processing calls. Typical scenarios include batch generation pipelines, templated document workflows, and integration with existing C# document services.

To use TextHeaderFooter, instantiate or obtain it from the relevant entry point in the IronPDF C# API. Key properties include CenterText, DrawDividerLine, DrawDividerLineColor, Font. Assign options or invoke methods on the instance to configure or perform the operation. The headers and footers covers typical usage in C# end to end.

using IronPdf;

var instance = new TextHeaderFooter();
var current = instance.CenterText;
// Read or assign other properties such as DrawDividerLine, DrawDividerLineColor
instance.Clone();

For the broader workflow, see the draw text and bitmap guide in the IronPDF C# documentation. For broader context, the PDF generation portion of the IronPDF C# API contains related types that work with TextHeaderFooter directly. TextHeaderFooter exposes additional members beyond those highlighted above; the reference tables on this page list the full set. In application code, treat TextHeaderFooter as a configured object that is constructed once and reused across operations rather than instantiated per call. Configuration is generally idempotent: assigning the same property value twice has the same effect as assigning it once. For diagnostic purposes, inspect the relevant TextHeaderFooter property after each operation to confirm the configured state. See the constructors, properties, and methods tables below for the complete API surface of TextHeaderFooter. Application code typically obtains or instantiates a single TextHeaderFooter and shares it across multiple IronPDF operations rather than recreating it per call.

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

HtmlHeaderFooter