ooodev.format.calc.modify.page.footer package

Subpackages

Module contents

class ooodev.format.calc.modify.page.footer.Footer(*, on=None, shared=None, shared_first=None, margin_left=None, margin_right=None, spacing=None, height=None, height_auto=None, style_name=CalcStylePageKind.DEFAULT, style_family='PageStyles')[source]

Bases: Header

Page Footer Settings

See also

New in version 0.9.0.

__init__(*, on=None, shared=None, shared_first=None, margin_left=None, margin_right=None, spacing=None, height=None, height_auto=None, style_name=CalcStylePageKind.DEFAULT, style_family='PageStyles')[source]

Constructor

Parameters:

  • on (bool | None, optional) – Specifics if Footer is on.

  • shared (bool | None, optional) – Specifies if same contents left and right.

  • shared_first (bool | None, optional) – Specifies if same contents on first page.

  • margin_left (float | None, optional) – Specifies Left Margin in mm units.

  • margin_right (float | None, optional) – Specifies Right Margin in mm units.

  • spacing (float | None, optional) – Specifies Spacing in mm units.

  • height (float | None, optional) – Specifies Height in mm units.

  • height_auto (bool | None, optional) – Specifies if auto-fit height is used.

  • 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

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind