ooodev.format.calc.modify.page.header package

Subpackages

• ooodev.format.calc.modify.page.header.area package
  • Module contents
    • Color
      • Color.__init__()
      • Color.from_style()
      • Color.prop_format_kind
      • Color.prop_inner
      • Color.prop_style_name
    • Img
      • Img.__init__()
      • Img.from_preset()
      • Img.prop_format_kind
      • Img.prop_inner
      • Img.prop_style_name
• ooodev.format.calc.modify.page.header.borders package
  • Module contents
    • Padding
      • Padding.__init__()
      • Padding.from_style()
      • Padding.prop_format_kind
      • Padding.prop_inner
      • Padding.prop_style_name
    • Shadow
      • Shadow.__init__()
      • Shadow.from_style()
      • Shadow.prop_format_kind
      • Shadow.prop_inner
      • Shadow.prop_style_name
    • Sides
      • Sides.__init__()
      • Sides.from_style()
      • Sides.prop_format_kind
      • Sides.prop_inner
      • Sides.prop_style_name

Module contents

class ooodev.format.calc.modify.page.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')

Bases: CellStyleBaseMulti

Page Header Settings

See also

• Calc Modify Page Header

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')

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

• Calc Modify Page Header

classmethod from_style(doc, style_name=CalcStylePageKind.DEFAULT, style_family='PageStyles')

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.