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

class ooodev.format.inner.modify.write.para.text_flow.flow_options.FlowOptions(*, orphans=None, widows=None, keep=None, no_split=None, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')

Bases: ParaStyleBaseMulti

Paragraph Style Flow Options

See also

• Write Modify Paragraph Text Flow

New in version 0.9.0.

__init__(*, orphans=None, widows=None, keep=None, no_split=None, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')

Constructor

Parameters:

• orphans (int, optional) – Number of Orphan Control Lines.

• widows (int, optional) – Number Widow Control Lines.

• keep (bool, optional) – Keep with next paragraph.

• no_split (bool, optional) – Do not split paragraph.

• 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: FlowOptions

Gets/Sets Inner Flow Options instance

Return type:

FlowOptions

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str