Table of Contents

Class RtfHeaderFooterGroup

Namespace
iTextSharp.text.rtf.headerfooter
Assembly
iTextSharp.LGPLv2.Core.dll

The RtfHeaderFooterGroup holds 0 - 3 RtfHeaderFooters that create a group of headers or footers. @author Mark Hall (Mark.Hall@mail.room3b.eu)

public class RtfHeaderFooterGroup : HeaderFooter, IElement, IRtfBasicElement, IRtfElementInterface
Inheritance
RtfHeaderFooterGroup
Implements
Inherited Members

Constructors

RtfHeaderFooterGroup()

Constructs a RtfHeaderGroup to which you add headers/footers using via the setHeaderFooter method.

public RtfHeaderFooterGroup()

RtfHeaderFooterGroup(RtfDocument, int)

Constructs a certain type of RtfHeaderFooterGroup. RtfHeaderFooter.TYPE_HEADER and RtfHeaderFooter.TYPE_FOOTER are valid values for type.

public RtfHeaderFooterGroup(RtfDocument doc, int type)

Parameters

doc RtfDocument

The RtfDocument this RtfHeaderFooter belongs to

type int

The type of RtfHeaderFooterGroup to create

RtfHeaderFooterGroup(RtfDocument, HeaderFooter, int)

Constructs a RtfHeaderGroup for a certain HeaderFooter

public RtfHeaderFooterGroup(RtfDocument doc, HeaderFooter headerFooter, int type)

Parameters

doc RtfDocument

The RtfDocument this RtfHeaderFooter belongs to

headerFooter HeaderFooter

The HeaderFooter to display

type int

The typ of RtfHeaderFooterGroup to create

RtfHeaderFooterGroup(RtfDocument, RtfHeaderFooter, int)

Constructs a RtfHeaderFooterGroup for a certain RtfHeaderFooter.

public RtfHeaderFooterGroup(RtfDocument doc, RtfHeaderFooter headerFooter, int type)

Parameters

doc RtfDocument

The RtfDocument this RtfHeaderFooter belongs to

headerFooter RtfHeaderFooter

The RtfHeaderFooter to display

type int

The typ of RtfHeaderFooterGroup to create

RtfHeaderFooterGroup(RtfDocument, RtfHeaderFooterGroup, int)

Constructs a RtfHeaderFooterGroup by copying the content of the original RtfHeaderFooterGroup

public RtfHeaderFooterGroup(RtfDocument doc, RtfHeaderFooterGroup headerFooter, int type)

Parameters

doc RtfDocument

The RtfDocument this RtfHeaderFooter belongs to

headerFooter RtfHeaderFooterGroup

The RtfHeaderFooterGroup to copy

type int

The type of RtfHeaderFooterGroup to create

Methods

GetHeaderAll()

Gets the RtfHeaderFooter for all pages

protected RtfHeaderFooter GetHeaderAll()

Returns

RtfHeaderFooter

The RtfHeaderFooter for all pages

GetHeaderFirst()

Gets the RtfHeaderFooter for the title page

protected RtfHeaderFooter GetHeaderFirst()

Returns

RtfHeaderFooter

The RtfHeaderFooter for the title page

GetHeaderLeft()

Gets the RtfHeaderFooter for all left hand pages

protected RtfHeaderFooter GetHeaderLeft()

Returns

RtfHeaderFooter

The RtfHeaderFooter for all left hand pages

GetHeaderRight()

Gets the RtfHeaderFooter for all right hand pages

protected RtfHeaderFooter GetHeaderRight()

Returns

RtfHeaderFooter

The RtfHeaderFooter for all right hand pages

GetMode()

Gets the mode of this RtfHeaderFooterGroup

protected int GetMode()

Returns

int

The mode of this RtfHeaderFooterGroup

HasFacingPages()

Get whether this RtfHeaderFooterGroup has facing pages

public bool HasFacingPages()

Returns

bool

Whether this RtfHeaderFooterGroup has facing pages

HasTitlePage()

Get whether this RtfHeaderFooterGroup has a titlepage

public bool HasTitlePage()

Returns

bool

Whether this RtfHeaderFooterGroup has a titlepage

SetHasFacingPages()

Set that this RtfHeaderFooterGroup should have facing pages. If only a header / footer for all pages exists, then it will be copied to the left and right pages aswell.

public void SetHasFacingPages()

SetHasTitlePage()

Set that this RtfHeaderFooterGroup should have a title page. If only a header / footer for all pages exists, then it will be copied to the first page aswell.

public void SetHasTitlePage()

SetHeaderFooter(HeaderFooter, int)

Set a HeaderFooter to be displayed at a certain position

public void SetHeaderFooter(HeaderFooter headerFooter, int displayAt)

Parameters

headerFooter HeaderFooter

The HeaderFooter to set

displayAt int

The display location to use

SetHeaderFooter(RtfHeaderFooter, int)

Set a RtfHeaderFooter to be displayed at a certain position

public void SetHeaderFooter(RtfHeaderFooter headerFooter, int displayAt)

Parameters

headerFooter RtfHeaderFooter

The RtfHeaderFooter to display

displayAt int

The display location to use

SetInHeader(bool)

Unused

public void SetInHeader(bool inHeader)

Parameters

inHeader bool

SetInTable(bool)

Unused

public void SetInTable(bool inTable)

Parameters

inTable bool

SetRtfDocument(RtfDocument)

Sets the RtfDocument this RtfElement belongs to

public void SetRtfDocument(RtfDocument doc)

Parameters

doc RtfDocument

The RtfDocument to use

SetType(int)

Set the type of this RtfHeaderFooterGroup. RtfHeaderFooter.TYPE_HEADER or RtfHeaderFooter.TYPE_FOOTER. Also sets the type for all RtfHeaderFooters of this RtfHeaderFooterGroup.

public void SetType(int type)

Parameters

type int

The type to use

WriteContent(Stream)

Write the content of this RtfHeaderFooterGroup.

public virtual void WriteContent(Stream outp)

Parameters

outp Stream