ooodev.format.inner.modify.calc.page.header.header module

class ooodev.format.inner.modify.calc.page.header.header.Header(*, 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: CellStyleBaseMulti

Page Header 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

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:

Header or Footer instance from document properties.

Return type:

Header

fmt_spacing_dyn

Descriptor to raise an exception when a method is accessed when disabled.

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind

property prop_inner: InnerStyle

Gets/Sets Inner Footer instance

Return type:

InnerStyle

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str

space_dyn

Descriptor to raise an exception when an attribute is accessed after deletion.

class ooodev.format.inner.modify.calc.page.header.header.InnerStyle(*, on=None, shared=None, shared_first=None, margin_left=None, margin_right=None, spacing=None, spacing_dyn=None, height=None, height_auto=None)[source]

Bases: AbstractHF

Page Header/Footer Inner Settings

New in version 0.9.0.

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind