ooodev.format.inner.modify.write.page.header.border.padding module

class ooodev.format.inner.modify.write.page.header.border.padding.InnerPadding(*, left=None, right=None, top=None, bottom=None, all=None)

Bases: AbstractPadding

Page Style Footer Border Padding

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

All methods starting with fmt_ can be used to chain together 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.write.page.header.border.padding.Padding(*, left=None, right=None, top=None, bottom=None, padding_all=None, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')

Bases: PageStyleBaseMulti

Page Style Header Border Padding.

See also

• Write Modify Page Header Borders

New in version 0.9.0.

__init__(*, left=None, right=None, top=None, bottom=None, padding_all=None, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')

Constructor

Parameters:

• left (float, UnitT, optional) – Left (in mm units) or Class UnitT.

• right (float, UnitT, optional) – Right (in mm units) or Class UnitT.

• top (float, UnitT, optional) – Top (in mm units) or Class UnitT.

• bottom (float, UnitT, optional) – Bottom (in mm units) or Class UnitT.

• all (float, UnitT, optional) – Left, right, top, bottom (in mm units) or Class UnitT. If argument is present then left, right, top, and bottom arguments are ignored.

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

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

• padding_all (float | None) –

Return type:

None

See also

• Write Modify Page Header Borders

classmethod from_style(doc, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')

Gets instance from Document.

Parameters:

• doc (Any) – UNO Document Object.

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

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

Returns:

Padding instance from document properties.

Return type:

Padding

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind

property prop_inner: InnerPadding

Gets/Sets Inner Padding instance

Return type:

InnerPadding

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str