ooodev.format.writer.modify.page.borders package
Module contents
- class ooodev.format.writer.modify.page.borders.Padding(*, left=None, right=None, top=None, bottom=None, all=None, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[source]
Bases:
PageStyleBaseMulti
Page Style Border Padding.
See also
New in version 0.9.0.
- __init__(*, left=None, right=None, top=None, bottom=None, all=None, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[source]
Constructor
- Parameters:
left (float, UnitT, optional) – Left (in
mm
units) or Class UnitT.right (float, UnitT, optional) – Right (in
mm
units) or Class UnitT.top (float, UnitT, optional) – Top (in
mm
units) or Class UnitT.bottom (float, UnitT, optional) – Bottom (in
mm
units) or Class UnitT.all (float, UnitT, optional) – Left, right, top, bottom (in
mm
units) or Class UnitT. If argument is present thenleft
,right
,top
, andbottom
arguments are ignored.style_name (WriterStylePageKind, str, optional) – Specifies the Page Style that instance applies to. Default is Default Page Style.
style_family (str, optional) – Style family. Default
PageStyles
.
- Return type:
None
See also
- classmethod from_style(doc, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[source]
Gets instance from Document.
- Parameters:
doc (object) – UNO Document Object.
style_name (WriterStylePageKind, str, optional) – Specifies the Paragraph Style that instance applies to. Default is Default Paragraph Style.
style_family (str, optional) – Style family. Default
PageStyles
.
- Returns:
Padding
instance from document properties.- Return type:
- property prop_style_name: str
Gets/Sets property Style Name
- Return type:
str
- class ooodev.format.writer.modify.page.borders.Shadow(*, location=ShadowLocation.BOTTOM_RIGHT, color=8421504, transparent=False, width=1.76, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[source]
Bases:
PageStyleBaseMulti
Page Style Border Shadow
See also
New in version 0.9.0.
- __init__(*, location=ShadowLocation.BOTTOM_RIGHT, color=8421504, transparent=False, width=1.76, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[source]
Constructor
- Parameters:
location (ShadowLocation, optional) – contains the location of the shadow. Default to
ShadowLocation.BOTTOM_RIGHT
.color (
Color
, optional) – contains the color value of the shadow. Defaults toStandardColor.GRAY
.transparent (bool, optional) – Shadow transparency. Defaults to False.
width (float, UnitT, optional) – contains the size of the shadow (in
mm
units) or Class UnitT. Defaults to1.76
.style_name (CalcStylePageKind, str, optional) – Specifies the Page Style that instance applies to. Default is Default Page Style.
style_family (str, optional) – Style family. Default
PageStyles
.
- Return type:
None
See also
- classmethod from_style(doc, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[source]
Gets instance from Document.
- Parameters:
doc (object) – UNO Document Object.
style_name (CalcStylePageKind, str, optional) – Specifies the Paragraph Style that instance applies to. Default is Default Paragraph Style.
style_family (str, optional) – Style family. Default
PageStyles
.
- Returns:
Shadow
instance from document properties.- Return type:
- property prop_inner: InnerShadow
Gets/Sets Inner Shadow instance
- Return type:
- property prop_style_name: str
Gets/Sets property Style Name
- Return type:
str
- class ooodev.format.writer.modify.page.borders.Sides(*, left=None, right=None, top=None, bottom=None, all=None, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[source]
Bases:
PageStyleBaseMulti
Page Style Border Sides.
See also
New in version 0.9.0.
- __init__(*, left=None, right=None, top=None, bottom=None, all=None, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[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.
all (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 ignoredstyle_name (WriterStylePageKind, str, optional) – Specifies the Page Style that instance applies to. Default is Default Page Style.
style_family (str, optional) – Style family. Default
PageStyles
.
- Return type:
None
See also
- classmethod from_style(doc, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[source]
Gets instance from Document.
- Parameters:
doc (object) – UNO Document Object.
style_name (WriterStylePageKind, str, optional) – Specifies the Paragraph Style that instance applies to. Default is Default Paragraph Style.
style_family (str, optional) – Style family. Default
PageStyles
.
- Returns:
Sides
instance from document properties.- Return type:
- property prop_style_name: str
Gets/Sets property Style Name
- Return type:
str