HiraokaHyperTools.iTextSharp-LGPL  0.2.5
iTextSharp.text.ListItem Class Reference

A ListItem is a Paragraph that can be added to a List. More...

Inheritance diagram for iTextSharp.text.ListItem:
iTextSharp.text.Paragraph iTextSharp.text.Phrase iTextSharp.text.ITextElementArray iTextSharp.text.IElement

Public Member Functions

 ListItem ()
 Constructs a ListItem. More...
 
 ListItem (float leading)
 Constructs a ListItem with a certain leading. More...
 
 ListItem (Chunk chunk)
 Constructs a ListItem with a certain Chunk. More...
 
 ListItem (string str)
 Constructs a ListItem with a certain string. More...
 
 ListItem (string str, Font font)
 Constructs a ListItem with a certain string and a certain Font. More...
 
 ListItem (float leading, Chunk chunk)
 Constructs a ListItem with a certain Chunk and a certain leading. More...
 
 ListItem (float leading, string str)
 Constructs a ListItem with a certain string and a certain leading. More...
 
 ListItem (float leading, string str, Font font)
 Constructs a ListItem with a certain leading, string and Font. More...
 
 ListItem (Phrase phrase)
 Constructs a ListItem with a certain Phrase. More...
 
void SetIndentationLeft (float indentation, bool autoindent)
 
- Public Member Functions inherited from iTextSharp.text.Paragraph
 Paragraph ()
 Constructs a Paragraph. More...
 
 Paragraph (float leading)
 Constructs a Paragraph with a certain leading. More...
 
 Paragraph (Chunk chunk)
 Constructs a Paragraph with a certain Chunk. More...
 
 Paragraph (float leading, Chunk chunk)
 Constructs a Paragraph with a certain Chunk and a certain leading. More...
 
 Paragraph (string str)
 Constructs a Paragraph with a certain string. More...
 
 Paragraph (string str, Font font)
 Constructs a Paragraph with a certain string and a certain Font. More...
 
 Paragraph (float leading, string str)
 Constructs a Paragraph with a certain string and a certain leading. More...
 
 Paragraph (float leading, string str, Font font)
 Constructs a Paragraph with a certain leading, string and Font. More...
 
 Paragraph (Phrase phrase)
 Constructs a Paragraph with a certain Phrase. More...
 
override bool Add (Object o)
 Adds an Object to the Paragraph. More...
 
void SetAlignment (string alignment)
 Sets the alignment of this paragraph. More...
 
void SetLeading (float fixedLeading, float multipliedLeading)
 
- Public Member Functions inherited from iTextSharp.text.Phrase
 Phrase ()
 Constructs a Phrase without specifying a leading. More...
 
 Phrase (Phrase phrase)
 
 Phrase (float leading)
 Constructs a Phrase with a certain leading. More...
 
 Phrase (Chunk chunk)
 Constructs a Phrase with a certain Chunk. More...
 
 Phrase (float leading, Chunk chunk)
 Constructs a Phrase with a certain Chunk and a certain leading. More...
 
 Phrase (string str)
 Constructs a Phrase with a certain string. More...
 
 Phrase (string str, Font font)
 Constructs a Phrase with a certain string and a certain Font. More...
 
 Phrase (float leading, string str)
 Constructs a Phrase with a certain leading and a certain string. More...
 
 Phrase (float leading, string str, Font font)
 
virtual bool Process (IElementListener listener)
 Processes the element by adding it (or the different parts) to an iTextSharp.text.IElementListener. More...
 
bool IsContent ()
 
bool IsNestable ()
 
virtual void Add (int index, Object o)
 Adds a Chunk, an Anchor or another Phrase to this Phrase. More...
 
bool AddAll (ICollection collection)
 Adds a collection of Chunks to this Phrase. More...
 
void AddSpecial (Object obj)
 Adds a Object to the Paragraph. More...
 
bool IsEmpty ()
 Checks is this Phrase contains no or 1 empty Chunk. More...
 
bool HasLeading ()
 
override string ToString ()
 Gets the content of the text element. More...
 

Static Public Member Functions

static new bool IsTag (string tag)
 Checks if a given tag corresponds with this object. More...
 
- Static Public Member Functions inherited from iTextSharp.text.Paragraph
static new bool IsTag (string tag)
 Checks if a given tag corresponds with this object. More...
 
- Static Public Member Functions inherited from iTextSharp.text.Phrase
static bool IsTag (string tag)
 Checks if a given tag corresponds with this object. More...
 
static Phrase GetInstance (String str)
 
static Phrase GetInstance (int leading, String str)
 
static Phrase GetInstance (int leading, String str, Font font)
 

Properties

override int Type [get]
 Gets the type of the text element. More...
 
Chunk ListSymbol [get, set]
 Get/set the listsymbol. More...
 
- Properties inherited from iTextSharp.text.Paragraph
override int Type [get]
 Gets the type of the text element. More...
 
override float Leading [set]
 
float MultipliedLeading [get, set]
 
int Alignment [get, set]
 Get/set the alignment of this paragraph. 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 SpacingBefore [get, set]
 
float SpacingAfter [get, set]
 
bool KeepTogether [get, set]
 Set/get if this paragraph has to be kept together on one page. More...
 
float? TotalLeading [get]
 
float FirstLineIndent [get, set]
 
float ExtraParagraphSpace [get, set]
 
- Properties inherited from iTextSharp.text.Phrase
virtual int Type [get]
 Gets the type of the text element. More...
 
virtual ArrayList Chunks [get]
 Gets all the chunks in this element. More...
 
virtual float Leading [get, set]
 Gets/sets the leading of this phrase. More...
 
Font Font [get, set]
 Gets the font of the first Chunk that appears in this Phrase. More...
 
String Content [get]
 
IHyphenationEvent Hyphenation [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...
 

Additional Inherited Members

- Protected Member Functions inherited from iTextSharp.text.Phrase
bool AddChunk (Chunk chunk)
 Adds a Chunk. More...
 
- Protected Attributes inherited from iTextSharp.text.Paragraph
int alignment = Element.ALIGN_UNDEFINED
 The alignment of the text. More...
 
float multipliedLeading = 0
 summary> The indentation of this paragraph on the left side. More...
 
float indentationLeft
 summary> The indentation of this paragraph on the right side. More...
 
float indentationRight
 
float spacingBefore
 
float spacingAfter
 
bool keeptogether = false
 
- Protected Attributes inherited from iTextSharp.text.Phrase
Single leading = Single.NaN
 This is the leading of this phrase. More...
 
Font font
 
IHyphenationEvent hyphenation = null
 

Detailed Description

A ListItem is a Paragraph that can be added to a List.

Example 1:

List list = new List(true, 20);
list.Add(<strong>new ListItem("First line")</strong>);
list.Add(<strong>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?")</strong>);
list.Add(<strong>new ListItem("Third line")</strong>);
ListItem()
Constructs a ListItem.
Definition: ListItem.cs:114

The result of this code looks like this:

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

Example 2:

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

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.List, T:iTextSharp.text.Paragraph

Constructor & Destructor Documentation

◆ ListItem() [1/9]

iTextSharp.text.ListItem.ListItem ( )

Constructs a ListItem.

◆ ListItem() [2/9]

iTextSharp.text.ListItem.ListItem ( float  leading)

Constructs a ListItem with a certain leading.

Parameters
leadingthe leading

◆ ListItem() [3/9]

iTextSharp.text.ListItem.ListItem ( Chunk  chunk)

Constructs a ListItem with a certain Chunk.

Parameters
chunka Chunk

◆ ListItem() [4/9]

iTextSharp.text.ListItem.ListItem ( string  str)

Constructs a ListItem with a certain string.

Parameters
stra string

◆ ListItem() [5/9]

iTextSharp.text.ListItem.ListItem ( string  str,
Font  font 
)

Constructs a ListItem with a certain string and a certain Font.

Parameters
stra string
fonta string

◆ ListItem() [6/9]

iTextSharp.text.ListItem.ListItem ( float  leading,
Chunk  chunk 
)

Constructs a ListItem with a certain Chunk and a certain leading.

Parameters
leadingthe leading
chunka Chunk

◆ ListItem() [7/9]

iTextSharp.text.ListItem.ListItem ( float  leading,
string  str 
)

Constructs a ListItem with a certain string and a certain leading.

Parameters
leadingthe leading
stra string

◆ ListItem() [8/9]

iTextSharp.text.ListItem.ListItem ( float  leading,
string  str,
Font  font 
)

Constructs a ListItem with a certain leading, string and Font.

Constructs a ListItem with a certain leading, string and Font.

Parameters
leadingthe leading
stringa string
fonta Font
Parameters
leadingthe leading
stra string
fonta Font

◆ ListItem() [9/9]

iTextSharp.text.ListItem.ListItem ( Phrase  phrase)

Constructs a ListItem with a certain Phrase.

Parameters
phrasea Phrase

Member Function Documentation

◆ IsTag()

static new bool iTextSharp.text.ListItem.IsTag ( string  tag)
static

Checks if a given tag corresponds with this object.

Parameters
tagthe given tag
Returns
true if the tag corresponds

◆ SetIndentationLeft()

void iTextSharp.text.ListItem.SetIndentationLeft ( float  indentation,
bool  autoindent 
)

Sets the indentation of this paragraph on the left side.

Parameters
indentationthe new indentation

Property Documentation

◆ ListSymbol

Chunk iTextSharp.text.ListItem.ListSymbol
getset

Get/set the listsymbol.

a Chunk

◆ Type

override int iTextSharp.text.ListItem.Type
get

Gets the type of the text element.

a type


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