A layout element that represents a self-contained block of textual and graphical information. More...

Inheritance diagram for iText.Layout.Element.Paragraph:

Public Member Functions
	Paragraph ()
	Creates a new Paragraph instance. More...

	Paragraph (String text)
	Creates a Paragraph, initialized with a piece of text. More...

	Paragraph (Text text)
	Creates a Paragraph, initialized with a piece of text. More...

override iText.Layout.Element.Paragraph	Add (String text)
	Adds a piece of text to this Paragraph. More...

override iText.Layout.Element.Paragraph	Add (ILeafElement element)
	Adds a element to this Paragraph. More...

virtual iText.Layout.Element.Paragraph	Add (IBlockElement element)
	Adds an element to this Paragraph. More...

virtual iText.Layout.Element.Paragraph	Add (FootnoteAnchor footnoteAnchor)
	Adds the iText.Layout.Properties.Margins.FootnoteAnchor element to this Paragraph. More...

override iText.Layout.Element.Paragraph	AddAll< T2 > (IList< T2 > elements)
	Adds a System.Collections.IList of layout elements to this Paragraph. More...

virtual iText.Layout.Element.Paragraph	AddTabStops (params TabStop[] tabStops)
	Adds an unspecified amount of tabstop elements as properties to this Paragraph. More...

virtual iText.Layout.Element.Paragraph	AddTabStops (IList< TabStop > tabStops)
	Adds a System.Collections.IList of tabstop elements as properties to this Paragraph. More...

virtual iText.Layout.Element.Paragraph	RemoveTabStop (float tabStopPosition)
	Removes a tabstop position from the Paragraph, if it is present in the iText.Layout.Properties.Property.TAB_STOPS property. More...

override iText.Layout.Element.Paragraph	SetFirstLineIndent (float indent)
	Sets the indent value for the first line of the Paragraph. More...

override iText.Layout.Element.Paragraph	SetOrphansControl (ParagraphOrphansControl orphansControl)
	Sets orphans restriction on a Paragraph. More...

override iText.Layout.Element.Paragraph	SetWidowsControl (ParagraphWidowsControl widowsControl)
	Sets widows restriction on a Paragraph. More...

virtual iText.Layout.Element.Paragraph	SetFixedLeading (float leading)
	Sets the leading value, using the iText.Layout.Properties.Leading.FIXED strategy. More...

virtual iText.Layout.Element.Paragraph	SetMultipliedLeading (float leading)
	Sets the leading value, using the iText.Layout.Properties.Leading.MULTIPLIED strategy. More...

Public Member Functions inherited from iText.Layout.Element.AbstractParagraph< iText.Layout.Element.Paragraph >
virtual T	Add (Paragraph element)
	Adds a Paragraph element. More...

virtual T	Add (VerticalParagraph element)
	Adds a VerticalParagraph element. More...

override T1	GetDefaultProperty< T1 > (int property)
	Gets the default property from this entity. More...

virtual T	SetOrphansControl (ParagraphOrphansControl orphansControl)
	Sets orphans restriction on a AbstractParagraph. More...

virtual T	SetWidowsControl (ParagraphWidowsControl widowsControl)
	Sets widows restriction on a AbstractParagraph. More...

override AccessibilityProperties	GetAccessibilityProperties ()

Package Functions
override IRenderer	MakeNewRenderer ()

Package Functions inherited from iText.Layout.Element.AbstractParagraph< iText.Layout.Element.Paragraph >
	AbstractParagraph ()
	Creates a new instance of AbstractParagraph. More...

virtual void	AddTabStopsAsProperty (IList< TabStop > newTabStops)
	Adds a list of TabStop objects to the paragraph's properties. More...

Additional Inherited Members
Package Attributes inherited from iText.Layout.Element.AbstractParagraph< iText.Layout.Element.Paragraph >
DefaultAccessibilityProperties	tagProperties

Detailed Description

A layout element that represents a self-contained block of textual and graphical information.

A layout element that represents a self-contained block of textual and graphical information. It is a BlockElement which essentially acts as a container for leaf elements.

Constructor & Destructor Documentation

◆ Paragraph() [1/3]

iText.Layout.Element.Paragraph.Paragraph ( )

inline

Creates a new Paragraph instance.

◆ Paragraph() [2/3]

iText.Layout.Element.Paragraph.Paragraph ( String text )

inline

Creates a Paragraph, initialized with a piece of text.

Parameters

text	the initial textual content, as a System.String

◆ Paragraph() [3/3]

iText.Layout.Element.Paragraph.Paragraph ( Text text )

inline

Creates a Paragraph, initialized with a piece of text.

Parameters

text	the initial textual content, as a Text

Member Function Documentation

◆ Add() [1/4]

virtual iText.Layout.Element.Paragraph iText.Layout.Element.Paragraph.Add ( FootnoteAnchor footnoteAnchor )

inlinevirtual

Adds the iText.Layout.Properties.Margins.FootnoteAnchor element to this Paragraph.

Parameters

footnoteAnchor the footnote anchor to be added

Returns: this same Paragraph instance

◆ Add() [2/4]

virtual iText.Layout.Element.Paragraph iText.Layout.Element.Paragraph.Add ( IBlockElement element )

inlinevirtual

Adds an element to this Paragraph.

Parameters

element the content to be added, any IBlockElement

Returns: this Paragraph

◆ Add() [3/4]

override iText.Layout.Element.Paragraph iText.Layout.Element.Paragraph.Add ( ILeafElement element )

inlinevirtual

Adds a element to this Paragraph.

Parameters

element the content to be added, any ILeafElement

Returns: this Paragraph

Reimplemented from iText.Layout.Element.AbstractParagraph< iText.Layout.Element.Paragraph >.

◆ Add() [4/4]

override iText.Layout.Element.Paragraph iText.Layout.Element.Paragraph.Add ( String text )

inlinevirtual

Adds a piece of text to this Paragraph.

Parameters

text	the content to be added, as a System.String

Returns: this Paragraph

Reimplemented from iText.Layout.Element.AbstractParagraph< iText.Layout.Element.Paragraph >.

◆ AddAll< T2 >()

override iText.Layout.Element.Paragraph iText.Layout.Element.Paragraph.AddAll< T2 > ( IList< T2 > elements )

inlinevirtual

Adds a System.Collections.IList of layout elements to this Paragraph.

Parameters

elements the content to be added

Template Parameters

T2	any ILeafElement

Returns: this Paragraph

Reimplemented from iText.Layout.Element.AbstractParagraph< iText.Layout.Element.Paragraph >.

◆ AddTabStops() [1/2]

virtual iText.Layout.Element.Paragraph iText.Layout.Element.Paragraph.AddTabStops ( IList< TabStop > tabStops )

inlinevirtual

Adds a System.Collections.IList of tabstop elements as properties to this Paragraph.

Parameters

tabStops the list of TabStop s to be added as properties

Returns: this Paragraph

See also: TabStop

◆ AddTabStops() [2/2]

virtual iText.Layout.Element.Paragraph iText.Layout.Element.Paragraph.AddTabStops ( params TabStop[] tabStops )

inlinevirtual

Adds an unspecified amount of tabstop elements as properties to this Paragraph.

Parameters

tabStops the tabstop(s) to be added as properties

Returns: this Paragraph

See also: TabStop

◆ MakeNewRenderer()

override IRenderer iText.Layout.Element.Paragraph.MakeNewRenderer ( )

inlinepackage

◆ RemoveTabStop()

virtual iText.Layout.Element.Paragraph iText.Layout.Element.Paragraph.RemoveTabStop ( float tabStopPosition )

inlinevirtual

Removes a tabstop position from the Paragraph, if it is present in the iText.Layout.Properties.Property.TAB_STOPS property.

Parameters

tabStopPosition the TabStop position to be removed.

Returns: this Paragraph

See also: TabStop

◆ SetFirstLineIndent()

override iText.Layout.Element.Paragraph iText.Layout.Element.Paragraph.SetFirstLineIndent ( float indent )

inlinevirtual

Sets the indent value for the first line of the Paragraph.

Parameters

indent the indent value that must be applied to the first line of the Paragraph, as a float

Returns: this Paragraph

Reimplemented from iText.Layout.Element.AbstractParagraph< iText.Layout.Element.Paragraph >.

◆ SetFixedLeading()

virtual iText.Layout.Element.Paragraph iText.Layout.Element.Paragraph.SetFixedLeading ( float leading )

inlinevirtual

Sets the leading value, using the iText.Layout.Properties.Leading.FIXED strategy.

If for the element iText.Layout.Properties.RenderingMode?.HTML_MODE is enabled, than iText.Layout.Properties.Property.LINE_HEIGHT property will be set instead of default layout iText.Layout.Properties.Property.LEADING.

Parameters

leading the new leading value

Returns: this Paragraph

See also: iText.Layout.Properties.Leading, iText.Layout.Properties.LineHeight

◆ SetMultipliedLeading()

virtual iText.Layout.Element.Paragraph iText.Layout.Element.Paragraph.SetMultipliedLeading ( float leading )

inlinevirtual

Sets the leading value, using the iText.Layout.Properties.Leading.MULTIPLIED strategy.

If for the element iText.Layout.Properties.RenderingMode?.HTML_MODE is enabled, than iText.Layout.Properties.Property.LINE_HEIGHT property will be set instead of default layout iText.Layout.Properties.Property.LEADING.

Parameters

leading the new leading value

Returns: this Paragraph

See also: iText.Layout.Properties.Leading, iText.Layout.Properties.LineHeight

◆ SetOrphansControl()

override iText.Layout.Element.Paragraph iText.Layout.Element.Paragraph.SetOrphansControl ( ParagraphOrphansControl orphansControl )

inline

Sets orphans restriction on a Paragraph.

Parameters

orphansControl an instance of iText.Layout.Properties.ParagraphOrphansControl

Returns: this Paragraph instance

◆ SetWidowsControl()

override iText.Layout.Element.Paragraph iText.Layout.Element.Paragraph.SetWidowsControl ( ParagraphWidowsControl widowsControl )

inline

Sets widows restriction on a Paragraph.

Parameters

widowsControl an instance of iText.Layout.Properties.ParagraphWidowsControl

Returns: this Paragraph instance

Public Member Functions

Package Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Paragraph() [1/3]

◆ Paragraph() [2/3]

◆ Paragraph() [3/3]

Member Function Documentation

◆ Add() [1/4]

◆ Add() [2/4]

◆ Add() [3/4]

◆ Add() [4/4]

◆ AddAll< T2 >()

◆ AddTabStops() [1/2]

◆ AddTabStops() [2/2]

◆ MakeNewRenderer()

◆ RemoveTabStop()

◆ SetFirstLineIndent()

◆ SetFixedLeading()

◆ SetMultipliedLeading()

◆ SetOrphansControl()

◆ SetWidowsControl()