ooodev.format.inner.modify.write.para.text_flow.breaks module

class ooodev.format.inner.modify.write.para.text_flow.breaks.Breaks(*, type=None, style=None, num=None, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')

Bases: ParaStyleBaseMulti

Paragraph Style Breaks

See also

• Write Modify Paragraph Text Flow

New in version 0.9.0.

__init__(*, type=None, style=None, num=None, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')

Constructor

Parameters:

• type (BreakType, optional) – Break type.

• style (str, optional) – Style to apply to break.

• num (int, optional) – Page number to apply to break.

• style_name (StyleParaKind, str, optional) – Specifies the Paragraph Style that instance applies to. Default is Default Paragraph Style.

• style_family (str, optional) – Style family. Default ParagraphStyles.

Return type:

None

See also

• Write Modify Paragraph Text Flow

classmethod from_style(doc, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')

Gets instance from Document.

Parameters:

• doc (Any) – UNO Document Object.

• style_name (StyleParaKind, str, optional) – Specifies the Paragraph Style that instance applies to. Default is Default Paragraph Style.

• style_family (str, optional) – Style family. Default ParagraphStyles.

Returns:

Breaks instance from document properties.

Return type:

Breaks

property prop_inner: Breaks

Gets/Sets Inner Breaks instance

Return type:

Breaks

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str