C# Class iTextSharp.text.Section

A Section is a part of a Document containing other Sections, Paragraphs, List and/or Tables.

You can not construct a Section yourself. You will have to ask an instance of Section to the Chapter or Section to which you want to add the new Section.

Inheritance: System.Collections.ArrayList, ITextElementArray

Mostrar archivo Open project: red-gate/iTextSharp-4.1.6 Class Usage Examples

Protected Properties

Property	Type	Description
addedCompletely	bool
bookmarkOpen	bool
bookmarkTitle	string
complete	bool
indentation	float
indentationLeft	float
indentationRight	float
notAddedYet	bool
numberDepth	int
numberStyle	int
numbers	System.Collections.ArrayList
subsections	int
title	Paragraph
triggerNewPage	bool

Public Methods

Method	Description
Add ( Object o ) : bool	Adds a Paragraph, List, Table or another Section to this Section.
Add ( int index, Object o ) : void	Adds a Paragraph, List or Table to this Section.
AddAll ( ICollection collection ) : bool	Adds a collection of Elements to this Section.
AddMarkedSection ( ) : MarkedSection
AddSection ( Paragraph title ) : Section	Creates a Section, adds it to this Section and returns it.
AddSection ( Paragraph title, int numberDepth ) : Section	Creates a Section, add it to this Section and returns it.
AddSection ( float indentation, Paragraph title ) : Section	Creates a Section, adds it to this Section and returns it.
AddSection ( float indentation, Paragraph title, int numberDepth ) : Section	Creates a Section, adds it to this Section and returns it.
AddSection ( float indentation, string title ) : Section	Adds a Section to this Section and returns it.
AddSection ( float indentation, string title, int numberDepth ) : Section	Adds a Section to this Section and returns it.
AddSection ( string title ) : Section	Adds a Section to this Section and returns it.
AddSection ( string title, int numberDepth ) : Section	Adds a Section to this Section and returns it.
ConstructTitle ( Paragraph title, ArrayList numbers, int numberDepth, int numberStyle ) : Paragraph
FlushContent ( ) : void
GetBookmarkTitle ( ) : Paragraph
IsChapter ( ) : bool	Checks if this object is a Chapter.
IsContent ( ) : bool
IsNestable ( ) : bool
IsSection ( ) : bool	Checks if this object is a Section.
IsTag ( string tag ) : bool	Checks if a given tag corresponds with this object.
IsTitle ( string tag ) : bool	Checks if a given tag corresponds with a title tag for this object.
NewPage ( ) : void
Process ( IElementListener listener ) : bool	Processes the element by adding it (or the different parts) to an IElementListener.
Set ( Properties attributes ) : void	Alters the attributes of this Section.
SetChapterNumber ( int number ) : void
ToString ( ) : string

Protected Methods

Method	Description
Section ( ) : System	Constructs a new Section.
Section ( Paragraph title, int numberDepth ) : System	Constructs a new Section.

Private Methods

Method	Description
SetNumbers ( int number, ArrayList numbers ) : void	Sets the number of this section.

Method Details

Add() public method

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

public Add ( Object o ) : bool
o	Object	an object of type Paragraph, List, Table or another Section
return	bool

Add() public method

Adds a Paragraph, List or Table to this Section.

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 Paragraph, List or Table
return	void

AddAll() public method

Adds a collection of Elements to this Section.

public AddAll ( ICollection collection ) : bool
collection	ICollection	a collection of Paragraphs, Lists and/or Tables
return	bool

AddMarkedSection() public method

public AddMarkedSection ( ) : MarkedSection
return	MarkedSection

AddSection() public method

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

public AddSection ( Paragraph title ) : Section
title	Paragraph	the title of the new section
return	Section

AddSection() public method

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

public AddSection ( Paragraph title, int numberDepth ) : Section
title	Paragraph	the title of the new section
numberDepth	int	the numberDepth of the section
return	Section

AddSection() public method

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

public AddSection ( float indentation, Paragraph title ) : Section
indentation	float	the indentation of the new section
title	Paragraph	the title of the new section
return	Section

AddSection() public method

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

public AddSection ( float indentation, Paragraph title, int numberDepth ) : Section
indentation	float	the indentation of the new section
title	Paragraph	the title of the new section
numberDepth	int	the numberDepth of the section
return	Section

AddSection() public method

Adds a Section to this Section and returns it.

public AddSection ( float indentation, string title ) : Section
indentation	float	the indentation of the new section
title	string	the title of the new section
return	Section

AddSection() public method

Adds a Section to this Section and returns it.

public AddSection ( float indentation, string title, int numberDepth ) : Section
indentation	float	the indentation of the new section
title	string	the title of the new section
numberDepth	int	the numberDepth of the section
return	Section

AddSection() public method

Adds a Section to this Section and returns it.

public AddSection ( string title ) : Section
title	string	the title of the new section
return	Section

AddSection() public method

Adds a Section to this Section and returns it.

public AddSection ( string title, int numberDepth ) : Section
title	string	the title of the new section
numberDepth	int	the numberDepth of the section
return	Section

ConstructTitle() public static method

public static ConstructTitle ( Paragraph title, ArrayList numbers, int numberDepth, int numberStyle ) : Paragraph
title	Paragraph
numbers	System.Collections.ArrayList
numberDepth	int
numberStyle	int
return	Paragraph

FlushContent() public method

public FlushContent ( ) : void
return	void

GetBookmarkTitle() public method

public GetBookmarkTitle ( ) : Paragraph
return	Paragraph

IsChapter() public method

Checks if this object is a Chapter.

public IsChapter ( ) : bool
return	bool

IsContent() public method

public IsContent ( ) : bool
return	bool

IsNestable() public method

public IsNestable ( ) : bool
return	bool

IsSection() public method

Checks if this object is a Section.

public IsSection ( ) : 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

IsTitle() public static method

Checks if a given tag corresponds with a title tag for this object.

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

NewPage() public method

public NewPage ( ) : void
return	void

Process() public method

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

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

Section() protected method

Constructs a new Section.

protected Section ( ) : System
return	System

Section() protected method

Constructs a new Section.

protected Section ( Paragraph title, int numberDepth ) : System
title	Paragraph	a Paragraph
numberDepth	int	the numberDepth
return	System

Set() public method

Alters the attributes of this Section.

public Set ( Properties attributes ) : void
attributes	System.util.Properties	the attributes
return	void

SetChapterNumber() public method

public SetChapterNumber ( int number ) : void
number	int
return	void

ToString() public method

public ToString ( ) : string
return	string

Property Details

addedCompletely protected_oe property

protected bool addedCompletely
return	bool

bookmarkOpen protected_oe property

false if the bookmark children are not visible

protected bool bookmarkOpen
return	bool

bookmarkTitle protected_oe property

protected string bookmarkTitle
return	string

complete protected_oe property

protected bool complete
return	bool

indentation protected_oe property

The additional indentation of the content of this section.

protected float indentation
return	float

indentationLeft protected_oe property

The indentation of this section on the left side.

protected float indentationLeft
return	float

indentationRight protected_oe property

The indentation of this section on the right side.

protected float indentationRight
return	float

notAddedYet protected_oe property

protected bool notAddedYet
return	bool

numberDepth protected_oe property

This is the number of sectionnumbers that has to be shown before the section title.

protected int numberDepth
return	int

numberStyle protected_oe property

protected int numberStyle
return	int

numbers protected_oe property

This is the complete list of sectionnumbers of this section and the parents of this section.

protected ArrayList,System.Collections numbers
return	System.Collections.ArrayList

subsections protected_oe property

This is the number of subsections.

protected int subsections
return	int

title protected_oe property

This is the title of this section.

protected Paragraph,iTextSharp.text title
return	Paragraph

triggerNewPage protected_oe property

protected bool triggerNewPage
return	bool