ooodev.format.inner.modify.write.para.border.borders module
- class ooodev.format.inner.modify.write.para.border.borders.Borders(*, right=None, left=None, top=None, bottom=None, border_side=None, shadow=None, padding=None, merge=None, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]
Bases:
ParaStyleBaseMulti
Paragraph Style Borders
See also
New in version 0.9.0.
- __init__(*, right=None, left=None, top=None, bottom=None, border_side=None, shadow=None, padding=None, merge=None, style_name=StyleParaKind.STANDARD, style_family='ParagraphStyles')[source]
Constructor
- Parameters:
left (Side, None, optional) – Determines the line style at the left edge.
right (Side, None, optional) – Determines the line style at the right edge.
top (Side, None, optional) – Determines the line style at the top edge.
bottom (Side, None, optional) – Determines the line style at the bottom edge.
border_side (Side, None, optional) – Determines the line style at the top, bottom, left, right edges. If this argument has a value then arguments
top
,bottom
,left
,right
are ignoredshadow (BorderShadow, None, optional) – Character Shadow
padding (BorderPadding, None, optional) – Character padding
merge (bool, None, optional) – Merge with next paragraph
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
.
- 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 Paragraph Style that instance applies to. Default is Default Paragraph Style.
style_family (str, optional) – Style family. Default
ParagraphStyles
.
- Returns:
Borders
instance from document properties.- Return type:
- property prop_style_name: str
Gets/Sets property Style Name
- Return type:
str