ooodev.format.writer.modify.char.highlight package

Module contents

class ooodev.format.writer.modify.char.highlight.Highlight(*, color=-1, style_name=StyleCharKind.STANDARD, style_family='CharacterStyles')[source]

Bases: CharStyleBaseMulti

Character Style Highlight.

See also

Write Modify Character Highlight Class

New in version 0.9.0.

__init__(*, color=-1, style_name=StyleCharKind.STANDARD, style_family='CharacterStyles')[source]

Constructor

Parameters:

color (Color, optional) – Highlight Color
style_name (StyleParaKind, str, optional) – Specifies the Character Style that instance applies to. Default is Default Character Style.
style_family (str, optional) – Style family. Default CharacterStyles.

Return type:

None

classmethod from_style(doc, style_name=StyleCharKind.STANDARD, style_family='CharacterStyles')[source]

Gets instance from Document.

Parameters:

doc (object) – UNO Document Object.
style_name (StyleCharKind, str, optional) – Specifies the Character Style that instance applies to. Default is Default Character Style.
style_family (str, optional) – Style family. Default CharacterStyles.

Returns:

Highlight instance from document properties.

Return type:

Highlight