ooodev.adapter.text.cell_properties_partial_props module

class ooodev.adapter.text.cell_properties_partial_props.CellPropertiesPartialProps(component)[source]

Bases: object

Partial class for CellProperties service.

Parameters:: component (CellProperties) –

__init__(component)[source]

Constructor

Parameters:: component (CellProperties) – UNO Component that implements com.sun.star.text.CellProperties service.
Return type:: None

property back_color: Color

Gets/Sets the background color.

Returns:: Returns Color.
Return type:: Color

property back_graphic: com.sun.star.graphic.XGraphic

Gets/Sets the graphic object that is displayed as background graphic.

Return type:: XGraphic

property back_graphic_filter: str

Gets/Sets the name of the graphic filter of the background graphic.

Return type:: str

property back_graphic_location: GraphicLocation

Gets/Sets the position of the background graphic.

Returns:: Returns GraphicLocation.
Return type:: GraphicLocation

Hint

GraphicLocation can be imported from ooo.dyn.style.graphic_location

property back_graphic_url: str

Gets/Sets the URL to the background graphic.

Returns:: Returns URL to the background graphic.
Return type:: str

Note

the new behavior since it this was deprecated: This property can only be set and only external URLs are supported (no more vnd.sun.star.GraphicObject scheme). When an URL is set, then it will load the graphic and set the BackGraphic property.

property back_transparent: bool

Gets/Sets whether the background is transparent.

Return type:: bool

property bottom_border: BorderLine2StructComp

Gets/Sets a description of the bottom border line of each cell.

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

Returns:: Returns Border Line.
Return type:: BorderLine2StructComp

Hint

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

property bottom_border_distance: UnitMM100

Gets/Sets the distance of the bottom border.

When setting the value, it can be an integer (in 1/100mm units) or a UnitT object.

Returns:: Returns the distance of the bottom border.
Return type:: UnitMM100

property cell_name: str

Gets the cell name.

Return type:: str

property is_protected: bool

Gets/Sets whether the cell is write protected or not.

Return type:: bool

property left_border: BorderLine2StructComp

Gets/Sets a description of the left border line of each cell.

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

Returns:: Returns Border Line.
Return type:: BorderLine2StructComp

Hint

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

property left_border_distance: UnitMM100

Gets/Sets the distance of the left border.

When setting the value, it can be an integer (in 1/100mm units) or a UnitT object.

Returns:: Returns the distance of the left border.
Return type:: UnitMM100

property number_format: int

Gets/Sets the index of the number format that is used in the cells.

The proper value can be determined by using the com.sun.star.util.NumberFormatter interface of the document.

Return type:: int

property parent_text: TextComp | None

Gets the parent text of this table cell.

This might be a header text, body text, parent cell, etc.

optional

Return type:: TextComp | None

property right_border: BorderLine2StructComp

Gets/Sets a description of the right border line of each cell.

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

Returns:: Returns Border Line.
Return type:: BorderLine2StructComp

Hint

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

property right_border_distance: UnitMM100

Gets/Sets the distance of the right border.

When setting the value, it can be an integer (in 1/100mm units) or a UnitT object.

Returns:: Returns the distance of the right border.
Return type:: UnitMM100

property text_section: TextSectionComp | None

Gets the text section the text table is contained in if there is any.

Return type:: TextSectionComp | None

property top_border: BorderLine2StructComp

Gets/Sets a description of the top border line of each cell.

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

Returns:: Returns Border Line.
Return type:: BorderLine2StructComp

Hint

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

property top_border_distance: UnitMM100

Gets/Sets the distance of the top border.

When setting the value, it can be an integer (in 1/100mm units) or a UnitT object.

Returns:: Returns the distance of the bottom border.
Return type:: UnitMM100

property vert_orient: VertOrientationEnum

Gets/Sets the vertical orientation of the text inside of the table cells in this row.

When setting the value, it can be an integer or an instance of VertOrientationEnum.

Returns:: Returns Vertical Orientation.
Return type:: VertOrientationEnum

Hint

VertOrientationEnum can be imported from ooo.dyn.text.vert_orientation