TabStop Struct

Namespace:
GemBox.Document
Assembly:
GemBox.Document.dll

Represents a single custom tab stop within a set of custom tab stops applied at Tabs property.

public struct TabStop : IEquatable<TabStop>
Public Structure TabStop
    Implements IEquatable(Of TabStop)
Implements
System.IEquatable<TabStop>
Remarks

Creating customized tabs in a document is accomplished with TabStop structure that enables you to define tab position, tab leader character and surrounding text alignment.

TabStops should be inserted into Tabs collection to be used in a Paragraph.

Tabs are inserted into a document content with SpecialCharacter elements that have CharacterType property equal to Tab.

Values Bar and List are currently not supported in PDF, XPS and image file formats.

Constructors

TabStop(Double, TabStopAlignment)

Initializes a new instance of the TabStop struct.

public TabStop(double position, TabStopAlignment alignment)
Public Sub New(position As Double, alignment As TabStopAlignment)
Parameters
position
System.Double

The tab stop position.

alignment
TabStopAlignment

The tab stop alignment.

TabStop(Double, TabStopAlignment, TabStopLeader)

Initializes a new instance of the TabStop struct.

public TabStop(double position, TabStopAlignment alignment, TabStopLeader leader)
Public Sub New(position As Double, alignment As TabStopAlignment, leader As TabStopLeader)
Parameters
position
System.Double

The tab stop position.

alignment
TabStopAlignment

The tab stop alignment.

leader
TabStopLeader

The tab stop leader.

Properties

Alignment

Gets the alignment of the current TabStop, which determines the behavior of the tab stop and the alignment which shall be applied to text entered at the current TabStop.

public readonly TabStopAlignment Alignment { get; }
Public ReadOnly Property Alignment As TabStopAlignment
Property Value
TabStopAlignment

The alignment of the current TabStop.

Leader

Gets the character which shall be used to fill in the space created by a tab which ends at this TabStop.

public readonly TabStopLeader Leader { get; }
Public ReadOnly Property Leader As TabStopLeader
Property Value
TabStopLeader

The character which shall be used to fill in the space created by a tab which ends at this TabStop.

Position

Gets the position of the current TabStop, in points, with respect to the current page margins.

public readonly double Position { get; }
Public ReadOnly Property Position As Double
Property Value
System.Double

The position of the current TabStop, in points, with respect to the current page margins.

Methods

Equals(TabStop)

Determines whether the other TabStop is equal to this TabStop instance.

public bool Equals(TabStop other)
Public Function Equals(other As TabStop) As Boolean
Parameters
other
TabStop

The other tab stop to compare with this tab stop instance.

Returns
System.Boolean

true if the other TabStop is equal to this TabStop instance; otherwise, false.

Equals(Object)

Determines whether the specified System.Object is equal to this TabStop instance.

public override bool Equals(object obj)
Public Overrides Function Equals(obj As Object) As Boolean
Parameters
obj
System.Object

The System.Object to compare with this tab stop instance.

Returns
System.Boolean

true if the specified System.Object is a TabStop and is equal to this TabStop instance; otherwise, false.

Overrides
System.ValueType.Equals(System.Object)

GetHashCode()

Returns a hash code for this TabStop instance.

public override int GetHashCode()
Public Overrides Function GetHashCode As Integer
Returns
System.Int32

An integer value that specifies a hash value for this TabStop instance.

Overrides
System.ValueType.GetHashCode()

Operators

Equality(TabStop, TabStop)

Determines whether first and second TabStops are equal.

public static bool operator ==(TabStop first, TabStop second)
Public Shared Operator =(first As TabStop, second As TabStop) As Boolean
Parameters
first
TabStop

The first tab stop.

second
TabStop

The second tab stop.

Returns
System.Boolean

true if first and second tab stops are equal; otherwise, false.

Inequality(TabStop, TabStop)

Determines whether first and second TabStops are not equal.

public static bool operator !=(TabStop first, TabStop second)
Public Shared Operator <>(first As TabStop, second As TabStop) As Boolean
Parameters
first
TabStop

The first tab stop.

second
TabStop

The second tab stop.

Returns
System.Boolean

true if first and second tab stops are not equal; otherwise, false.

Implements

System.IEquatable<T>

See Also