iText 7 7.1.8 API
iText.Layout.Element.Paragraph Class Reference

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

Inheritance diagram for iText.Layout.Element.Paragraph:
iText.Layout.Element.BlockElement< iText.Layout.Element.Paragraph >

Public Member Functions

  Paragraph ()
  Creates a Paragraph. 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...
 
virtual iText.Layout.Element.Paragraph  Add (String text)
  Adds a piece of text to the Paragraph More...
 
virtual iText.Layout.Element.Paragraph  Add (ILeafElement element)
  Adds a layout element to the Paragraph. More...
 
virtual iText.Layout.Element.Paragraph  Add (IBlockElement element)
 
virtual iText.Layout.Element.Paragraph  AddAll< T2 > (IList< T2 > elements)
  Adds a System.Collections.IList<E> of layout elements to the Paragraph. More...
 
virtual iText.Layout.Element.Paragraph  AddTabStops (params TabStop[] tabStops)
  Adds an unspecified amount of tabstop elements as properties to the Paragraph. More...
 
virtual iText.Layout.Element.Paragraph  AddTabStops (IList< TabStop > tabStops)
  Adds a System.Collections.IList<E> of tabstop elements as properties to the 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 T1  GetDefaultProperty< T1 > (int property)
 
virtual iText.Layout.Element.Paragraph  SetFirstLineIndent (float indent)
  Sets the indent value for the first line of the 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...
 
override AccessibilityProperties  GetAccessibilityProperties ()
  Gets the accessibility properties . See also IAccessibleElement More...
 
- Public Member Functions inherited from iText.Layout.Element.BlockElement< iText.Layout.Element.Paragraph >
override T1  GetDefaultProperty< T1 > (int property)
  Gets the default property from this entity. More...
 
virtual UnitValue  GetMarginLeft ()
  Gets the current left margin width of the element. More...
 
virtual T  SetMarginLeft (float value)
  Sets the left margin width of the element. More...
 
virtual UnitValue  GetMarginRight ()
  Gets the current right margin width of the element. More...
 
virtual T  SetMarginRight (float value)
  Sets the right margin width of the element. More...
 
virtual UnitValue  GetMarginTop ()
  Gets the current top margin width of the element. More...
 
virtual T  SetMarginTop (float value)
  Sets the top margin width of the element. More...
 
virtual UnitValue  GetMarginBottom ()
  Gets the current bottom margin width of the element. More...
 
virtual T  SetMarginBottom (float value)
  Sets the bottom margin width of the element. More...
 
virtual T  SetMargin (float commonMargin)
  Sets all margins around the element to the same width. More...
 
virtual T  SetMargins (float marginTop, float marginRight, float marginBottom, float marginLeft)
  Sets the margins around the element to a series of new widths. More...
 
virtual UnitValue  GetPaddingLeft ()
  Gets the current left padding width of the element. More...
 
virtual T  SetPaddingLeft (float value)
  Sets the left padding width of the element. More...
 
virtual UnitValue  GetPaddingRight ()
  Gets the current right padding width of the element. More...
 
virtual T  SetPaddingRight (float value)
  Sets the right padding width of the element. More...
 
virtual UnitValue  GetPaddingTop ()
  Gets the current top padding width of the element. More...
 
virtual T  SetPaddingTop (float value)
  Sets the top padding width of the element. More...
 
virtual UnitValue  GetPaddingBottom ()
  Gets the current bottom padding width of the element. More...
 
virtual T  SetPaddingBottom (float value)
  Sets the bottom padding width of the element. More...
 
virtual T  SetPadding (float commonPadding)
  Sets all paddings around the element to the same width. More...
 
virtual T  SetPaddings (float paddingTop, float paddingRight, float paddingBottom, float paddingLeft)
  Sets the paddings around the element to a series of new widths. More...
 
virtual T  SetVerticalAlignment (VerticalAlignment? verticalAlignment)
  Sets the vertical alignment of the element. More...
 
virtual T  SetSpacingRatio (float ratio)
  Sets a ratio which determines in which proportion will word spacing and character spacing be applied when horizontal alignment is justified. More...
 
virtual ? bool  IsKeepTogether ()
  Returns whether the BlockElement<T> should be kept together as much as possible. More...
 
virtual T  SetKeepTogether (bool keepTogether)
  Sets whether the BlockElement<T> should be kept together as much as possible. More...
 
virtual ? bool  IsKeepWithNext ()
  Returns whether the end of this BlockElement<T> and the start of the next sibling of this element should be placed in the same area. More...
 
virtual T  SetKeepWithNext (bool keepWithNext)
  Sets whether the end of this BlockElement<T> and the start of the next sibling of this element should be placed in the same area. Note that this will only work for high-level elements, i.e. elements added to the iText.Layout.RootElement<T> More...
 
virtual T  SetRotationAngle (float angleInRadians)
  Sets the rotation radAngle. More...
 
virtual T  SetRotationAngle (double angleInRadians)
  Sets the rotation angle. More...
 
virtual T  SetWidth (float width)
  Sets the width property of a block element, measured in points. More...
 
virtual T  SetWidth (UnitValue width)
  Sets the width property of a block element with a iText.Layout.Properties.UnitValue More...
 
virtual UnitValue  GetWidth ()
  Gets the width property of a block element. More...
 
virtual T  SetHeight (UnitValue height)
  Sets the height property of a block element with a iText.Layout.Properties.UnitValue More...
 
virtual T  SetHeight (float height)
  Sets the height property a block element as a point-value. More...
 
virtual UnitValue  GetHeight ()
  Gets the height property of a block element. More...
 
virtual T  SetMaxHeight (float maxHeight)
  Sets the max-height of a block element as point-unit value. More...
 
virtual T  SetMaxHeight (UnitValue maxHeight)
  Sets the max-height property of a block element with a iText.Layout.Properties.UnitValue More...
 
virtual T  SetMinHeight (UnitValue minHeight)
  Sets the min-height property of a block element with a iText.Layout.Properties.UnitValue More...
 
virtual T  SetMinHeight (float minHeight)
  Sets the min-height of a block element as point-unit value. More...
 
virtual T  SetMaxWidth (UnitValue maxWidth)
  Sets the max-width property of a block element with a iText.Layout.Properties.UnitValue More...
 
virtual T  SetMaxWidth (float maxWidth)
  Sets the max-width of a block element as point-unit value. More...
 
virtual T  SetMinWidth (UnitValue minWidth)
  Sets the min-width property of a block element with a iText.Layout.Properties.UnitValue More...
 
virtual T  SetMinWidth (float minWidth)
  Sets the min-width of a block element as point-unit value. More...
 

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<T> which essentially acts as a container for leaf elements

Constructor & Destructor Documentation

◆ Paragraph() [1/3]

iText.Layout.Element.Paragraph.Paragraph ( )
inline

Creates a Paragraph.

◆ 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/2]

virtual iText.Layout.Element.Paragraph iText.Layout.Element.Paragraph.Add ( ILeafElement  element )
inlinevirtual

Adds a layout element to the Paragraph.

Parameters
element the content to be added, any ILeafElement
Returns
this Paragraph

◆ Add() [2/2]

virtual iText.Layout.Element.Paragraph iText.Layout.Element.Paragraph.Add ( String  text )
inlinevirtual

Adds a piece of text to the Paragraph

Parameters
text the content to be added, as a System.String
Returns
this Paragraph

◆ AddAll< T2 >()

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

Adds a System.Collections.IList<E> of layout elements to the Paragraph.

Returns
this Paragraph
Type Constraints
T2  : ILeafElement  

◆ AddTabStops() [1/2]

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

Adds a System.Collections.IList<E> of tabstop elements as properties to the 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 the Paragraph.

Parameters
tabStops the tabstop(s) to be added as properties
Returns
this Paragraph
See also
TabStop

◆ GetAccessibilityProperties()

override AccessibilityProperties iText.Layout.Element.Paragraph.GetAccessibilityProperties ( )
inlinevirtual

Gets the accessibility properties . See also IAccessibleElement

Returns
an interface that allows to specify properties of a tagged element in Tagged PDF.

Implements iText.Layout.Element.BlockElement< iText.Layout.Element.Paragraph >.

◆ 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()

virtual 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

◆ 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.

Parameters
leading the new leading value
Returns
this Paragraph
See also
iText.Layout.Properties.Leading

◆ 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.

Parameters
leading the new leading value
Returns
this Paragraph
See also
iText.Layout.Properties.Leading