ParagraphFormat
paper-docx 0.2.0 API reference
Provides access to paragraph formatting such as justification, indentation, line spacing, space before and after, and widow/orphan control.
Attributes
alignment
attributealignmentA member of the :ref:WdParagraphAlignment enumeration specifying the
justification setting for this paragraph.
A value of None indicates paragraph alignment is inherited from the style
hierarchy.
element
attributeelementThe lxml element proxied by this object.
first_line_indent
attributefirst_line_indentLength value specifying the relative difference in indentation for the
first line of the paragraph.
A positive value causes the first line to be indented. A negative value produces
a hanging indent. None indicates first line indentation is inherited from the
style hierarchy.
keep_together
attributekeep_togetherTrue if the paragraph should be kept "in one piece" and not broken across a
page boundary when the document is rendered.
None indicates its effective value is inherited from the style hierarchy.
keep_with_next
attributekeep_with_nextTrue if the paragraph should be kept on the same page as the subsequent
paragraph when the document is rendered.
For example, this property could be used to keep a section heading on the same
page as its first paragraph. None indicates its effective value is inherited
from the style hierarchy.
left_indent
attributeleft_indentLength value specifying the space between the left margin and the left side
of the paragraph.
None indicates the left indent value is inherited from the style hierarchy.
Use an Inches value object as a convenient way to apply indentation in units
of inches.
line_spacing
attributeline_spacingfloat or Length value specifying the space between baselines in
successive lines of the paragraph.
A value of None indicates line spacing is inherited from the style hierarchy.
A float value, e.g. 2.0 or 1.75, indicates spacing is applied in
multiples of line heights. A Length value such as Pt(12) indicates spacing
is a fixed height. The Pt value class is a convenient way to apply line
spacing in units of points. Assigning None resets line spacing to inherit from
the style hierarchy.
line_spacing_rule
attributeline_spacing_ruleA member of the :ref:WdLineSpacing enumeration indicating how the value of
:attr:line_spacing should be interpreted.
Assigning any of the :ref:WdLineSpacing members :attr:SINGLE,
:attr:DOUBLE, or :attr:ONE_POINT_FIVE will cause the value of
:attr:line_spacing to be updated to produce the corresponding line spacing.
page_break_before
attributepage_break_beforeTrue if the paragraph should appear at the top of the page following the
prior paragraph.
None indicates its effective value is inherited from the style hierarchy.
part
attributepartXmlPartThe package part containing this object.
right_indent
attributeright_indentLength value specifying the space between the right margin and the right
side of the paragraph.
None indicates the right indent value is inherited from the style hierarchy.
Use a Cm value object as a convenient way to apply indentation in units of
centimeters.
space_after
attributespace_afterLength value specifying the spacing to appear between this paragraph and
the subsequent paragraph.
None indicates this value is inherited from the style hierarchy. Length
objects provide convenience properties, such as :attr:~.Length.pt and
:attr:~.Length.inches, that allow easy conversion to various length units.
space_before
attributespace_beforeLength value specifying the spacing to appear between this paragraph and
the prior paragraph.
None indicates this value is inherited from the style hierarchy. Length
objects provide convenience properties, such as :attr:~.Length.pt and
:attr:~.Length.cm, that allow easy conversion to various length units.
tab_stops
attributetab_stopsTabStops object providing access to the tab stops defined for this
paragraph format.
widow_control
attributewidow_controlTrue if the first and last lines in the paragraph remain on the same page
as the rest of the paragraph when Word repaginates the document.
None indicates its effective value is inherited from the style hierarchy.