Class RtfDocumentHeader

Namespace

iTextSharp.text.rtf.document

Assembly

iTextSharp.LGPLv2.Core.dll

The RtfDocumentHeader contains all classes required for the generation of the document header area. @author Mark Hall (Mark.Hall@mail.room3b.eu) @author Thomas Bickel (tmb99@inode.at)

public class RtfDocumentHeader : RtfElement, IRtfBasicElement, IRtfElementInterface

Inheritance

object

RtfElement

RtfDocumentHeader

Implements

IRtfBasicElement

IRtfElementInterface

Inherited Members

RtfElement.TWIPS_FACTOR

RtfElement.CloseGroup

RtfElement.CommaDelimiter

RtfElement.Delimiter

RtfElement.OpenGroup

RtfElement.Document

RtfElement.InHeader

RtfElement.InTable

RtfElement.SetInHeader(bool)

RtfElement.SetInTable(bool)

RtfElement.SetRtfDocument(RtfDocument)

RtfElement.IntToByteArray(int)

RtfElement.IsInTable()

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

RtfDocumentHeader(RtfDocument)

Constructs a RtfDocumentHeader for a RtfDocument

protected RtfDocumentHeader(RtfDocument doc)

Parameters

doc RtfDocument

The RtfDocument this RtfDocumentHeader belongs to

Methods

AddInfoElement(RtfInfoElement)

Adds an RtfInfoElement to the list of RtfInfoElements

public void AddInfoElement(RtfInfoElement rtfInfoElement)

Parameters

rtfInfoElement RtfInfoElement

The RtfInfoElement to add

FreeListNumber(RtfList)

Removes a RtfList from the list table

public void FreeListNumber(RtfList list)

Parameters

list RtfList

The RtfList to remove

GetColorNumber(RtfColor)

Gets the number of the specified RtfColor

public int GetColorNumber(RtfColor color)

Parameters

color RtfColor

The RtfColor for which to get the number

Returns

int

The number of the color

GetFontNumber(RtfFont)

Gets the number of the specified RtfFont

public int GetFontNumber(RtfFont font)

Parameters

font RtfFont

The RtfFont for which to get the number

Returns

int

The number of the font

GetListNumber(RtfList)

Gets the number of the specified RtfList

public int GetListNumber(RtfList list)

Parameters

list RtfList

The RtfList for which to get the number

Returns

int

The number of the list

GetListTable()

Get the RtfListTable object. @since 2.1.3

public RtfListTable GetListTable()

Returns

RtfListTable

the ListTable object.

GetPageSetting()

Gets the RtfPageSetting object of this RtfDocument

public RtfPageSetting GetPageSetting()

Returns

RtfPageSetting

The RtfPageSetting object

GetRtfParagraphStyle(string)

Gets the RtfParagraphStyle with the given style name.

public RtfParagraphStyle GetRtfParagraphStyle(string styleName)

Parameters

styleName string

The style name of the RtfParagraphStyle to get.

Returns

RtfParagraphStyle

The RtfParagraphStyle with the given style name or null.

Init()

Initialises the RtfDocumentHeader.

protected void Init()

RegisterParagraphStyle(RtfParagraphStyle)

Registers the RtfParagraphStyle for further use in the document.

public void RegisterParagraphStyle(RtfParagraphStyle rtfParagraphStyle)

Parameters

rtfParagraphStyle RtfParagraphStyle

The RtfParagraphStyle to register.

SetFooter(HeaderFooter)

Sets the current footer to use

public void SetFooter(HeaderFooter footer)

Parameters

footer HeaderFooter

The HeaderFooter to use as footer

SetHeader(HeaderFooter)

Sets the current header to use

public void SetHeader(HeaderFooter header)

Parameters

header HeaderFooter

The HeaderFooter to use as header

WriteContent(Stream)

Write the contents of the document header area.

public override void WriteContent(Stream outp)

Parameters

outp Stream

WriteSectionDefinition(Stream)

Writes the section definition data

public void WriteSectionDefinition(Stream result)

Parameters

result Stream