iTextSharp.text.MarkedSection Class Reference

Inheritance diagram for iTextSharp.text.MarkedSection:

Public Member Functions
	MarkedSection (Section section)
void	Add (int index, Object o)
bool	Add (Object o)
override bool	Process (IElementListener listener)
bool	AddAll (ICollection collection)
MarkedSection	AddSection (float indentation, int numberDepth)
MarkedSection	AddSection (float indentation)
MarkedSection	AddSection (int numberDepth)
MarkedSection	AddSection ()
void	NewPage ()
Public Member Functions inherited from iTextSharp.text.MarkedObject
	MarkedObject (IElement element)
bool	IsContent ()
bool	IsNestable ()
virtual void	SetMarkupAttribute (String key, String value)
Public Member Functions inherited from iTextSharp.text.IElement
string	ToString ()
	Gets the content of the text element. More...

Protected Attributes
MarkedObject	title = null

Properties
MarkedObject	Title [get, set]
int	NumberDepth [set]
float	IndentationLeft [set]
float	IndentationRight [set]
float	Indentation [set]
bool	BookmarkOpen [set]
bool	TriggerNewPage [set]
String	BookmarkTitle [set]
Properties inherited from iTextSharp.text.MarkedObject
virtual ArrayList	Chunks [get]
virtual int	Type [get]
virtual Properties	MarkupAttributes [get]
Properties inherited from iTextSharp.text.IElement
int	Type [get]
	Gets the type of the text element. More...
ArrayList	Chunks [get]
	Gets all the chunks in this element. More...

Additional Inherited Members
Protected Member Functions inherited from iTextSharp.text.MarkedObject
	MarkedObject ()

Detailed Description

Wrapper that allows to add properties to a Chapter/Section object. Before iText 1.5 every 'basic building block' implemented the MarkupAttributes interface. By setting attributes, you could add markup to the corresponding XML and/or HTML tag. This functionality was hardly used by anyone, so it was removed, and replaced by the MarkedObject functionality.

Constructor & Destructor Documentation

MarkedSection()

iTextSharp.text.MarkedSection.MarkedSection

(

Section

section

)

Creates a MarkedObject with a Section or Chapter object.

Parameters

section

the marked section

Member Function Documentation

Add() [1/2]

void iTextSharp.text.MarkedSection.Add	(	int	index,
		Object	o
	)

Adds a Paragraph, List or Table to this Section.

Parameters

index	index at which the specified element is to be inserted
o	an object of type Paragraph, List or Table=

Exceptions

ClassCastException

if the object is not a Paragraph, List or Table

Add() [2/2]

bool iTextSharp.text.MarkedSection.Add

(

Object

o

)

Adds a Paragraph, List, Table or another Section to this Section.

Parameters

o	an object of type Paragraph, List, Table or another Section

Returns

a bool

Exceptions

ClassCastException

if the object is not a Paragraph, List, Table or Section

AddAll()

bool iTextSharp.text.MarkedSection.AddAll

(

ICollection

collection

)

Adds a collection of Elements to this Section.

Parameters

collection

a collection of Paragraphs, Lists and/or Tables

Returns

true if the action succeeded, false if not.

Exceptions

ClassCastException

if one of the objects isn't a Paragraph, List, Table

AddSection() [1/4]

MarkedSection iTextSharp.text.MarkedSection.AddSection

(

)

Creates a Section, adds it to this Section and returns it.

Returns

a new Section object

AddSection() [2/4]

MarkedSection iTextSharp.text.MarkedSection.AddSection

(

float

indentation

)

Creates a Section, adds it to this Section and returns it.

Parameters

indentation

the indentation of the new section

Returns

a new Section object

AddSection() [3/4]

MarkedSection iTextSharp.text.MarkedSection.AddSection	(	float	indentation,
		int	numberDepth
	)

Creates a Section, adds it to this Section and returns it.

Parameters

indentation	the indentation of the new section
numberDepth	the numberDepth of the section

Returns

a new Section object

AddSection() [4/4]

MarkedSection iTextSharp.text.MarkedSection.AddSection

(

int

numberDepth

)

Creates a Section, add it to this Section and returns it.

Parameters

numberDepth

the numberDepth of the section

Returns

a new Section object

NewPage()

void iTextSharp.text.MarkedSection.NewPage

(

)

Adds a new page to the section.

Since

2.1.1

Process()

override bool iTextSharp.text.MarkedSection.Process ( IElementListener  listener )

virtual

Processes the element by adding it (or the different parts) to an ElementListener.

Parameters

listener

an ElementListener

Returns

true if the element was processed successfully

Reimplemented from iTextSharp.text.MarkedObject.

Member Data Documentation

title

MarkedObject iTextSharp.text.MarkedSection.title = null

protected

This is the title of this section.

Property Documentation

BookmarkOpen

bool iTextSharp.text.MarkedSection.BookmarkOpen

set

Setter for property bookmarkOpen.

Parameters

bookmarkOpen

false if the bookmark children are not visible.

BookmarkTitle

String iTextSharp.text.MarkedSection.BookmarkTitle

set

Sets the bookmark title. The bookmark title is the same as the section title but can be changed with this method.

Parameters

bookmarkTitle

the bookmark title

Indentation

float iTextSharp.text.MarkedSection.Indentation

set

Sets the indentation of the content of this Section.

Parameters

indentation

the indentation

IndentationLeft

float iTextSharp.text.MarkedSection.IndentationLeft

set

Sets the indentation of this Section on the left side.

Parameters

indentation

the indentation

IndentationRight

float iTextSharp.text.MarkedSection.IndentationRight

set

Sets the indentation of this Section on the right side.

Parameters

indentation

the indentation

NumberDepth

int iTextSharp.text.MarkedSection.NumberDepth

set

Sets the depth of the sectionnumbers that will be shown preceding the title.

If the numberdepth is 0, the sections will not be numbered. If the numberdepth is 1, the section will be numbered with their own number. If the numberdepth is higher (for instance x > 1), the numbers of x - 1 parents will be shown.

Parameters

numberDepth

the new numberDepth

Title

MarkedObject iTextSharp.text.MarkedSection.Title

getset

Sets the title of this section.

Parameters

title

the new title

TriggerNewPage

bool iTextSharp.text.MarkedSection.TriggerNewPage

set

Setter for property triggerNewPage.

Parameters

triggerNewPage

true if a new page has to be triggered.

---

The documentation for this class was generated from the following file:

• src/core/iTextSharp/text/MarkedSection.cs