ooodev.adapter.style.paragraph_properties_partial module

class ooodev.adapter.style.paragraph_properties_partial.ParagraphPropertiesPartial(component)[source]

Bases: object

Partial class for ParagraphProperties.

See also

API ParagraphProperties

Parameters:: component (ParagraphProperties) –

__init__(component)[source]

Constructor

Parameters:

component (ParagraphProperties) – UNO Component that implements com.sun.star.style.ParagraphProperties interface.
interface (UnoInterface, optional) – The interface to be validated. Defaults to ParagraphProperties.

Return type:

None

property border_distance: UnitMM100 | None

Gets/Sets the distance from the border to the object.

When setting the value, it can be either a float or an instance of UnitT.

optional

Return type:: UnitMM100 | None

property bottom_border: BorderLine2StructComp | None

Gets/Sets the bottom border of the object.

Setting value can be done with a BorderLine2 or BorderLine2StructComp object.

optional

Returns:: Returns BorderLine2 or None if not supported.
Return type:: BorderLine2StructComp | None

Hint

BorderLine2 can be imported from ooo.dyn.table.border_line2

property bottom_border_distance: UnitMM100 | None

Gets/Sets the distance from the bottom border to the object.

When setting the value, it can be either a float or an instance of UnitT.

optional

Return type:: UnitMM100 | None

property break_type: BreakType | None

Gets/Sets the type of break that is applied at the beginning of the table.

optional

Returns:: Returns BreakType or None if not supported.
Return type:: BreakType | None

Hint

BreakType can be imported from ooo.dyn.style.break_type

property continuing_previous_sub_tree: bool | None

Gets that a child node of a parent node that is not counted is continuing the numbering of parent’s previous node’s sub tree.

optional

Return type:: bool | None

property drop_cap_char_style_name: str | None

Gets/Sets the character style name for drop caps.

optional

Return type:: str | None

property drop_cap_format: DropCapFormatStructComp | None

Gets/Sets whether the first characters of the paragraph are displayed in capital letters and how they are formatted.

optional

Returns:: Drop cap format or None if not supported.
Return type:: DropCapFormatStructComp

Hint

DropCapFormat can be imported from ooo.dyn.style.drop_cap_format

property drop_cap_whole_word: bool | None

Gets/Sets if the property DropCapFormat is applied to the whole first word.

optional

Return type:: bool | None

property left_border: BorderLine2StructComp | None

Gets/Sets the left border of the object.

optional

Return type:: BorderLine2StructComp | None

property left_border_distance: UnitMM100 | None

Gets/Sets the distance from the left border to the object.

When setting the value, it can be either a float or an instance of UnitT.

optional

Return type:: UnitMM100 | None

property list_id: str | None

Gets/Sets the id of the list to which the paragraph belongs.

optional

Return type:: str | None

property list_label_string: str | None

Gets reading the generated numbering list label.

optional

Return type:: str | None

property numbering_is_number: bool | None

Gets/Sets.

Returns False if the paragraph is part of a numbering, but has no numbering label.

A paragraph is part of a numbering, if a style for a numbering is set - see numbering_style_name. If the paragraph is not part of a numbering the property is void.

optional

Return type:: bool | None

property numbering_level: int | None

Gets/Sets the numbering level of the paragraph.

optional

Return type:: int | None

property numbering_rules: IndexReplaceComp | None

Gets/Sets the numbering rules applied to this paragraph.

When setting the value, it can be either an instance of XIndexReplace or IndexReplaceComp.

optional

Return type:: IndexReplaceComp | None

property numbering_start_value: int | None

Gets/Sets the start value for numbering if a new numbering starts at this paragraph.

optional

Return type:: int | None

property numbering_style_name: str | None

Gets/Sets the name of the style for the numbering.

The name must be one of the names which are available via XStyleFamiliesSupplier.

optional

Return type:: str | None

property outline_level: int | None

Gets/Sets the outline level to which the paragraph belongs

Value 0 indicates that the paragraph belongs to the body text.

Values [1..10] indicates that the paragraph belongs to the corresponding outline level.

optional

Return type:: int | None

property page_desc_name: str | None

If this property is set, it creates a page break before the paragraph it belongs to and assigns the value as the name of the new page style sheet to use.

optional

Return type:: str | None

property page_number_offset: int | None

Gets/Sets if a page break property is set at a paragraph, this property contains the new value for the page number.

optional

Return type:: int | None

property page_style_name: str | None

Gets the name of the current page style.

optional

Return type:: str | None

property para_adjust: ParagraphAdjust

Gets/Sets the adjustment of a paragraph.

Returns:: Paragraph adjustment.
Return type:: ParagraphAdjust

Hint

ParagraphAdjust can be imported from ooo.dyn.style.paragraph_adjust

property para_back_color: Color | None

Gets/Sets the paragraph background color.

optional

Returns:: Color or None if not supported.
Return type:: Color | None

property para_back_graphic: XGraphic | None

Gets/Sets the graphic for the background of a paragraph.

optional

Return type:: XGraphic | None

property para_back_graphic_filter: str | None

Gets/Sets the name of the graphic filter for the background graphic of a paragraph.

optional

Return type:: str | None

property para_back_graphic_location: GraphicLocation | None

Gets/Sets the value for the position of a background graphic.

optional

Returns:: Returns GraphicLocation or None if not supported.
Return type:: GraphicLocation | None

Hint

GraphicLocation can be imported from ooo.dyn.style.graphic_location

property para_back_graphic_url: str | None

Gets/Sets the value of a link for the background graphic of a paragraph.

Note the new behavior since it this was deprecated: This property can only be set and only external URLs are supported (no more vnd.sun.star.GraphicObject scheme). When an URL is set, then it will load the graphic and set the ParaBackGraphic property.

optional

Return type:: str | None

property para_back_transparent: bool | None

Gets/Sets if the paragraph background color is set to transparent.

This value is True if the paragraph background color is set to transparent.

optional

Return type:: bool | None

property para_bottom_margin: UnitMM100

Gets/Sets the bottom margin of the paragraph in 100th mm.

The distance between two paragraphs is specified by:

The greater one is chosen.

This property accepts int and UnitT types when setting.

Return type:: UnitMM100

property para_context_margin: bool | None

Gets/Sets if contextual spacing is used.

If True, the top and bottom margins of the paragraph should not be applied when the previous and next paragraphs have the same style.

optional

Return type:: bool | None

property para_expand_single_word: bool | None

Gets/Sets if single words are stretched.

It is only valid if para_adjust and para_last_line_adjust are also valid.

optional

Return type:: bool | None

property para_first_line_indent: int | None

Gets/Sets the indent for the first line.

optional

Return type:: int | None

property para_hyphenation_max_hyphens: int | None

Gets/Sets the maximum number of consecutive hyphens.

optional

Return type:: int | None

property para_hyphenation_max_leading_chars: int | None

Gets/Sets the minimum number of characters to remain before the hyphen character (when hyphenation is applied).

Note

Confusingly it is named Max but specifies a minimum.

optional

Return type:: int | None

property para_hyphenation_max_trailing_chars: int | None

Gets/Sets the minimum number of characters to remain after the hyphen character (when hyphenation is applied).

optional

Note

Confusingly it is named Max but specifies a minimum.

Return type:: int | None

property para_hyphenation_min_word_length: int | None

Gets/Sets the minimum word length in characters, when hyphenation is applied.

since

LibreOffice 7.4

optional

Return type:: int | None

property para_hyphenation_no_caps: bool | None

Specifies whether words written in CAPS will be hyphenated.

Setting to true will disable hyphenation of words written in CAPS for this paragraph.

optional

Return type:: bool | None

property para_hyphenation_no_last_word: bool | None

Specifies whether last word of paragraph will be hyphenated.

Setting to true will disable hyphenation of last word for this paragraph.

since

LibreOffice 7.4

optional

Return type:: bool | None

property para_hyphenation_zone: int | None

Gets/Sets the hyphenation zone, i.e. allowed extra white space in the line before applying hyphenation.

since

LibreOffice 7.4

optional

Return type:: int | None

property para_interop_grab_bag: Tuple[PropertyValue, ...] | None

Gets/Sets grab bag of paragraph properties, used as a string-any map for interim interop purposes.

This property is intentionally not handled by the ODF filter. Any member that should be handled there should be first moved out from this grab bag to a separate property.

optional:

Return type:: Tuple[PropertyValue, …] | None

property para_is_auto_first_line_indent: bool | None

Gets/Sets if the first line should be indented automatically.

optional

Return type:: bool | None

property para_is_connect_border: bool | None

Gets/Sets if borders set at a paragraph are merged with the next paragraph.

Borders are only merged if they are identical.

optional

Return type:: bool | None

property para_is_hyphenation: bool

Gets/Sets if automatic hyphenation is applied.

Return type:: bool

property para_is_numbering_restart: bool | None

Gets/Sets if the numbering rules restart, counting at the current paragraph.

optional

Return type:: bool | None

property para_keep_together: bool | None

Gets/Sets if page or column breaks between this and the following paragraph are prevented.

Setting this property to True prevents page or column breaks between this and the following paragraph.

This feature is useful for preventing title paragraphs to be the last line on a page or column.

optional

Return type:: bool | None

property para_last_line_adjust: int

Gets/Sets the adjustment of the last line.

It is only valid if para_adjust is set to block.

Return type:: int

property para_left_margin: UnitMM100

Gets/Sets the left margin of the paragraph in 1/100th mm` units.

This property accepts int and UnitT types when setting.

Return type:: UnitMM100

property para_line_number_count: bool | None

Gets/Sets if the paragraph is included in the line numbering.

optional

Return type:: bool | None

property para_line_number_start_value: int | None

Gets/Sets the start value for the line numbering.

optional

Return type:: int | None

property para_line_spacing: LineSpacingStructComp | None

Gets/Sets the type of the line spacing of a paragraph.

Setting value can be done with a LineSpacing or LineSpacingStructComp object.

optional

Returns:: Returns BorderLine2 or None if not supported.
Return type:: LineSpacingStructComp | None

Hint

LineSpacing can be imported from ooo.dyn.style.line_spacing

property para_orphans: int | None

Gets/Sets the minimum number of lines of the paragraph that have to be at bottom of a page if the paragraph is spread over more than one page.

optional

Return type:: int | None

property para_register_mode_active: bool | None

Gets/Sets if the register mode is applied to a paragraph.

Note

Register mode is only used if the register mode property of the page style is switched on.

optional

Return type:: bool | None

property para_right_margin: UnitMM100

Gets/Sets the right margin of the paragraph in 100th mm units.

This property accepts float and UnitT types when setting.

Return type:: UnitMM100

property para_shadow_format: ShadowFormat | None

Gets/Sets the type, color, and size of the shadow.

optional

Return type:: ShadowFormat | None

property para_split: bool | None

Gets/Sets - Setting this property to False prevents the paragraph from getting split into two pages or columns.

optional

Return type:: bool | None

property para_style_name: str | None

Gets/Sets the name of the current paragraph style.

optional

Return type:: str | None

property para_tab_stops: Tuple[TabStop, ...] | None

Gets/Sets the positions and kinds of the tab stops within this paragraph.

optional:

Return type:: Tuple[TabStop, …] | None

property para_top_margin: UnitMM100

determines the top margin of the paragraph in 100th mm units.

The distance between two paragraphs is specified by:

The greater one is chosen.

This property accepts float and UnitT types when setting.

Return type:: UnitMM100

property para_user_defined_attributes: NameContainerComp | None

Gets/Sets - this property stores xml attributes.

They will be saved to and restored from automatic styles inside xml files.

Can be set with XNameContainer or NameContainerComp.

optional

Return type:: NameContainerComp | None

property para_vert_alignment: ParagraphVertAlignEnum | None

Gets/Set the vertical alignment of a paragraph.

When setting the value, it can be either an integer or an instance of ParagraphVertAlignEnum.

optional

Return type:: ParagraphVertAlignEnum | None

property para_widows: int | None

Gets/Sets the minimum number of lines of the paragraph that have to be at top of a page if the paragraph is spread over more than one page.

optional

Return type:: int | None

property right_border: BorderLine2StructComp | None

Gets/Sets the right border of the object.

Setting value can be done with a BorderLine2 or BorderLine2StructComp object.

optional

Returns:: Returns BorderLine2 or None if not supported.
Return type:: BorderLine2StructComp | None

Hint

BorderLine2 can be imported from ooo.dyn.table.border_line2

property right_border_distance: UnitMM100 | None

Gets/Sets the distance from the right border to the object.

When setting the value, it can be either an float or an instance of UnitT.

optional

Return type:: UnitMM100 | None

property top_border: BorderLine2StructComp | None

Gets/Sets the top border of the object.

Setting value can be done with a BorderLine2 or BorderLine2StructComp object.

optional

Returns:: Returns BorderLine2 or None if not supported.
Return type:: BorderLine2StructComp | None

Hint

BorderLine2 can be imported from ooo.dyn.table.border_line2

property top_border_distance: UnitMM100 | None

Gets/Sets the distance from the top border to the object.

When setting the value, it can be either an float or an instance of UnitT.

optional

Return type:: UnitMM100 | None