ooodev.format.inner.modify.write.page.footer.area.pattern module

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

Bases: Pattern

Page Footer Pattern

See also

Write Modify Page Footer Area

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