iText 8.0.4 API
iText.Layout.Element.TabStop Class Reference

A TabStop is the closest location on a line of text that the text will jump to if a Tab is inserted. More...

Public Member Functions

  TabStop (float tabPosition)
  Creates a TabStop at the appropriate position. More...
 
  TabStop (float tabPosition, TabAlignment tabAlignment)
  Creates a TabStop at the appropriate position, with a specified tab alignment. More...
 
  TabStop (float tabPosition, TabAlignment tabAlignment, ILineDrawer tabLeader)
  Creates a TabStop at the appropriate position, with a specified tab alignment and an explicitly given line pattern. More...
 
virtual float  GetTabPosition ()
  Returns the position of a tab stop. More...
 
virtual TabAlignment  GetTabAlignment ()
  Returns the alignment of a tab stop, which defines the way the textual content should be positioned in regard to this tab stop. More...
 
virtual void  SetTabAlignment (TabAlignment tabAlignment)
  Sets the alignment, which defines the way the textual content should be positioned in regard to this tab stop. More...
 
virtual ? char  GetTabAnchor ()
  Returns the anchor of a tab stop. More...
 
virtual void  SetTabAnchor (char? tabAnchor)
  Sets the anchor of a tab stop. More...
 
virtual ILineDrawer  GetTabLeader ()
  Returns the tab leader of a tab stop, which defines a pattern that should be repeated until the TabStop is reached. More...
 
virtual void  SetTabLeader (ILineDrawer tabLeader)
  Sets the tab leader of a tab stop, which defines a pattern that should be repeated until the TabStop is reached. More...
 

Detailed Description

A TabStop is the closest location on a line of text that the text will jump to if a Tab is inserted.

A TabStop is the closest location on a line of text that the text will jump to if a Tab is inserted. At least one TabStop must be defined on an element if you want to use Tabs. This object can be added to a Paragraph with the method Paragraph.AddTabStops(TabStop[]).

Constructor & Destructor Documentation

◆ TabStop() [1/3]

iText.Layout.Element.TabStop.TabStop ( float  tabPosition )
inline

Creates a TabStop at the appropriate position.

Parameters
tabPosition a float, measured in absolute points

◆ TabStop() [2/3]

iText.Layout.Element.TabStop.TabStop ( float  tabPosition,
TabAlignment  tabAlignment 
)
inline

Creates a TabStop at the appropriate position, with a specified tab alignment.

Creates a TabStop at the appropriate position, with a specified tab alignment. A tab alignment defines the way the textual content should be positioned with regards to this tab stop.

Parameters
tabPosition a float, measured in absolute points
tabAlignment a iText.Layout.Properties.TabAlignment value

◆ TabStop() [3/3]

iText.Layout.Element.TabStop.TabStop ( float  tabPosition,
TabAlignment  tabAlignment,
ILineDrawer  tabLeader 
)
inline

Creates a TabStop at the appropriate position, with a specified tab alignment and an explicitly given line pattern.

Creates a TabStop at the appropriate position, with a specified tab alignment and an explicitly given line pattern. A tab alignment defines the way the textual content should be positioned with regards to this tab stop. The line pattern defines a pattern that should be repeated until the TabStop is reached. If null, the space leading up to the TabStop will be empty.

Parameters
tabPosition a float, measured in absolute points
tabAlignment a iText.Layout.Properties.TabAlignment value
tabLeader the iText.Kernel.Pdf.Canvas.Draw.ILineDrawer value, a pattern drawing object

Member Function Documentation

◆ GetTabAlignment()

virtual TabAlignment iText.Layout.Element.TabStop.GetTabAlignment ( )
inlinevirtual

Returns the alignment of a tab stop, which defines the way the textual content should be positioned in regard to this tab stop.

Returns
a iText.Layout.Properties.TabAlignment value

◆ GetTabAnchor()

virtual ? char iText.Layout.Element.TabStop.GetTabAnchor ( )
inlinevirtual

Returns the anchor of a tab stop.

Returns
a char? value

◆ GetTabLeader()

virtual ILineDrawer iText.Layout.Element.TabStop.GetTabLeader ( )
inlinevirtual

Returns the tab leader of a tab stop, which defines a pattern that should be repeated until the TabStop is reached.

Returns
a iText.Kernel.Pdf.Canvas.Draw.ILineDrawer value, a pattern drawing object

◆ GetTabPosition()

virtual float iText.Layout.Element.TabStop.GetTabPosition ( )
inlinevirtual

Returns the position of a tab stop.

Returns
tabPosition, measured in absolute points

◆ SetTabAlignment()

virtual void iText.Layout.Element.TabStop.SetTabAlignment ( TabAlignment  tabAlignment )
inlinevirtual

Sets the alignment, which defines the way the textual content should be positioned in regard to this tab stop.

Parameters
tabAlignment a iText.Layout.Properties.TabAlignment value

◆ SetTabAnchor()

virtual void iText.Layout.Element.TabStop.SetTabAnchor ( char?  tabAnchor )
inlinevirtual

Sets the anchor of a tab stop.

Parameters
tabAnchor a char? value

◆ SetTabLeader()

virtual void iText.Layout.Element.TabStop.SetTabLeader ( ILineDrawer  tabLeader )
inlinevirtual

Sets the tab leader of a tab stop, which defines a pattern that should be repeated until the TabStop is reached.

Parameters
tabLeader a iText.Kernel.Pdf.Canvas.Draw.ILineDrawer value