Write Modify Paragraph Highlight

The ooodev.format.writer.modify.para.highlight.Highlight class is used to modify the values seen in Fig. 1091 of a paragraph style.

Setup

from ooodev.format.writer.modify.para.highlight import Highlight, StyleParaKind
from ooodev.utils.color import StandardColor
from ooodev.office.write import Write
from ooodev.gui import GUI
from ooodev.loader.lo import Lo

def main() -> int:
    with Lo.Loader(Lo.ConnectPipe()):
        doc = Write.create_doc()
        GUI.set_visible(doc=doc)
        Lo.delay(300)
        GUI.zoom(GUI.ZoomEnum.ZOOM_150_PERCENT)

        para_hl_style = Highlight(color=StandardColor.YELLOW_LIGHT3, style_name=StyleParaKind.STANDARD)
        para_hl_style.apply(doc)

        style_obj = Highlight.from_style(doc=doc, style_name=StyleParaKind.STANDARD)
        assert style_obj.prop_style_name == str(StyleParaKind.STANDARD)
        Lo.delay(1_000)

        Lo.close_doc(doc)

    return 0


if __name__ == "__main__":
    sys.exit(main())

Apply Highlight to a style

Before applying Style

Writer dialog Paragraph Area Color style default — Fig. 1091 Writer dialog Paragraph Highlighting style default

Apply style

# ... other code

para_hl_style = Highlight(color=StandardColor.YELLOW_LIGHT3, style_name=StyleParaKind.STANDARD)
para_hl_style.apply(doc)

After applying style

Writer dialog Paragraph Highlight Color style changed — Fig. 1092 Writer dialog Paragraph Highlight Color style changed

Getting the highlight color from a style

# ... other code

style_obj = Highlight.from_style(doc=doc, style_name=StyleParaKind.STANDARD)
assert style_obj.prop_style_name == str(StyleParaKind.STANDARD)