ooodev.format.inner.modify.calc.page.border.sides module

class ooodev.format.inner.modify.calc.page.border.sides.InnerSides(*, left=None, right=None, top=None, bottom=None, all=None)[source]

Bases: AbstractSides

Calc Page Border.

Any properties starting with prop_ set or get current instance values.

All methods starting with fmt_ can be used to chain together Sides properties.

New in version 0.9.0.

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind

class ooodev.format.inner.modify.calc.page.border.sides.Sides(*, left=None, right=None, top=None, bottom=None, all=None, style_name=CalcStylePageKind.DEFAULT, style_family='PageStyles')[source]

Bases: CellStyleBaseMulti

Page Style Border Sides.

New in version 0.9.0.

__init__(*, left=None, right=None, top=None, bottom=None, all=None, style_name=CalcStylePageKind.DEFAULT, 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 ignored

  • 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

classmethod from_style(doc, style_name=CalcStylePageKind.DEFAULT, 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:

Sides instance from document properties.

Return type:

Sides

property prop_inner: InnerSides

Gets/Sets Inner Sides instance

Return type:

InnerSides

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str