A List contains several ListItems. More...

Inheritance diagram for iTextSharp.text.List:

Public Member Functions
	List ()

	List (float symbolIndent)

	List (bool numbered)

	List (bool numbered, bool lettered)

	List (bool numbered, float symbolIndent)
	Constructs a List. More...

	List (bool numbered, bool lettered, float symbolIndent)
	Constructs a List. More...

bool	Process (IElementListener listener)
	Processes the element by adding it (or the different parts) to an IElementListener. More...

virtual bool	Add (Object o)
	Adds an Object to the List. More...

void	NormalizeIndentation ()

void	SetListSymbol (string symbol)
	Sets the listsymbol. More...

bool	IsContent ()

bool	IsNestable ()

virtual bool	IsEmpty ()

String	getPostSymbol ()

Public Member Functions inherited from iTextSharp.text.IElement
string	ToString ()
	Gets the content of the text element. More...

Static Public Attributes
const bool	ORDERED = true

const bool	UNORDERED = false

const bool	NUMERICAL = false

const bool	ALPHABETICAL = true

const bool	UPPERCASE = false

const bool	LOWERCASE = true

Protected Attributes
ArrayList	list = new ArrayList()
	This is the ArrayList containing the different ListItems. More...

bool	numbered = false

bool	lettered = false

bool	lowercase = false

bool	autoindent = false

bool	alignindent = false

int	first = 1
	This variable indicates the first number of a numbered list. More...

Chunk	symbol = new Chunk("-")
	This is the listsymbol of a list that is not numbered. More...

String	preSymbol = ""

String	postSymbol = ". "

float	indentationLeft = 0
	The indentation of this list on the left side. More...

float	indentationRight = 0
	The indentation of this list on the right side. More...

float	symbolIndent = 0
	The indentation of the listitems. More...

Properties
int	Type `[get]`
	Gets the type of the text element. More...

ArrayList	Chunks `[get]`
	Gets all the chunks in this element. More...

bool	Numbered `[get, set]`

bool	Lettered `[get, set]`

bool	Lowercase `[get, set]`

bool	Autoindent `[get, set]`

bool	Alignindent `[get, set]`

int	First `[get, set]`
	Get/set the first number More...

Chunk	ListSymbol `[set]`
	Sets the symbol More...

float	IndentationLeft `[get, set]`
	Get/set the indentation of this paragraph on the left side. More...

float	IndentationRight `[get, set]`
	Get/set the indentation of this paragraph on the right side. More...

float	SymbolIndent `[get, set]`
	Gets the symbol indentation. More...

ArrayList	Items `[get]`
	Gets all the items in the list. More...

int	Size `[get]`
	Gets the size of the list. More...

float	TotalLeading `[get]`
	Gets the leading of the first listitem. More...

Chunk	Symbol `[get, set]`
	Get/set the symbol indentation. More...

String	PostSymbol `[get, set]`

String	PreSymbol `[get, set]`

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...

Detailed Description

A List contains several ListItems.

Example 1:

<strong>List list = new List(true, 20);
list.Add(new ListItem("First line"));
list.Add(new ListItem("The second line is longer to see what happens once the end of the line is reached. Will it start on a new line?"));
list.Add(new ListItem("Third line"));</strong>

The result of this code looks like this:

First line
The second line is longer to see what happens once the end of the line is reached. Will it start on a new line?
Third line

Example 2:

<strong>List overview = new List(false, 10);
overview.Add(new ListItem("This is an item"));
overview.Add("This is another item");</strong>

The result of this code looks like this:

This is an item
This is another item

See also: T:iTextSharp.text.Element, T:iTextSharp.text.ListItem

Constructor & Destructor Documentation

◆ List() [1/6]

iTextSharp.text.List.List ( )

Constructs a List.

◆ List() [2/6]

iTextSharp.text.List.List ( float symbolIndent )

Constructs a List with a specific symbol indentation.

Parameters

symbolIndent the symbol indentation

Since: iText 2.0.8

◆ List() [3/6]

iTextSharp.text.List.List ( bool numbered )

Constructs a List.

Parameters

numbered a bool

◆ List() [4/6]

iTextSharp.text.List.List	(	bool	numbered,
		bool	lettered
	)

Constructs a List.

Parameters

numbered	a bool
lettered	has the list to be 'numbered' with letters

◆ List() [5/6]

iTextSharp.text.List.List	(	bool	numbered,
		float	symbolIndent
	)

Constructs a List.

the parameter symbolIndent is important for instance when generating PDF-documents; it indicates the indentation of the listsymbol.

Parameters

numbered	a bool
symbolIndent	the indentation that has to be used for the listsymbol

◆ List() [6/6]

iTextSharp.text.List.List	(	bool	numbered,
		bool	lettered,
		float	symbolIndent
	)

Constructs a List.

Parameters

numbered	a bool
lettered	a bool
symbolIndent	the indentation that has to be used for the listsymbol

Member Function Documentation

◆ Add()

virtual bool iTextSharp.text.List.Add ( Object o )

virtual

Adds an Object to the List.

Parameters

o	the object to add

Returns: true is successful

Implements iTextSharp.text.ITextElementArray.

Reimplemented in iTextSharp.text.ZapfDingbatsNumberList, iTextSharp.text.ZapfDingbatsList, iTextSharp.text.RomanList, and iTextSharp.text.GreekList.

◆ getPostSymbol()

String iTextSharp.text.List.getPostSymbol ( )

Returns the String that is after a number or letter in the list symbol.

Returns: the String that is after a number or letter in the list symbol

Since: iText 2.1.1

◆ IsContent()

bool iTextSharp.text.List.IsContent ( )

See also: com.lowagie.text.Element::isContent()

Since: iText 2.0.8

Implements iTextSharp.text.IElement.

◆ IsEmpty()

virtual bool iTextSharp.text.List.IsEmpty ( )

virtual

Returns true if the list is empty.

Returns: true if the list is empty

◆ IsNestable()

bool iTextSharp.text.List.IsNestable ( )

See also: com.lowagie.text.Element::isNestable()

Since: iText 2.0.8

Implements iTextSharp.text.IElement.

◆ NormalizeIndentation()

void iTextSharp.text.List.NormalizeIndentation ( )

Makes sure all the items in the list have the same indentation.

◆ Process()

bool iTextSharp.text.List.Process ( IElementListener listener )

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

Parameters

listener an IElementListener

Returns: true if the element was processed successfully

Implements iTextSharp.text.IElement.

◆ SetListSymbol()

void iTextSharp.text.List.SetListSymbol ( string symbol )

Sets the listsymbol.

This is a shortcut for SetListSymbol(Chunk symbol).

Parameters

symbol a string

Member Data Documentation

◆ alignindent

bool iTextSharp.text.List.alignindent = false

protected

Indicates if the indentation of all the items has to be aligned.

◆ ALPHABETICAL

const bool iTextSharp.text.List.ALPHABETICAL = true

static

a possible value for the lettered parameter

◆ autoindent

bool iTextSharp.text.List.autoindent = false

protected

Indicates if the indentation has to be set automatically.

◆ first

int iTextSharp.text.List.first = 1

protected

This variable indicates the first number of a numbered list.

◆ indentationLeft

float iTextSharp.text.List.indentationLeft = 0

protected

The indentation of this list on the left side.

◆ indentationRight

float iTextSharp.text.List.indentationRight = 0

protected

The indentation of this list on the right side.

◆ lettered

bool iTextSharp.text.List.lettered = false

protected

Indicates if the listsymbols are numerical or alphabetical.

◆ list

ArrayList iTextSharp.text.List.list = new ArrayList()

protected

This is the ArrayList containing the different ListItems.

◆ LOWERCASE

const bool iTextSharp.text.List.LOWERCASE = true

static

a possible value for the lettered parameter

◆ lowercase

bool iTextSharp.text.List.lowercase = false

protected

Indicates if the listsymbols are lowercase or uppercase.

◆ numbered

bool iTextSharp.text.List.numbered = false

protected

Indicates if the list has to be numbered.

◆ NUMERICAL

const bool iTextSharp.text.List.NUMERICAL = false

static

a possible value for the lettered parameter

◆ ORDERED

const bool iTextSharp.text.List.ORDERED = true

static

a possible value for the numbered parameter

◆ postSymbol

String iTextSharp.text.List.postSymbol = ". "

protected

In case you are using numbered/lettered lists, this String is added after the number/letter.

Since: iText 2.1.1

◆ preSymbol

String iTextSharp.text.List.preSymbol = ""

protected

In case you are using numbered/lettered lists, this String is added before the number/letter.

Since: iText 2.1.1

◆ symbol

Chunk iTextSharp.text.List.symbol = new Chunk("-")

protected

This is the listsymbol of a list that is not numbered.

◆ symbolIndent

float iTextSharp.text.List.symbolIndent = 0

protected

The indentation of the listitems.

◆ UNORDERED

const bool iTextSharp.text.List.UNORDERED = false

static

a possible value for the numbered parameter

◆ UPPERCASE

const bool iTextSharp.text.List.UPPERCASE = false

static

a possible value for the lettered parameter

Property Documentation

◆ Alignindent

bool iTextSharp.text.List.Alignindent

getset

◆ Autoindent

bool iTextSharp.text.List.Autoindent

getset

◆ Chunks

ArrayList iTextSharp.text.List.Chunks

get

Gets all the chunks in this element.

an ArrayList

◆ First

int iTextSharp.text.List.First

getset

Get/set the first number

an int

◆ IndentationLeft

float iTextSharp.text.List.IndentationLeft

getset

Get/set the indentation of this paragraph on the left side.

the indentation

◆ IndentationRight

float iTextSharp.text.List.IndentationRight

getset

Get/set the indentation of this paragraph on the right side.

the indentation

◆ Items

ArrayList iTextSharp.text.List.Items

get

Gets all the items in the list.

an ArrayList containing ListItems

◆ Lettered

bool iTextSharp.text.List.Lettered

getset

◆ ListSymbol

Chunk iTextSharp.text.List.ListSymbol

set

Sets the symbol

a Chunk

◆ Lowercase

bool iTextSharp.text.List.Lowercase

getset

◆ Numbered

bool iTextSharp.text.List.Numbered

getset

◆ PostSymbol

String iTextSharp.text.List.PostSymbol

getset

Sets the String that has to be added after a number or letter in the list symbol.

Since: iText 2.1.1

Parameters

postSymbol the String that has to be added after a number or letter in the list symbol.

◆ PreSymbol

String iTextSharp.text.List.PreSymbol

getset

Sets the String that has to be added before a number or letter in the list symbol.

Since: iText 2.1.1

Parameters

preSymbol the String that has to be added before a number or letter in the list symbol.

◆ Size

int iTextSharp.text.List.Size

get

Gets the size of the list.

a size

◆ Symbol

Chunk iTextSharp.text.List.Symbol

getset

Get/set the symbol indentation.

a Chunk

◆ SymbolIndent

float iTextSharp.text.List.SymbolIndent

getset

Gets the symbol indentation.

the symbol indentation

◆ TotalLeading

float iTextSharp.text.List.TotalLeading

get

Gets the leading of the first listitem.

a leading

◆ Type

int iTextSharp.text.List.Type

get

Gets the type of the text element.

a type

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

src/core/iTextSharp/text/List.cs

Public Member Functions

Static Public Attributes

Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ List() [1/6]

◆ List() [2/6]

◆ List() [3/6]

◆ List() [4/6]

◆ List() [5/6]

◆ List() [6/6]

Member Function Documentation

◆ Add()

◆ getPostSymbol()

◆ IsContent()

◆ IsEmpty()

◆ IsNestable()

◆ NormalizeIndentation()

◆ Process()

◆ SetListSymbol()

Member Data Documentation

◆ alignindent

◆ ALPHABETICAL

◆ autoindent

◆ first

◆ indentationLeft

◆ indentationRight

◆ lettered

◆ list

◆ LOWERCASE

◆ lowercase

◆ numbered

◆ NUMERICAL

◆ ORDERED

◆ postSymbol

◆ preSymbol

◆ symbol

◆ symbolIndent

◆ UNORDERED

◆ UPPERCASE

Property Documentation

◆ Alignindent

◆ Autoindent

◆ Chunks

◆ First

◆ IndentationLeft

◆ IndentationRight

◆ Items

◆ Lettered

◆ ListSymbol

◆ Lowercase

◆ Numbered

◆ PostSymbol

◆ PreSymbol

◆ Size

◆ Symbol

◆ SymbolIndent

◆ TotalLeading

◆ Type