ooodev.format.inner.partial.font.highlight_partial module
- class ooodev.format.inner.partial.font.highlight_partial.HighlightPartial(factory_name, component, lo_inst=None)[source]
Bases:
object
Partial class for Font Highlight.
- Parameters:
factory_name (str) –
component (Any) –
lo_inst (LoInst | None) –
- __init__(factory_name, component, lo_inst=None)[source]
- Parameters:
factory_name (str) –
component (Any) –
lo_inst (LoInst | None) –
- Return type:
None
- style_highlight(color)[source]
Style Font Highlight.
- Parameters:
color (Color, optional) – Highlight Color. A value of
-1
Set color to Transparent.- Raises:
CancelEventError – If the event
before_style_font_highlight
is cancelled and not handled.- Returns:
Font Only instance or
None
if cancelled.- Return type:
HighlightT | None
See also
- style_highlight_get()[source]
Gets the font highlight style.
- Raises:
CancelEventError – If the event
before_style_font_highlight_get
is cancelled and not handled.- Returns:
Font style or
None
if cancelled.- Return type:
HighlightT | None