Skip to content

tabstops

tabstops

Tabstop-related proxy types.

TabStops 

TabStops(element)

Bases: ElementProxy

A sequence of TabStop objects providing access to the tab stops of a paragraph or paragraph style.

Supports iteration, indexed access, del, and len(). It is accesed using the tab_stops property of ParagraphFormat; it is not intended to be constructed directly.

Source code in src/docx/text/tabstops.py 
16
17
18
def __init__(self, element):
    super(TabStops, self).__init__(element, None)
    self._pPr = element

add_tab_stop 

add_tab_stop(position, alignment=LEFT, leader=SPACES)

Add a new tab stop at position, a Length object specifying the location of the tab stop relative to the paragraph edge.

A negative position value is valid and appears in hanging indentation. Tab alignment defaults to left, but may be specified by passing a member of the WdTabAlignment enumeration as alignment. An optional leader character can be specified by passing a member of the WdTabLeader enumeration as leader.

Source code in src/docx/text/tabstops.py 
53
54
55
56
57
58
59
60
61
62
63
64
65
def add_tab_stop(self, position, alignment=WD_TAB_ALIGNMENT.LEFT, leader=WD_TAB_LEADER.SPACES):
    """Add a new tab stop at `position`, a |Length| object specifying the location
    of the tab stop relative to the paragraph edge.

    A negative `position` value is valid and appears in hanging indentation. Tab
    alignment defaults to left, but may be specified by passing a member of the
    :ref:`WdTabAlignment` enumeration as `alignment`. An optional leader character
    can be specified by passing a member of the :ref:`WdTabLeader` enumeration as
    `leader`.
    """
    tabs = self._pPr.get_or_add_tabs()
    tab = tabs.insert_tab_in_order(position, alignment, leader)
    return TabStop(tab)

clear_all 

clear_all()

Remove all custom tab stops.

Source code in src/docx/text/tabstops.py 
67
68
69
def clear_all(self):
    """Remove all custom tab stops."""
    self._pPr._remove_tabs()

TabStop 

TabStop(element)

Bases: ElementProxy

An individual tab stop applying to a paragraph or style.

Accessed using list semantics on its containing TabStops object.

Source code in src/docx/text/tabstops.py 
78
79
80
def __init__(self, element):
    super(TabStop, self).__init__(element, None)
    self._tab = element

alignment property writable 

alignment

A member of WdTabAlignment specifying the alignment setting for this tab stop.

Read/write.

leader property writable 

leader

A member of WdTabLeader specifying a repeating character used as a "leader", filling in the space spanned by this tab.

Assigning None produces the same result as assigning WD_TAB_LEADER.SPACES. Read/write.

position property writable 

position

A Length object representing the distance of this tab stop from the inside edge of the paragraph.

May be positive or negative. Read/write.