ooodev.format.inner.modify.write.para.font.font_effects module
- class ooodev.format.inner.modify.write.para.font.font_effects.FontEffects(*, color=None, transparency=None, overline=None, underline=None, strike=None, word_mode=None, case=None, relief=None, outline=None, hidden=None, shadowed=None, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]
Bases:
ParaStyleBaseMulti
Style Font Effects
See also
New in version 0.9.0.
- __init__(*, color=None, transparency=None, overline=None, underline=None, strike=None, word_mode=None, case=None, relief=None, outline=None, hidden=None, shadowed=None, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]
Constructor
- Parameters:
color (
Color
, optional) – The value of the text color. If value is-1
the automatic color is applied.transparency (Intensity, int, optional) – The transparency value from
0
to100
for the font color.overline (FontLine, optional) – Character overline values.
underline (FontLine, optional) – Character underline values.
strike (FontStrikeoutEnum, optional) – Determines the type of the strike out of the character.
word_mode (bool, optional) – If
True
, the underline and strike-through properties are not applied to white spaces.case (CaseMapEnum, optional) – Specifies the case of the font.
relief (FontReliefEnum, optional) – Specifies the relief of the font.
outline (bool, optional) – Specifies if the font is outlined.
hidden (bool, optional) – Specifies if the font is hidden.
shadowed (bool, optional) – Specifies if the characters are formatted and displayed with a shadow effect.
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
ParagraphStyles
.
- Return type:
None
See also
- classmethod from_style(doc, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]
Gets instance from Document.
- Parameters:
doc (Any) – UNO Document Object.
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
ParagraphStyles
.
- Returns:
FontEffects
instance from document properties.- Return type:
- property prop_inner: FontEffects
Gets/Sets Inner Font Effects instance
- Return type:
- property prop_style_name: str
Gets/Sets property Style Name
- Return type:
str