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

class ooodev.format.inner.partial.write.table.write_table_borders_partial.WriteTableBordersPartial(component)[source]

Bases: object

Partial class for Write Table 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, vertical=None, horizontal=None, distance=None, shadow=None, padding=None, merge_adjacent=None)[source]

Style Write Table 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

  • horizontal (Side, optional) – Specifies the line style of horizontal lines for the inner part of a cell range.

  • vertical (Side, optional) – Specifies the line style of vertical lines for the inner part of a cell range.

  • distance (float, UnitT, optional) – Contains the distance between the lines and other contents in mm units or Class UnitT.

  • shadow (Shadow | None, optional) – Cell Shadow.

  • padding (Padding | None, optional) – Cell padding.

  • merge_adjacent (bool, optional) – Specifies if adjacent line style are to be merged.

Raises:

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

Returns:

Border 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

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

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

  • Padding can be imported from ooodev.format.inner.direct.calc.border.padding

  • Shadow can be imported from ooodev.format.inner.direct.calc.border.shadow

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

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

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

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

  • ShadowLocation can be imported from ooo.dyn.table.shadow_location

style_borders_padding(*, left=None, right=None, top=None, bottom=None, all_sides=None)[source]

Style Padding for Write Table.

Parameters:

  • left (float, UnitT, optional) – Left (in mm units) or Class UnitT.

  • right (float, UnitT, optional) – Right (in mm units) or Class UnitT.

  • top (float, UnitT, optional) – Top (in mm units) or Class UnitT.

  • bottom (float, UnitT, optional) – Bottom (in mm units) or Class UnitT.

  • all_sides (float, UnitT, optional) – Left, right, top, bottom (in mm units) or Class UnitT. If argument is present then left, right, top, and bottom arguments are ignored.

Raises:

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

Returns:

Borders Style instance or None if cancelled.

Return type:

Borders | None

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

Style All Write Table 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

  • shadow (Shadow | None, optional) – Cell Shadow.

  • padding (Padding | None, optional) – Cell padding.

Raises:

CancelEventError – If the event before_style_table_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

  • Padding can be imported from ooodev.format.inner.direct.calc.border.padding

  • Shadow can be imported from ooodev.format.inner.direct.calc.border.shadow

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

  • ShadowLocation can be imported from ooo.dyn.table.shadow_location