ooodev.format.writer.modify.para.highlight package

Module contents

class ooodev.format.writer.modify.para.highlight.Highlight(*, color=-1, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')

Bases: ParaStyleBaseMulti

Paragraph Style Highlight

See also

• Write Modify Paragraph Highlight

New in version 0.9.0.

__init__(*, color=-1, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')

Constructor

Parameters:

• color (Color, optional) – Highlight Color. A value of -1 Set color to Transparent.

• 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 Highlight

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:

Highlight instance from document properties.

Return type:

Highlight

property prop_inner: Highlight

Gets/Sets Inner Highlight instance

Return type:

Highlight

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str