Class HeaderFooter

Namespace

iTextSharp.text

Assembly

iTextSharp.LGPLv2.Core.dll

A HeaderFooter-object is a Rectangle with text that can be put above and/or below every page.

public class HeaderFooter : Rectangle, IElement

Inheritance

object

Element

Rectangle

HeaderFooter

Implements

IElement

Derived

RtfHeaderFooter

RtfHeaderFooterGroup

Inherited Members

Rectangle.BOTTOM_BORDER

Rectangle.BOX

Rectangle.LEFT_BORDER

Rectangle.NO_BORDER

Rectangle.RIGHT_BORDER

Rectangle.TOP_BORDER

Rectangle.UNDEFINED

Rectangle.backgroundColor

Rectangle.border

Rectangle.borderColor

Rectangle.borderColorBottom

Rectangle.borderColorLeft

Rectangle.borderColorRight

Rectangle.borderColorTop

Rectangle.borderWidth

Rectangle.borderWidthBottom

Rectangle.borderWidthLeft

Rectangle.borderWidthRight

Rectangle.borderWidthTop

Rectangle.Llx

Rectangle.Lly

Rectangle.rotation

Rectangle.Urx

Rectangle.Ury

Rectangle.useVariableBorders

Rectangle.IsContent()

Rectangle.IsNestable()

Rectangle.Process(IElementListener)

Rectangle.ToString()

Rectangle.CloneNonPositionParameters(Rectangle)

Rectangle.DisableBorderSide(int)

Rectangle.EnableBorderSide(int)

Rectangle.GetBottom(float)

Rectangle.GetLeft(float)

Rectangle.GetRectangle(float, float)

Rectangle.GetRight(float)

Rectangle.GetTop(float)

Rectangle.HasBorder(int)

Rectangle.HasBorders()

Rectangle.Normalize()

Rectangle.Rotate()

Rectangle.SoftCloneNonPositionParameters(Rectangle)

Rectangle.BackgroundColor

Rectangle.Border

Rectangle.BorderColor

Rectangle.BorderColorBottom

Rectangle.BorderColorLeft

Rectangle.BorderColorRight

Rectangle.BorderColorTop

Rectangle.BorderWidth

Rectangle.BorderWidthBottom

Rectangle.BorderWidthLeft

Rectangle.BorderWidthRight

Rectangle.BorderWidthTop

Rectangle.Bottom

Rectangle.GrayFill

Rectangle.Height

Rectangle.Left

Rectangle.Right

Rectangle.Rotation

Rectangle.Top

Rectangle.UseVariableBorders

Rectangle.Width

Rectangle.Chunks

Rectangle.Type

Element.ALIGN_BASELINE

Element.ALIGN_BOTTOM

Element.ALIGN_CENTER

Element.ALIGN_JUSTIFIED

Element.ALIGN_JUSTIFIED_ALL

Element.ALIGN_LEFT

Element.ALIGN_MIDDLE

Element.ALIGN_RIGHT

Element.ALIGN_TOP

Element.ALIGN_UNDEFINED

Element.ANCHOR

Element.ANNOTATION

Element.AUTHOR

Element.CCITT_BLACKIS1

Element.CCITT_ENCODEDBYTEALIGN

Element.CCITT_ENDOFBLOCK

Element.CCITT_ENDOFLINE

Element.CCITTG3_1D

Element.CCITTG3_2D

Element.CCITTG4

Element.CELL

Element.CHAPTER

Element.CHUNK

Element.CREATIONDATE

Element.CREATOR

Element.HEADER

Element.IMGRAW

Element.IMGTEMPLATE

Element.JBIG2

Element.JPEG

Element.JPEG2000

Element.KEYWORDS

Element.LIST

Element.LISTITEM

Element.MARKED

Element.MULTI_COLUMN_TEXT

Element.PARAGRAPH

Element.PHRASE

Element.PRODUCER

Element.PTABLE

Element.RECTANGLE

Element.ROW

Element.SECTION

Element.SUBJECT

Element.TABLE

Element.TITLE

Element.YMARK

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

HeaderFooter header = new HeaderFooter(new Phrase("This is a header."), false); HeaderFooter footer = new HeaderFooter(new Phrase("This is page "), new Phrase(".")); document.SetHeader(header); document.SetFooter(footer);

Constructors

HeaderFooter(Properties)

public HeaderFooter(Properties attributes)

Parameters

attributes Properties

HeaderFooter(Phrase, bool)

Constructs a Header-object with a pagenumber at the end.

public HeaderFooter(Phrase before, bool numbered)

Parameters

before Phrase

the Phrase before the pagenumber

numbered bool

true if the page has to be numbered

HeaderFooter(Phrase, Phrase)

constructors

public HeaderFooter(Phrase before, Phrase after)

Parameters

before Phrase

the Phrase before the pagenumber

after Phrase

the Phrase after the pagenumber

Properties

After

methods

public Phrase After { get; set; }

Property Value

Phrase

a Phrase

Alignment

Sets the Element.

public int Alignment { get; set; }

Property Value

int

the new alignment

Before

Get/set the part that comes before the pageNumber.

public Phrase Before { get; set; }

Property Value

Phrase

a Phrase

PageNumber

Sets the page number.

public int PageNumber { set; }

Property Value

int

the new page number

Paragraph

Gets the Paragraph that can be used as header or footer.

public Paragraph Paragraph { get; }

Property Value

Paragraph

a Paragraph

Methods

IsNumbered()

Checks if the HeaderFooter contains a page number.

public bool IsNumbered()

Returns

bool

true if the page has to be numbered

SetAlignment(string)

Sets the alignment of this HeaderFooter.

public void SetAlignment(string alignment)

Parameters

alignment string

the new alignment as a string