ooodev.format.inner.modify.write.para.area.img module
- class ooodev.format.inner.modify.write.para.area.img.Img(*, bitmap=None, name='', mode=ImgStyleKind.TILED, size=None, position=None, pos_offset=None, tile_offset=None, auto_name=False, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]
Bases:
ParaStyleBaseMulti
Paragraph Style Fill Coloring
See also
New in version 0.9.0.
- __init__(*, bitmap=None, name='', mode=ImgStyleKind.TILED, size=None, position=None, pos_offset=None, tile_offset=None, auto_name=False, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]
Constructor
- Parameters:
color (
Color
, optional) – FillColor Colorstyle_name (StyleParaKind, str, optional) – Specifies the Paragraph Style that instance applies to. Default is Default Paragraph Style.
style_family (str, optional) – Style family. Default
ParagraphStyles
.bitmap (XBitmap | None) –
name (str) –
mode (ImgStyleKind) –
size (SizePercent | SizeMM | None) –
position (RectanglePoint | None) –
pos_offset (Offset | None) –
tile_offset (OffsetColumn | OffsetRow | None) –
auto_name (bool) –
- Return type:
None
See also
- classmethod from_preset(preset, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]
Gets an instance from a preset
- Parameters:
preset (PresetImageKind) – Preset
style_name (StyleParaKind | str) –
style_family (str) –
- Returns:
Instance from preset.
- Return type:
- 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 Paragraph Style that instance applies to. Default is Default Paragraph Style.
style_family (str, optional) – Style family. Default
ParagraphStyles
.
- Returns:
Img
instance from document properties.- Return type:
- property prop_style_name: str
Gets/Sets property Style Name
- Return type:
str