ooodev.format.inner.modify.write.frame.border.sides module

class ooodev.format.inner.modify.write.frame.border.sides.Sides(*, left=None, right=None, top=None, bottom=None, all=None, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]

Bases: FrameStyleBaseMulti

Frame Style Border Shadow.

New in version 0.9.0.

__init__(*, left=None, right=None, top=None, bottom=None, all=None, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[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 ignored

  • style_name (StyleFrameKind, str, optional) – Specifies the Frame Style that instance applies to. Default is Default Frame Style.

  • style_family (str, optional) – Style family. Default FrameStyles.

Return type:

None

classmethod from_style(doc, style_name=StyleFrameKind.FRAME, style_family='FrameStyles')[source]

Gets instance from Document.

Parameters:

  • doc (object) – UNO Document Object.

  • style_name (StyleFrameKind, str, optional) – Specifies the Frame Style that instance applies to. Default is Default Frame Style.

  • style_family (str, optional) – Style family. Default FrameStyles.

Returns:

Sides instance from style properties.

Return type:

Sides

property prop_inner: Sides

Gets/Sets Inner Sides instance

Return type:

Sides

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str