OOO Development Tools

Book:

  • Python LibreOffice Programming

Help:

  • Help Documentation
    • Spreadsheets (Calc)
      • Calc Class
      • Calc Formatting and Style
        • Direct
        • Direct Static
        • Modify
        • Style
    • Chart2
    • Draw Documents (Draw)
    • Text Documents (Writer)
    • Common Help Topics

Guides:

  • Guides

Misc:

  • Events
  • Version History
  • Credits and Acknowledgements

DEVELOPER API:

  • ooodev

DEVELOPING ODEV:

  • Dev Docs
OOO Development Tools
  • Help Documentation
  • Spreadsheets (Calc)
  • Calc Formatting and Style
  • Modify
  • Calc Format Modify Page
  • Calc Format Modify Page Footer
  • Calc Modify Page Footer Borders
  • Edit on GitHub

Calc Modify Page Footer Borders

Table of Contents

  • Overview

  • Setup

  • Footer Border Sides

    • Setting Border Sides

    • Getting border sides from a style

  • Footer Border Padding

    • Setting Border Padding

    • Getting border padding from a style

  • Footer Border Shadow

    • Setting Border Shadow

    • Getting border shadow from a style

  • Related Topics

Overview

The ooodev.format.calc.modify.page.footer.borders.Sides, ooodev.format.calc.modify.page.footer.borders.Padding, and ooodev.format.calc.modify.page.footer.borders.Shadow classes are used to modify the border values seen in Fig. 455 of a character border style.

Default Page Footer Borders Style Dialog

Calc dialog Page Style Borders default

Fig. 455 Calc dialog Page Style Borders default

Setup

General function used to run these examples.

import uno
from ooodev.format import Styler
from ooodev.format.calc.modify.page.footer import Footer, CalcStylePageKind
from ooodev.format.calc.modify.page.footer.borders import BorderLineKind, LineSize
from ooodev.format.calc.modify.page.footer.borders import Padding, Shadow, Sides
from ooodev.format.calc.modify.page.footer.borders import Sides, Side
from ooodev.office.calc import Calc
from ooodev.utils.color import StandardColor
from ooodev.gui import GUI
from ooodev.loader.lo import Lo


def main() -> int:
    with Lo.Loader(connector=Lo.ConnectSocket()):
        doc = Calc.create_doc()
        GUI.set_visible(True, doc)
        Lo.delay(500)
        Calc.zoom_value(doc, 100)

        footer_style = Footer(
            on=True,
            shared_first=True,
            shared=True,
            height=10.0,
            spacing=3.0,
            margin_left=1.5,
            margin_right=2.0,
            style_name=CalcStylePageKind.DEFAULT,
        )
        side = Side(line=BorderLineKind.DOUBLE, color=StandardColor.RED, width=LineSize.MEDIUM)
        footer_sides_style = Sides(all=side, style_name=CalcStylePageKind.DEFAULT)
        Styler.apply(doc, footer_style, footer_sides_style)

        style_obj = Sides.from_style(doc=doc, style_name=CalcStylePageKind.DEFAULT)
        assert style_obj.prop_style_name == str(CalcStylePageKind.DEFAULT)

        Lo.delay(1_000)
        Lo.close_doc(doc)
    return 0


if __name__ == "__main__":
    SystemExit(main())

Footer Border Sides

Setting Border Sides

# ... other code

side = Side(line=BorderLineKind.DOUBLE, color=StandardColor.RED, width=LineSize.MEDIUM)
footer_sides_style = Sides(all=side, style_name=CalcStylePageKind.DEFAULT)
Styler.apply(doc, footer_style, footer_sides_style)

Style results.

Calc dialog Page Style Footer Borders style sides modified

Fig. 456 Calc dialog Page Style Footer Borders style sides modified

Getting border sides from a style

We can get the border sides from the document.

# ... other code

style_obj = Sides.from_style(doc=doc, style_name=CalcStylePageKind.DEFAULT)
assert style_obj.prop_style_name == str(CalcStylePageKind.DEFAULT)

Footer Border Padding

Setting Border Padding

# ... other code

padding_style = Padding(
    left=5,
    right=5,
    top=3,
    bottom=3,
    style_name=CalcStylePageKind.DEFAULT,
)
Styler.apply(doc, footer_style, padding_style)

Style results.

Calc dialog Page Footer Style Borders style padding modified

Fig. 457 Calc dialog Page Footer Style Borders style padding modified

Getting border padding from a style

We can get the border padding from the document.

# ... other code

style_obj = Padding.from_style(doc=doc, style_name=CalcStylePageKind.DEFAULT)
assert style_obj.prop_style_name == str(CalcStylePageKind.DEFAULT)

Footer Border Shadow

Setting Border Shadow

# ... other code

shadow_style = Shadow(
    color=StandardColor.BLUE_DARK2,
    width=1.5,
    style_name=CalcStylePageKind.DEFAULT,
)
Styler.apply(doc, footer_style, shadow_style)

Style results.

Calc dialog Page Footer Style Borders style shadow modified

Fig. 458 Calc dialog Page Footer Style Borders style shadow modified

Getting border shadow from a style

We can get the border shadow from the document.

# ... other code

style_obj = Shadow.from_style(doc=doc, style_name=CalcStylePageKind.DEFAULT)
assert style_obj.prop_style_name == str(CalcStylePageKind.DEFAULT)

Related Topics

See also

  • Formatting and Styling kinds

  • Format Coding Style

  • Calc Modify Cell Borders

  • Calc Modify Page Header Borders

  • GUI

  • Lo

  • ooodev.format.calc.modify.page.footer.borders.Padding

  • ooodev.format.calc.modify.page.footer.borders.Sides

  • ooodev.format.calc.modify.page.footer.borders.Shadow

Previous Next

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

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