ooodev.format.inner.partial.write.table.write_table_cell_borders_partial module

class ooodev.format.inner.partial.write.table.write_table_cell_borders_partial.WriteTableCellBordersPartial(component)[source]

Bases: object

Partial class for Write Table Cell Borders.

Parameters:

component (Any) –

__init__(component)[source]
Parameters:

component (Any) –

Return type:

None

style_borders(*, right=None, left=None, top=None, bottom=None, border_side=None)[source]

Style Write Character Borders.

Parameters:
  • left (Side,, optional) – Specifies the line style at the left edge.

  • right (Side, optional) – Specifies the line style at the right edge.

  • top (Side, optional) – Specifies the line style at the top edge.

  • bottom (Side, optional) – Specifies the line style at the bottom edge.

  • border_side (Side, optional) – Specifies the line style at the top, bottom, left, right edges. If this argument has a value then arguments top, bottom, left, right are ignored

Raises:

CancelEventError – If the event before_style_cell_borders is cancelled and not handled.

Returns:

Borders Style instance or None if cancelled.

Return type:

Borders | None

Hint

  • BorderLine can be imported from ooodev.format.writer.direct.char.borders

  • BorderLine2 can be imported from ooodev.format.writer.direct.char.borders

  • BorderLineKind can be imported from ooodev.format.writer.direct.char.borders

  • LineSize can be imported from ooodev.format.writer.direct.char.borders

  • Side can be imported from ooodev.format.inner.direct.structs.side

style_borders_side(*, line=BorderLineKind.SOLID, color=0, width=LineSize.THIN)[source]

Style All Write Character Borders.

Parameters:
  • line (BorderLineStyleEnum, optional) – Line Style of the border. Default BorderLineKind.SOLID.

  • color (Color, optional) – Color of the border. Default StandardColor.BLACK

  • width (LineSize, float, UnitT, optional) – Contains the width in of a single line or the width of outer part of a double line (in pt units) or Class UnitT. If this value is zero, no line is drawn. Default LineSize.THIN

Raises:

CancelEventError – If the event before_style_cell_borders is cancelled and not handled.

Returns:

Borders Style instance or None if cancelled.

Return type:

Borders | None

Hint

  • BorderLine2 can be imported from ooo.dyn.table.border_line2

  • BorderLine can be imported from ooo.dyn.table.border_line

  • BorderLineKind can be imported from ooodev.format.inner.direct.structs.side

  • LineSize can be imported from ooodev.format.inner.direct.structs.side