ooodev.format.inner.modify.write.page.header.area.pattern module

class ooodev.format.inner.modify.write.page.header.area.pattern.Pattern(*, bitmap=None, name='', tile=True, stretch=False, auto_name=False, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[source]

Bases: PageStyleBaseMulti

Page Footer Pattern

See also

New in version 0.9.0.

__init__(*, bitmap=None, name='', tile=True, stretch=False, auto_name=False, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[source]

Constructor

Parameters:

  • bitmap (XBitmap, optional) – Bitmap instance. If name is not already in the Bitmap Table then this property is required.

  • name (str, optional) – Specifies the name of the pattern. This is also the name that is used to store bitmap in LibreOffice Bitmap Table.

  • tile (bool, optional) – Specified if bitmap is tiled. Defaults to True.

  • stretch (bool, optional) – Specifies if bitmap is stretched. Defaults to False.

  • auto_name (bool, optional) – Specifies if name is ensured to be unique. Defaults to False.

  • style_name (StyleParaKind, 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_preset(preset, style_name=WriterStylePageKind.STANDARD, style_family='PageStyles')[source]

Gets instance from preset.

Parameters:

  • preset (PresetPatternKind) – Preset.

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

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

Returns:

Gradient instance from preset.

Return type:

Gradient

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

Gets instance from Document.

Parameters:

  • doc (Any) – UNO Document Object.

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

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

Returns:

Hatch instance from document properties.

Return type:

Hatch

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind

property prop_inner: Pattern

Gets/Sets Inner Pattern instance

Return type:

Pattern

property prop_style_name: str

Gets/Sets property Style Name

Return type:

str