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

A Chapter is a special Section. More...

Inheritance diagram for iTextSharp.text.Chapter:
iTextSharp.text.Section iTextSharp.text.ITextElementArray iTextSharp.text.ILargeElement iTextSharp.text.IElement iTextSharp.text.IElement iTextSharp.text.ChapterAutoNumber

Public Member Functions

 Chapter (int number)
 
 Chapter (Paragraph title, int number)
 Constructs a new Chapter. More...
 
 Chapter (string title, int number)
 Constructs a new Chapter. More...
 
override bool IsNestable ()
 
- Public Member Functions inherited from iTextSharp.text.Section
bool Process (IElementListener listener)
 Processes the element by adding it (or the different parts) to an IElementListener. More...
 
bool IsContent ()
 
void Add (int index, Object o)
 Adds a Paragraph, List or Table to this Section. More...
 
new bool Add (Object o)
 Adds a Paragraph, List, Table or another Section to this Section. More...
 
bool AddAll (ICollection collection)
 Adds a collection of Elements to this Section. More...
 
virtual Section AddSection (float indentation, Paragraph title, int numberDepth)
 Creates a Section, adds it to this Section and returns it. More...
 
virtual Section AddSection (float indentation, Paragraph title)
 Creates a Section, adds it to this Section and returns it. More...
 
virtual Section AddSection (Paragraph title, int numberDepth)
 Creates a Section, add it to this Section and returns it. More...
 
MarkedSection AddMarkedSection ()
 
virtual Section AddSection (Paragraph title)
 Creates a Section, adds it to this Section and returns it. More...
 
virtual Section AddSection (float indentation, string title, int numberDepth)
 Adds a Section to this Section and returns it. More...
 
virtual Section AddSection (string title, int numberDepth)
 Adds a Section to this Section and returns it. More...
 
virtual Section AddSection (float indentation, string title)
 Adds a Section to this Section and returns it. More...
 
virtual Section AddSection (string title)
 Adds a Section to this Section and returns it. More...
 
void Set (Properties attributes)
 Alters the attributes of this Section. More...
 
bool IsChapter ()
 Checks if this object is a Chapter. More...
 
bool IsSection ()
 Checks if this object is a Section. More...
 
Paragraph GetBookmarkTitle ()
 
override string ToString ()
 Gets the content of the text element. More...
 
void SetChapterNumber (int number)
 
void FlushContent ()
 
void NewPage ()
 

Properties

override int Type [get]
 Gets the type of the text element. More...
 
- Properties inherited from iTextSharp.text.Section
virtual int Type [get]
 Gets the type of the text element. More...
 
ArrayList Chunks [get]
 Gets all the chunks in this element. More...
 
Paragraph Title [get, set]
 Get/set the title of this section More...
 
int NumberStyle [get, set]
 
int NumberDepth [get, set]
 Get/set the numberdepth of this Section. More...
 
float IndentationLeft [get, set]
 Get/set the indentation of this Section on the left side. More...
 
float IndentationRight [get, set]
 Get/set the indentation of this Section on the right side. More...
 
float Indentation [get, set]
 Get/set the indentation of the content of this Section. More...
 
int Depth [get]
 Returns the depth of this section. More...
 
bool BookmarkOpen [get, set]
 Get/set the bookmark More...
 
String BookmarkTitle [set]
 
virtual bool TriggerNewPage [get, set]
 
bool NotAddedYet [get, set]
 
bool AddedCompletely [get, set]
 
bool ElementComplete [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...
 
- Properties inherited from iTextSharp.text.ILargeElement
bool ElementComplete [get, set]
 

Additional Inherited Members

- Static Public Member Functions inherited from iTextSharp.text.Section
static Paragraph ConstructTitle (Paragraph title, ArrayList numbers, int numberDepth, int numberStyle)
 
static bool IsTitle (string tag)
 Checks if a given tag corresponds with a title tag for this object. More...
 
static bool IsTag (string tag)
 Checks if a given tag corresponds with this object. More...
 
- Static Public Attributes inherited from iTextSharp.text.Section
const int NUMBERSTYLE_DOTTED = 0
 
const int NUMBERSTYLE_DOTTED_WITHOUT_FINAL_DOT = 1
 
- Protected Attributes inherited from iTextSharp.text.Section
Paragraph title
 This is the title of this section. More...
 
int numberDepth
 
int numberStyle = NUMBERSTYLE_DOTTED
 summary> The indentation of this section on the left side. More...
 
float indentationLeft
 summary> The indentation of this section on the right side. More...
 
float indentationRight
 summary> The additional indentation of the content of this section. More...
 
float indentation
 summary> This is the number of subsections. More...
 
int subsections = 0
 summary> This is the complete list of sectionnumbers of this section and the parents of this section. More...
 
bool complete = true
 
bool addedCompletely = false
 
bool notAddedYet = true
 summary> false if the bookmark children are not visible More...
 
bool bookmarkOpen = true
 
bool triggerNewPage = false
 
string bookmarkTitle
 

Detailed Description

A Chapter is a special Section.

A chapter number has to be created using a Paragraph as title and an int as chapter number. The chapter number is shown be default. If you don't want to see the chapter number, you have to set the numberdepth to 0.

Paragraph title2 = new Paragraph("This is Chapter 2", FontFactory.GetFont(FontFactory.HELVETICA, 18, Font.BOLDITALIC, new Color(0, 0, 255)));
<strong>Chapter chapter2 = new Chapter(title2, 2);
chapter2.SetNumberDepth(0);</strong>
Paragraph someText = new Paragraph("This is some text");
<strong>chapter2.Add(someText);</strong>
Paragraph title21 = new Paragraph("This is Section 1 in Chapter 2", FontFactory.GetFont(FontFactory.HELVETICA, 16, Font.BOLD, new Color(255, 0, 0)));
Section section1 = <strong>chapter2.AddSection(title21);</strong>
Paragraph someSectionText = new Paragraph("This is some silly paragraph in a chapter and/or section. It contains some text to test the functionality of Chapters and Section.");
section1.Add(someSectionText);
Chapter(int number)
Definition: Chapter.cs:91

Constructor & Destructor Documentation

◆ Chapter() [1/3]

iTextSharp.text.Chapter.Chapter ( int  number)

Constructs a new Chapter.

Parameters
numberthe Chapter number

◆ Chapter() [2/3]

iTextSharp.text.Chapter.Chapter ( Paragraph  title,
int  number 
)

Constructs a new Chapter.

Parameters
titlethe Chapter title (as a Paragraph)
numberthe Chapter number

<overoads> Has three overloads. </overoads>

◆ Chapter() [3/3]

iTextSharp.text.Chapter.Chapter ( string  title,
int  number 
)

Constructs a new Chapter.

Parameters
titlethe Chapter title (as a string)
numberthe Chapter number

<overoads> Has three overloads. </overoads>

Member Function Documentation

◆ IsNestable()

override bool iTextSharp.text.Chapter.IsNestable ( )
virtual
See also
com.lowagie.text.Element::isNestable()
Since
iText 2.0.8

Reimplemented from iTextSharp.text.Section.

Property Documentation

◆ Type

override int iTextSharp.text.Chapter.Type
get

Gets the type of the text element.

a type


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