ooodev.adapter.table.table_border_struct_comp module

class ooodev.adapter.table.table_border_struct_comp.TableBorderStructComp(component, prop_name, event_provider)[source]

Bases: StructBase[TableBorder]

Table Border 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 (TableBorder) – Table Border.
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: BorderLineStructComp

Gets/Set the line style at the bottom edge.

Setting value can be done with a BorderLine or BorderLineComp object.

Returns:: Returns Border Line.
Return type:: BorderLineComp

Hint

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

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: BorderLineStructComp

Gets/Set the horizontal line style edge.

Setting value can be done with a BorderLine or BorderLineComp object.

Returns:: Returns Border Line.
Return type:: BorderLineComp

Hint

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

property is_bottom_line_valid: bool

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

Return type:: bool

property is_distance_valid: bool

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

Return type:: bool

property is_horizontal_line_valid: bool

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

Return type:: bool

property is_left_line_valid: bool

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

Return type:: bool

property is_right_line_valid: bool

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

Return type:: bool

property is_top_line_valid: bool

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

Return type:: bool

property is_vertical_line_valid: bool

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

Return type:: bool

property left_line: BorderLineStructComp

Gets/Set the line style at the left edge.

Setting value can be done with a BorderLine or BorderLineComp object.

Returns:: Returns Border Line.
Return type:: BorderLineComp

Hint

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

property right_line: BorderLineStructComp

Gets/Set the line style at the right edge.

Setting value can be done with a BorderLine or BorderLineComp object.

Returns:: Returns Border Line.
Return type:: BorderLineComp

Hint

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

property top_line: BorderLineStructComp

Gets/Set the line style at the top edge.

Setting value can be done with a BorderLine or BorderLineComp object.

Returns:: Returns Border Line.
Return type:: BorderLineComp

Hint

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

property vertical_line: BorderLineStructComp

Gets/Set the vertical line style edge.

Setting value can be done with a BorderLine or BorderLineComp object.

Returns:: Returns Border Line.
Return type:: BorderLineComp

Hint

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