C# Class iTextSharp.text.Phrase

A Phrase is a series of Chunks.

A Phrase has a main Font, but some chunks within the phrase can have a Font that differs from the main Font. All the Chunks in a Phrase have the same leading.

Inheritance: System.Collections.ArrayList, ITextElementArray

ファイルを表示 Open project: red-gate/iTextSharp-4.1.6 Class Usage Examples

Protected Properties

Property	Type	Description
font	Font
hyphenation	IHyphenationEvent
leading	System.Single

Public Methods

Method	Description
Add ( Object o ) : bool	Adds a Chunk, Anchor or another Phrase to this Phrase.
Add ( int index, Object o ) : void	Adds a Chunk, an Anchor or another Phrase to this Phrase.
AddAll ( ICollection collection ) : bool	Adds a collection of Chunks to this Phrase.
AddSpecial ( Object obj ) : void	Adds a Object to the Paragraph.
GetInstance ( String str ) : Phrase
GetInstance ( int leading, String str ) : Phrase
GetInstance ( int leading, String str, Font font ) : Phrase
HasLeading ( ) : bool
IsContent ( ) : bool
IsEmpty ( ) : bool	Checks is this Phrase contains no or 1 empty Chunk.
IsNestable ( ) : bool
IsTag ( string tag ) : bool	Checks if a given tag corresponds with this object.
Phrase ( ) : System	Constructs a Phrase without specifying a leading.
Phrase ( Chunk chunk ) : System	Constructs a Phrase with a certain Chunk.
Phrase ( Phrase phrase ) : System
Phrase ( float leading ) : System	Constructs a Phrase with a certain leading.
Phrase ( float leading, Chunk chunk ) : System	Constructs a Phrase with a certain Chunk and a certain leading.
Phrase ( float leading, string str ) : System	Constructs a Phrase with a certain leading and a certain string.
Phrase ( float leading, string str, Font font ) : System
Phrase ( string str ) : System	Constructs a Phrase with a certain string.
Phrase ( string str, Font font ) : System	Constructs a Phrase with a certain string and a certain Font.
Process ( IElementListener listener ) : bool	Processes the element by adding it (or the different parts) to an iTextSharp.text.IElementListener.
ToString ( ) : string

Protected Methods

Method	Description
AddChunk ( Chunk chunk ) : bool	Adds a Chunk. This method is a hack to solve a problem I had with phrases that were split between chunks in the wrong place.

Private Methods

Method	Description
Phrase ( bool dummy ) : System

Method Details

Add() public method

Adds a Chunk, Anchor or another Phrase to this Phrase.

public Add ( Object o ) : bool
o	Object	an object of type Chunk, Anchor or Phrase
return	bool

Add() public method

Adds a Chunk, an Anchor or another Phrase to this Phrase.

public Add ( int index, Object o ) : void
index	int	index at which the specified element is to be inserted
o	Object	an object of type Chunk, Anchor, or Phrase
return	void

AddAll() public method

Adds a collection of Chunks to this Phrase.

public AddAll ( ICollection collection ) : bool
collection	ICollection	a collection of Chunks, Anchors and Phrases.
return	bool

AddChunk() protected method

Adds a Chunk.

This method is a hack to solve a problem I had with phrases that were split between chunks in the wrong place.

protected AddChunk ( Chunk chunk ) : bool
chunk	Chunk	a Chunk
return	bool

AddSpecial() public method

Adds a Object to the Paragraph.

public AddSpecial ( Object obj ) : void
obj	Object	the object to add.
return	void

GetInstance() public static method

public static GetInstance ( String str ) : Phrase
str	String
return	Phrase

GetInstance() public static method

public static GetInstance ( int leading, String str ) : Phrase
leading	int
str	String
return	Phrase

GetInstance() public static method

public static GetInstance ( int leading, String str, Font font ) : Phrase
leading	int
str	String
font	Font
return	Phrase

HasLeading() public method

public HasLeading ( ) : bool
return	bool

IsContent() public method

public IsContent ( ) : bool
return	bool

IsEmpty() public method

Checks is this Phrase contains no or 1 empty Chunk.

public IsEmpty ( ) : bool
return	bool

IsNestable() public method

public IsNestable ( ) : bool
return	bool

IsTag() public static method

Checks if a given tag corresponds with this object.

public static IsTag ( string tag ) : bool
tag	string	the given tag
return	bool

Phrase() public method

Constructs a Phrase without specifying a leading.

public Phrase ( ) : System
return	System

Phrase() public method

Constructs a Phrase with a certain Chunk.

public Phrase ( Chunk chunk ) : System
chunk	Chunk	a Chunk
return	System

Phrase() public method

public Phrase ( Phrase phrase ) : System
phrase	Phrase
return	System

Phrase() public method

Constructs a Phrase with a certain leading.

public Phrase ( float leading ) : System
leading	float	the leading
return	System

Phrase() public method

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

public Phrase ( float leading, Chunk chunk ) : System
leading	float	the leading
chunk	Chunk	a Chunk
return	System

Phrase() public method

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

public Phrase ( float leading, string str ) : System
leading	float	the leading
str	string	a string
return	System

Phrase() public method

public Phrase ( float leading, string str, Font font ) : System
leading	float
str	string
font	Font
return	System

Phrase() public method

Constructs a Phrase with a certain string.

public Phrase ( string str ) : System
str	string	a string
return	System

Phrase() public method

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

public Phrase ( string str, Font font ) : System
str	string	a string
font	Font	a Font
return	System

Process() public method

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

public Process ( IElementListener listener ) : bool
listener	IElementListener	an IElementListener
return	bool

ToString() public method

public ToString ( ) : string
return	string

Property Details

font protected_oe property

This is the font of this phrase.

protected Font,iTextSharp.text font
return	Font

hyphenation protected_oe property

protected IHyphenationEvent hyphenation
return	IHyphenationEvent

leading protected_oe property

This is the leading of this phrase.

protected Single,System leading
return	System.Single