ooodev.adapter.text.text_table_properties_partial module

class ooodev.adapter.text.text_table_properties_partial.TextTablePropertiesPartial(component)[source]

Bases: object

Partial Properties class for TextTable Service.

See also

API TextTable

Parameters:: component (TextTable) –

__init__(component)[source]

Constructor

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

property back_color: Color

Gets/Sets the color of the background.

Returns:: Color
Return type:: Color

property back_graphic: XGraphic | None

Gets/Sets the graphic for the background.

optional

Return type:: XGraphic | None

property back_graphic_filter: str

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

Return type:: str

property back_graphic_location: GraphicLocation

Gets/Sets the position of the background graphic.

Returns:: Graphic Location
Return type:: GraphicLocation

Hint

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

property back_graphic_url: str

Gets/Sets the URL for the background graphic.

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.

Return type:: str

property back_transparent: bool

Gets/Sets if the background color is transparent.

Return type:: bool

property bottom_margin: int

Gets/Sets the bottom margin.

Return type:: int

property break_type: BreakType | None

Gets/Sets the type of break that is applied at the beginning of the table.

optional

Returns:: Break Type
Return type:: BreakType

Hint

BreakType can be imported from ooo.dyn.style.break_type

property chart_column_as_label: bool

Gets/Sets if the first column of the table should be treated as axis labels when a chart is to be created.

Return type:: bool

property chart_row_as_label: bool

Gets/Sets if the first row of the table should be treated as axis labels when a chart is to be created.

Return type:: bool

property collapsing_borders: bool | None

Gets/Sets whether borders of neighboring table cells are collapsed into one.

optional

Return type:: bool | None

property header_row_count: int | None

Gets/Sets the number of rows of the table repeated on every new page.

optional

Return type:: int | None

property hori_orient: HoriOrientationEnum

Gets/Sets the horizontal orientation.

When setting the value can be an integer or a HoriOrientationEnum.

Returns:: Horizontal Orientation
Return type:: HoriOrientationEnum

Hint

HoriOrientationEnum can be imported from ooo.dyn.text.hori_orientation

property is_width_relative: bool

Gets/Sets if the value of the relative width is valid.

Return type:: bool

property keep_together: bool

Gets/Sets - Setting this property to True prevents page or column breaks between this table and the following paragraph or text table.

Return type:: bool

property left_margin: int

Gets/Sets the left margin of the table.

Return type:: int

property page_desc_name: str

Gets/Sets - If this property is set, it creates a page break before the table and assigns the value as the name of the new page style sheet to use.

Return type:: str

property page_number_offset: int

Gets/Sets - If a page break property is set at the table, this property contains the new value for the page number.

Return type:: int

property relative_width: int

Gets/Sets the width of the table relative to its environment.

Return type:: int

property repeat_headline: bool

Gets/Sets if the first row of the table is repeated on every new page.

Return type:: bool

property right_margin: int

Gets/Sets the right margin of the table.

Return type:: int

property shadow_format: ShadowFormatStructComp

Gets/Sets the type, color and size 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 split: bool

Get/Sets - Setting this property to False prevents the table from getting spread on two pages.

Return type:: bool

property table_border: TableBorderStructComp

Gets/Sets 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_column_relative_sum: int

Gets/Sets the sum of the column width values used in TableColumnSeparators.

Return type:: int

property table_column_separators: Tuple[com.sun.star.text.TableColumnSeparator, ...]

Gets/Sets the column description of the table.

Return type:: Tuple[TableColumnSeparator, ...]

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

Gets/Sets - Grab bag of table 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 table_template_name: str | None

Gets/Sets the name of table style used by the table.

optional

Return type:: str | None

property top_margin: int

Gets/Sets the top margin.

Return type:: int

property width: int

Gets/Sets the absolute table width.

As this is only a describing property the value of the actual table may vary depending on the environment the table is located in and the settings of LeftMargin, RightMargin and HoriOrient.

Return type:: int