Class TabStop

Namespace

iText.Layout.Element

Assembly

itext.layout.dll

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

public class TabStop

Inheritance

object

TabStop

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

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 AddTabStops(params TabStop[]).

Constructors

TabStop(float)

Creates a TabStop at the appropriate position.

public TabStop(float tabPosition)

Parameters

tabPosition float

a float, measured in absolute points

TabStop(float, TabAlignment)

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

public TabStop(float tabPosition, TabAlignment tabAlignment)

Parameters

tabPosition float

a float, measured in absolute points

tabAlignment TabAlignment

a TabAlignment value

Remarks

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.

TabStop(float, TabAlignment, ILineDrawer)

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

public TabStop(float tabPosition, TabAlignment tabAlignment, ILineDrawer tabLeader)

Parameters

tabPosition float

a float, measured in absolute points

tabAlignment TabAlignment

a TabAlignment value

tabLeader ILineDrawer

the ILineDrawer value, a pattern drawing object

Remarks

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.

Methods

GetTabAlignment()

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

public virtual TabAlignment GetTabAlignment()

Returns

TabAlignment

a TabAlignment value

GetTabAnchor()

Returns the anchor of a tab stop.

public virtual char? GetTabAnchor()

Returns

char?

a value

GetTabLeader()

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

public virtual ILineDrawer GetTabLeader()

Returns

ILineDrawer

a ILineDrawer value, a pattern drawing object

GetTabPosition()

Returns the position of a tab stop.

public virtual float GetTabPosition()

Returns

float

tabPosition, measured in absolute points

SetTabAlignment(TabAlignment)

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

public virtual void SetTabAlignment(TabAlignment tabAlignment)

Parameters

tabAlignment TabAlignment

a TabAlignment value

SetTabAnchor(char?)

Sets the anchor of a tab stop.

public virtual void SetTabAnchor(char? tabAnchor)

Parameters

tabAnchor char?

a value

SetTabLeader(ILineDrawer)

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

public virtual void SetTabLeader(ILineDrawer tabLeader)

Parameters

tabLeader ILineDrawer

a ILineDrawer value