ooodev.format.inner.modify.write.page.area.hatch module
- class ooodev.format.inner.modify.write.page.area.hatch.Hatch(*, style=HatchStyle.SINGLE, color=0, space=0.0, angle=0, bg_color=-1, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[source]
Bases:
PageStyleBaseMulti
Page Style Pattern
See also
New in version 0.9.0.
- __init__(*, style=HatchStyle.SINGLE, color=0, space=0.0, angle=0, bg_color=-1, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[source]
Constructor
- Parameters:
style (HatchStyle, optional) – Specifies the kind of lines used to draw this hatch. Default
HatchStyle.SINGLE
.color (
Color
, optional) – Specifies the color of the hatch lines. Default0
.space (float, UnitT, optional) – Specifies the space between the lines in the hatch (in
mm
units) or Class UnitT. Default0.0
angle (Angle, int, optional) – Specifies angle of the hatch in degrees. Default to
0
.bg_color (
Color
, optional) – Specifies the background Color. Set this-1
(default) for no background color.style_name (StyleParaKind, str, optional) – Specifies the Page Style that instance applies to.
Style. (Default is Default Page) –
style_family (str, optional) – Style family. Default
PageStyles
.
- Return type:
None
See also
- classmethod from_preset(preset, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[source]
Gets an instance from a preset.
- Parameters:
preset (PresetHatchKind) – Preset.
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
PageStyles
.
- Returns:
Hatch
instance from preset.- Return type:
- classmethod from_style(doc, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[source]
Gets instance from Document.
- Parameters:
doc (object) – 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
PageStyles
.
- Returns:
Hatch
instance from document properties.- Return type:
- property prop_style_name: str
Gets/Sets property Style Name
- Return type:
str