ooodev.adapter.table.cell_properties_partial_props module

This class is a partial class for com.sun.star.table.CellProperties service.

class ooodev.adapter.table.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.table.CellProperties service.
Return type:: None

property asian_vertical_mode: bool | None

Gets/Sets Asian character orientation in vertical orientation.

If the CellProperties.Orientation property is CellOrientation.STACKED, in Asian mode only Asian characters are printed in horizontal orientation instead of all characters. For other values of CellProperties.Orientation, this value is not used.

optional

Return type:: bool | None

property bottom_border: BorderLineStructComp

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

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

Returns:: Returns Border Line.
Return type:: BorderLineStructComp

Hint

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

property bottom_border2: BorderLine2StructComp | None

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

Preferred over bottom_border.

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

optional

Returns:: Returns BorderLine2 or None if not supported.
Return type:: BorderLine2StructComp | None

Hint

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

property cell_back_color: Color

Gets/Sets the cell background color.

Returns:: Returns Color.
Return type:: Color

property cell_interop_grab_bag: Tuple[PropertyValue, ...] | None

Gets/Sets Grab bag of cell properties, used as a string-any map for interim interop purposes.

This property is intentionally not handled by the ODF filter. Any member that should be handled there should be first moved out from this grab bag to a separate property.

optional

Return type:: Tuple[PropertyValue, …] | None

property cell_protection: CellProtectionStructComp

Gets/Sets a description of the cell protection.

Cell protection is active only if the sheet is protected.

Return type:: CellProtectionStructComp

property cell_style: str

Gets/Sets the name of the style of the cell.

Return type:: str

property diagonal_bltr: BorderLineStructComp | None

Gets/Sets a description of the bottom left to top right diagonal line of each cell.

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

optional

Returns:: Returns Border Line.
Return type:: BorderLineStructComp

Hint

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

property diagonal_bltr2: BorderLine2StructComp | None

Gets/Sets a description of the bottom left to top right diagonal line of each cell.

Preferred over diagonal_bltr.

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

optional

Returns:: Returns BorderLine2 or None if not supported.
Return type:: BorderLine2StructComp | None

Hint

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

property diagonal_tlbr: BorderLineStructComp | None

Gets/Sets a description of the top left to bottom right diagonal line of each cell.

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

optional

Returns:: Returns BorderLine.
Return type:: BorderLineStructComp

Hint

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

property diagonal_tlbr2: BorderLine2StructComp | None

contains a description of the top left to bottom right diagonal line of each cell.

Preferred over diagonal_tlbr.

optional

Returns:: Returns BorderLine2 or None if not supported.
Return type:: BorderLine2StructComp | None

Hint

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

property hori_justify: CellHoriJustify

Gets/Sets the horizontal alignment of the cell contents.

Returns:: Returns Horizontal Justify.
Return type:: CellHoriJustify

Hint

CellHoriJustifyProto can be imported from ooo.dyn.table.cell_hori_justify

property is_cell_background_transparent: bool

Gets/Sets - is True, if the cell background is transparent.

In this case the CellProperties.CellBackColor value is not used.

Return type:: bool

property is_text_wrapped: bool

Gets/Sets - is True, if text in the cells will be wrapped automatically at the right border.

Return type:: bool

property left_border: BorderLineStructComp

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

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

Returns:: Returns Border Line.
Return type:: BorderLineStructComp

Hint

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

property left_border2: BorderLine2StructComp | None

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

Preferred over left_border.

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

optional

Returns:: Returns BorderLine2 or None if not supported.
Return type:: BorderLine2StructComp | None

Hint

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

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 orientation: CellOrientation

Gets/Sets the orientation of the cell contents.

If the CellProperties.RotateAngle property is non-zero, this value is not used.

Returns:: Returns Cell Orientation.
Return type:: CellOrientation

Hint

CellOrientation can be imported from ooo.dyn.table.cell_orientation

property para_indent: UnitMM100

Gets/Sets the indentation of the cell contents (in 1/100 mm).

The value can be set with an integer (in 1/100 mm) or an UnitT object.

Returns:: Returns UnitMM100 object (unit 1/100 mm).
Return type:: UnitMM100

property right_border: BorderLineStructComp

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

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

Returns:: Returns Border Line.
Return type:: BorderLineStructComp

Hint

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

property right_border2: BorderLine2StructComp | None

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

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

Preferred over right_border.

optional

Returns:: Returns BorderLine2 or None if not supported.
Return type:: BorderLine2StructComp | None

Hint

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

property rotate_angle: Angle100

Gets/Sets how much the content of cells is rotated (in 1/100 degrees).

The value can be set with an integer (in 1/100 degrees) or an AngleT object.

Return type:: Angle100

property rotate_reference: CellVertJustify2Enum

Gets/Sets at which edge rotated cells are aligned.

Returns:: Returns CellVertJustify2Enum.
Return type:: CellVertJustify2Enum

Hint

CellVertJustify2Enum can be imported from ooo.dyn.table.cell_vert_justify2

property shadow_format: ShadowFormatStructComp

Gets/Sets a description of the shadow.

When setting the value can be an instance of ShadowFormatStructComp or ShadowFormat.

Returns:: Shadow Format
Return type:: ShadowFormatStructComp

Hint

ShadowFormat can be imported from ooo.dyn.table.shadow_format

property shrink_to_fit: bool | None

Gets/Sets - is True, if the cell content will be shrunk to fit in the cell.

optional

Return type:: bool | None

property table_border: TableBorderStructComp

contains a description of the cell or cell range border.

If used with a cell range, the top, left, right, and bottom lines are at the edges of the entire range, not at the edges of the individual cell.

Setting value can be done with a TableBorder or TableBorderStructComp object.

Returns:: Table Border.
Return type:: TableBorderComp

Hint

TableBorder can be imported from ooo.dyn.table.table_border

property table_border2: TableBorder2StructComp | None

Gets/Seta a description of the cell or cell range border.

Preferred over table_border.

If used with a cell range, the top, left, right, and bottom lines are at the edges of the entire range, not at the edges of the individual cell.

Setting value can be done with a TableBorder2 or TableBorder2StructComp object.

optional

Returns:: Returns TableBorder2 or None if not supported.
Return type:: TableBorder2StructComp | None

Hint

TableBorder2 can be imported from ooo.dyn.table.table_border2

property top_border: BorderLineStructComp

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

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

Returns:: Returns Border Line.
Return type:: BorderLineStructComp

Hint

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

property top_border2: BorderLine2StructComp | None

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

Preferred over top_border.

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

optional

Returns:: Returns BorderLine2 or None if not supported.
Return type:: BorderLine2StructComp | None

Hint

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

property user_defined_attributes: NameContainerComp | None

Gets/Sets - stores additional attributes.

This property is used i.e. by the XML filters to load and restore unknown attributes.

Return type:: NameContainerComp | None

property vert_justify: CellVertJustify2Enum

Gets/Sets the vertical alignment of the cell contents.

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

Returns:: Returns Vertical Justify.
Return type:: CellVertJustify2Enum

Hint

CellVertJustify2Enum can be imported from ooo.dyn.table.cell_vert_justify2