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

class ooodev.format.inner.modify.write.para.text_flow.hyphenation.Hyphenation(*, auto=None, no_caps=None, start_chars=None, end_chars=None, max=None, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')

Bases: ParaStyleBaseMulti

Paragraph Style Hyphenation

See also

• Write Modify Paragraph Text Flow

New in version 0.9.0.

__init__(*, auto=None, no_caps=None, start_chars=None, end_chars=None, max=None, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')

Constructor

Parameters:

• auto (bool, optional) – Hyphenate automatically.

• no_caps (bool, optional) – Don’t hyphenate word in caps.

• start_chars (int, optional) – Characters at line begin.

• end_chars (int, optional) – characters at line end.

• max (int, optional) – Maximum consecutive hyphenated lines.

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

Gets/Sets Inner Hyphenation instance

Return type:

Hyphenation

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str