ooodev.format.inner.modify.write.page.page.layout_settings module

class ooodev.format.inner.modify.write.page.page.layout_settings.LayoutSettings(*, layout=None, numbers=None, ref_style=None, right_gutter=None, gutter_pos_left=None, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[source]

Bases: PageStyleBaseMulti

Page Layout Setting style

See also

New in version 0.9.0.

Changed in version 0.9.7: Added gutter_pos_left parameter.

__init__(*, layout=None, numbers=None, ref_style=None, right_gutter=None, gutter_pos_left=None, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[source]

Constructor

Parameters:

  • layout (PageStyleLayout, optional) – Specifies the layout of the page.

  • numbers (NumberingTypeEnum, optional) – Specifies the default numbering type for this page.

  • ref_style (str, StyleParaKind, optional) – Specifies the name of the paragraph style that is used as reference of the register mode.

  • right_gutter (bool, optional) – Specifies that the page gutter shall be placed on the right side of the page.

  • gutter_pos_left (bool, optional) – Specifies if the gutters position is Left or Top of page. If True then gutter is left, if False gutter is top.

  • 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.

Return type:

None

See also

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

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:

LayoutSettings instance from document properties.

Return type:

LayoutSettings

property prop_gutter_pos_left: bool | None

Gets/Sets if the gutters position is Left or Top of page. If True then gutter is left, if False gutter is top.

Return type:

bool | None

property prop_inner: LayoutSettings

Gets/Sets Inner Layout Settings instance

Return type:

LayoutSettings

property prop_layout: PageStyleLayout | None

Gets/Sets Page Style Layout value

Return type:

PageStyleLayout | None

property prop_numbers: NumberingTypeEnum | None

Gets/Sets Page Numbering value

Return type:

NumberingTypeEnum | None

property prop_ref_style: str | None

Gets/Sets the name of the paragraph style that is used as reference of the register mode.

Return type:

str | None

property prop_right_gutter: bool | None

Gets/Sets if the page gutter is placed on the right side of the page.

Return type:

bool | None

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str