OOO Development Tools

Book:

  • Python LibreOffice Programming

Help:

  • Help Documentation

Guides:

  • Guides

Misc:

  • Events
  • Version History
  • Credits and Acknowledgements

DEVELOPER API:

  • ooodev
    • adapter
    • calc
    • config
    • conn
    • dialog
    • draw
    • events
    • exceptions
    • form
    • format
      • Subpackages
        • ooodev.format.calc package
        • ooodev.format.chart2 package
        • ooodev.format.draw package
        • ooodev.format.impress package
        • ooodev.format.inner package
        • ooodev.format.proto package
        • ooodev.format.writer package
      • Submodules
      • Module contents
    • formatters
    • Globals
    • gui
    • io
    • listeners
    • loader
    • macro
    • meta
    • office
    • proto
    • theme
    • units
    • uno_helper
    • utils
    • wrapper
    • write

DEVELOPING ODEV:

  • Dev Docs
OOO Development Tools
  • ooodev
  • format
  • ooodev.format.calc package
  • ooodev.format.calc.modify package
  • ooodev.format.calc.modify.page package
  • ooodev.format.calc.modify.page.footer package
  • ooodev.format.calc.modify.page.footer.area package
  • Edit on GitHub

ooodev.format.calc.modify.page.footer.area package

Module contents

class ooodev.format.calc.modify.page.footer.area.Color(*, color=-1, style_name=CalcStylePageKind.DEFAULT, style_family='PageStyles')[source]

Bases: Color

Page Footer Color

See also

  • Calc Modify Page Footer Background

New in version 0.9.0.

__init__(*, color=-1, style_name=CalcStylePageKind.DEFAULT, style_family='PageStyles')[source]

Constructor

Parameters:
  • color (Color, optional) – FillColor Color.

  • 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 Footer Background

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind

class ooodev.format.calc.modify.page.footer.area.Img(*, bitmap=None, name='', mode=ImgStyleKind.TILED, size=None, position=None, pos_offset=None, tile_offset=None, auto_name=False, style_name=CalcStylePageKind.DEFAULT, style_family='PageStyles')[source]

Bases: Img

Page Style Image

See also

  • Calc Modify Page Footer Background

New in version 0.9.0.

__init__(*, bitmap=None, name='', mode=ImgStyleKind.TILED, size=None, position=None, pos_offset=None, tile_offset=None, auto_name=False, style_name=CalcStylePageKind.DEFAULT, 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 image. This is also the name that is used to store bitmap in LibreOffice Bitmap Table.

  • mode (ImgStyleKind, optional) – Specifies the image style, tiled, stretched etc. Default ImgStyleKind.TILED.

  • size (SizePercent, SizeMM, optional) – Size in percent (0 - 100) or size in mm units.

  • position (RectanglePoint) – Tiling position of Image.

  • pos_offset (Offset, optional) – Tiling position offset.

  • tile_offset (OffsetColumn, OffsetRow, optional) – The tiling offset.

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

  • 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 Footer Background

property prop_format_kind: FormatKind

Gets the kind of style

Return type:

FormatKind

Previous Next

© Copyright 2022-2024, :Barry-Thomas-Paul: Moss. Revision f6681664.

Built with Sphinx using a theme provided by Read the Docs.