ooodev.adapter.table.table_border2_struct_comp module

class ooodev.adapter.table.table_border2_struct_comp.TableBorder2StructComp(component, prop_name, event_provider)[source]

Bases: StructBase[TableBorder2]

Table Border2 Struct

This class raises an event before and after a property is changed if it has been passed an event provider.

The event raised before the property is changed is called com_sun_star_table_TableBorder_changing. The event raised after the property is changed is called com_sun_star_table_TableBorder_changed.

The event args for before the property is changed is of type KeyValCancelArgs. The event args for after the property is changed is of type KeyValArgs.

__init__(component, prop_name, event_provider)[source]

Constructor

Parameters:

  • component (TableBorder2) – Table Border 2.

  • prop_name (str) – Property Name. This value is assigned to the prop_name of event_data.

  • event_provider (EventsT | None) – Event Provider.

Return type:

None

property bottom_line: BorderLine2StructComp

Gets/Set the line style at the bottom edge.

Setting value can be done with a BorderLine2 or BorderLine2Comp object.

Returns:

Returns Border Line.

Return type:

BorderLine2Comp

Hint

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

property distance: UnitMM100

Gets/Sets the distance between the lines and other contents.

When setting value it can be done with a int ( in 1/100th mm units) or UnitT object.

Returns:

Distance value.

Return type:

UnitMM100

property horizontal_line: BorderLine2StructComp

Gets/Set the horizontal line style edge.

Setting value can be done with a BorderLine2 or BorderLine2Comp object.

Returns:

Returns Border Line.

Return type:

BorderLine2Comp

Hint

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

property is_bottom_line_valid: bool

Gets/Sets whether the value of TableBorder2.BottomLine is used.

Return type:

bool

property is_distance_valid: bool

Gets/Sets whether the value of TableBorder2.Distance is used.

Return type:

bool

property is_horizontal_line_valid: bool

Gets/Sets whether the value of TableBorder2.HorizontalLine is used.

Return type:

bool

property is_left_line_valid: bool

Gets/Sets whether the value of TableBorder2.LeftLine is used.

Return type:

bool

property is_right_line_valid: bool

Gets/Sets whether the value of TableBorder2.RightLine is used.

Return type:

bool

property is_top_line_valid: bool

Gets/Sets whether the value of TableBorder2.TopLine is used.

Return type:

bool

property is_vertical_line_valid: bool

Gets/Sets whether the value of TableBorder2.VerticalLine is used.

Return type:

bool

property left_line: BorderLine2StructComp

Gets/Set the line style at the left edge.

Setting value can be done with a BorderLine2 or BorderLine2Comp object.

Returns:

Returns Border Line.

Return type:

BorderLine2Comp

Hint

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

property right_line: BorderLine2StructComp

Gets/Set the line style at the right edge.

Setting value can be done with a BorderLine2 or BorderLine2Comp object.

Returns:

Returns Border Line.

Return type:

BorderLine2Comp

Hint

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

property top_line: BorderLine2StructComp

Gets/Set the line style at the top edge.

Setting value can be done with a BorderLine2 or BorderLine2Comp object.

Returns:

Returns Border Line.

Return type:

BorderLine2Comp

Hint

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

property vertical_line: BorderLine2StructComp

Gets/Set the vertical line style edge.

Setting value can be done with a BorderLine2 or BorderLine2Comp object.

Returns:

Returns Border Line.

Return type:

BorderLine2Comp

Hint

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