TabStop class

TabStop class

Represents a single custom tab stop. The TabStop object is a member of the TabStopCollection collection. To learn more, visit the Aspose.Words Document Object Model (DOM) documentation article.

Remarks

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 TabStop.alignment to TabAlignment.CLEAR.

For more information see TabStopCollection.

Constructors

NameDescription
TabStop(position)Initializes a new instance of this class.
TabStop(position, alignment, leader)Initializes a new instance of this class.

Properties

NameDescription
alignmentGets or sets the alignment of text at this tab stop.
is_clearReturns True if this tab stop clears any existing tab stops in this position.
leaderGets or sets the type of the leader line displayed under the tab character.
positionGets the position of the tab stop in points.

Methods

NameDescription
equals(rhs)Compares with the specified TabStop.

Examples

Shows how to modify the position of the right tab stop in TOC related paragraphs.

doc = aw.Document(file_name=MY_DIR + 'Table of contents.docx')
# Iterate through all paragraphs with TOC result-based styles; this is any style between TOC and TOC9.
for para in doc.get_child_nodes(aw.NodeType.PARAGRAPH, True):
    para = para.as_paragraph()
    if para.paragraph_format.style.style_identifier >= aw.StyleIdentifier.TOC1 and para.paragraph_format.style.style_identifier <= aw.StyleIdentifier.TOC9:
        # Get the first tab used in this paragraph, this should be the tab used to align the page numbers.
        tab = para.paragraph_format.tab_stops[0]
        # Replace the first default tab, stop with a custom tab stop.
        para.paragraph_format.tab_stops.remove_by_position(tab.position)
        para.paragraph_format.tab_stops.add(position=tab.position - 50, alignment=tab.alignment, leader=tab.leader)
doc.save(file_name=ARTIFACTS_DIR + 'Styles.ChangeTocsTabStops.docx')

See Also

TabLeader enumeration TabStopCollection class