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

class ooodev.format.inner.modify.write.char.border.sides.Sides(*, left=None, right=None, top=None, bottom=None, border_side=None, style_name=StyleCharKind.STANDARD, style_family='CharacterStyles')[source]

Bases: CharStyleBaseMulti

Character Style Border Sides (lines).

See also

New in version 0.9.0.

__init__(*, left=None, right=None, top=None, bottom=None, border_side=None, style_name=StyleCharKind.STANDARD, style_family='CharacterStyles')[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 ignored

  • shadowed (bool, optional) – Specifies if the characters are formatted and displayed with a shadow effect.

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

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

Return type:

None

See also

classmethod from_style(doc, style_name=StyleCharKind.STANDARD, style_family='CharacterStyles')[source]

Gets instance from Document.

Parameters:

  • doc (object) – UNO Document Object.

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

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

Returns:

Sides instance from document 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