ASPOSE home

com.aspose.words
Class TabStop

java.lang.Object
    extended by com.aspose.words.TabStop
All Implemented Interfaces:
java.lang.Cloneable

public class TabStop
extends java.lang.Object

Represents a single custom tab stop. The TabStop object is a member of the TabStops collection.

Normally, a tab stop specifies a position where a tab stop exists. But because tab stops can be inherited from parent styles, it might be needed for the child object to define explicitly that there is no tab stop at a given position. To clear an inherited tab stop at a given position, create a TabStop object and set Alignment to TabAlignment.Clear.

Fore more information see TabStops.

See Also:
ParagraphFormat, TabStops, Document.DefaultTabStop

Constructor Summary
TabStop(double position)
           Initializes a new instance of this class.
TabStop(double position, byte alignment, byte leader)
           Initializes a new instance of this class.
 
Property Getters/Setters Summary
bytegetAlignment()
voidsetAlignment(byte value)
           Gets or sets the alignment of text at this tab stop. The value of the property is TabAlignment integer constant.
booleanisClear()
           Returns true if this tab stop clears any existing tab stops in this position.
bytegetLeader()
voidsetLeader(byte value)
           Gets or sets the type of the leader line displayed under the tab character. The value of the property is TabLeader integer constant.
doublegetPosition()
           Gets the position of the tab stop in points.
 

Constructor Detail

TabStop

public TabStop(double position)
Initializes a new instance of this class.

TabStop

public TabStop(double position, byte alignment, byte leader)
Initializes a new instance of this class.
Parameters:
position - The position of the tab stop in points.
alignment - A TabAlignment value that specifies the alignment of text at this tab stop.
leader - A TabLeader value that specifies the type of the leader line displayed under the tab character.

Property Getters/Setters Detail

getPosition

public double getPosition()
Gets the position of the tab stop in points.

getAlignment/setAlignment

public byte getAlignment()

public void setAlignment(byte value)
Gets or sets the alignment of text at this tab stop. The value of the property is TabAlignment integer constant.

getLeader/setLeader

public byte getLeader()

public void setLeader(byte value)
Gets or sets the type of the leader line displayed under the tab character. The value of the property is TabLeader integer constant.

isClear

public boolean isClear()
Returns true if this tab stop clears any existing tab stops in this position.

See Also:
          Wiki - the home page for the Aspose.Words Product Documentation that includes Programmer's Guide, Knowledge Base and other articles.
          Aspose.Words Support Forum - our preferred method of support.
          Aspose.Words Team - contact Aspose.Words Team.


ASPOSE home