Class CellStyler

class ooodev.write.style.direct.table.cell_styler.CellStyler(owner, component)[source]

Bases: WriteDocPropPartial, WriteTablePropPartial, EventsPartial, LoInstPropsPartial, QiPartial, FillColorPartial, WriteTableFillImgPartial, WriteTableCellBordersPartial, FontOnlyPartial, FontEffectsPartial, FontPartial, NumbersNumbersPartial, WriteParaAlignmentPartial, TheDictionaryPartial

Cell Styler class.

Class set various cell properties.

Events are raises when a style is being applied and when a style has been applied. The WriteNamedEvent.TABLE_STYLE_APPLYING event is raised before a style is applied. The WriteNamedEvent.TABLE_STYLE_APPLIED event is raised after a style has been applied. The event data is a dictionary that contains the following:

cancel_apply: If set to True the style will not be applied. This is only used in the TABLE_STYLE_APPLYING event.
this_component: The component that the style is being applied to. This is the normally same component passed to the constructor.
styler_object: The style that is being applied. This is None when TABLE_STYLE_APPLYING is raised. Is the style that was applied when TABLE_STYLE_APPLIED is raised.

Other style specific data is also in the dictionary such as the parameter values used to apply the style.

The event_args.event_source is the instance of the CellStyler class.

Parameters:

owner (WriteTable) –
component (Any) –

__init__(owner, component)[source]

Constructor.

Parameters:

owner (WriteTable) – Write Table instance.
component (Any) – component instance.

Return type:

None

add_event_observers(*args)

Adds observers that gets their trigger method called when this class trigger method is called.

Parameters:: args (EventObserver) – One or more observers to add.
Return type:: None

Note

Observers are removed automatically when they are out of scope.

qi(atype, raise_err=False)

Generic method that get an interface instance from an object.

Parameters:

atype (T) – Interface type to query obj for. Any Uno class that starts with ‘X’ such as XInterface
raise_err (bool, optional) – If True then raises MissingInterfaceError if result is None. Default False

Raises:

MissingInterfaceError – If ‘raise_err’ is ‘True’ and result is None

Returns:

instance of interface if supported; Otherwise, None

Return type:

T | None

Note

When raise_err=True return value will never be None.

remove_event_observer(observer)

Removes an observer

Parameters:: observer (EventObserver) – One or more observers to add.
Returns:: True if observer has been removed; Otherwise, False.
Return type:: bool

style_alignment(*, align=None, align_vert=None, txt_direction=None, align_last=None, expand_single_word=None, snap_to_grid=None)

Style Write Paragraph Alignment.

Parameters:

align (ParagraphAdjust, optional) – Determines horizontal alignment of a paragraph.
align_vert (ParagraphVertAlignEnum, optional) – Determines vertical alignment of a paragraph.
text_direction (WritingMode, optional) – Determines the text direction.
align_last (LastLineKind, optional) – Determines the adjustment of the last line.
expand_single_word (bool, optional) – Determines if single words are stretched. It is only valid if align and align_last are also valid.
snap_to_grid (bool, optional) – Determines snap to text grid (if active).
txt_direction (WritingMode | None) –

Raises:

CancelEventError – If the event before_paragraph_alignment is cancelled and not handled.

Returns:

Alignment Style instance or None if cancelled.

Return type:

Alignment | None

Hint

ParagraphAdjust can be imported from ooo.dyn.style.paragraph_adjust
ParagraphVertAlignEnum can be imported from ooo.dyn.text.paragraph_vert_align
LastLineKind can be imported from ooodev.format.writer.direct.para.alignment
WritingMode can be imported from ooodev.format.inner.direct.write.para.align
WritingMode2Enum can be imported from oo.dyn.text.writing_mode2.

style_alignment_get()

Gets the Alignment Style.

Returns:: Alignment Style instance or None if not available.
Return type:: Alignment | None

style_area_color(color=-1)

Style Area Color.

Parameters:: color (Color, optional) – FillColor Color. Defaults to StandardColor.AUTO_COLOR.
Raises:: CancelEventError – If the event before_style_area_color is cancelled and not handled.
Returns:: FillColor instance or None if cancelled.
Return type:: FillColorT | None

style_area_color_get()

Gets the Area Color Style.

Raises:: CancelEventError – If the event before_style_area_color_get is cancelled and not handled.
Returns:: Area color style or None if cancelled.
Return type:: FillColorT | None

style_area_image(*, bitmap=None, name='', mode=ImgStyleKind.TILED, size=None, position=None, pos_offset=None, tile_offset=None, auto_name=False)

Style Area Color.

Parameters:

bitmap (XBitmap, optional) – Bitmap instance. If name is not already in the Bitmap Table then this property is required.
name (str, optional) – Specifies the name of the image. This is also the name that is used to store bitmap in LibreOffice Bitmap Table.
mode (ImgStyleKind, optional) – Specifies the image style, tiled, stretched etc. Default ImgStyleKind.TILED.
size (SizePercent, SizeMM, optional) – Size in percent (0 - 100) or size in mm units.
position (RectanglePoint) – Tiling position of Image.
pos_offset (Offset, optional) – Tiling position offset.
tile_offset (OffsetColumn, OffsetRow, optional) – The tiling offset.
auto_name (bool, optional) – Specifies if name is ensured to be unique. Defaults to False.

Raises:

CancelEventError – If the event before_style_area_img is cancelled and not handled.

Returns:

Fill Image instance or None if cancelled.

Return type:

FillImgT | None

Hint

RectanglePoint can be imported from ooo.dyn.drawing.rectangle_point
ImgStyleKind can be imported from ooodev.format.inner.direct.write.fill.area.img
SizePercent can be imported from ooodev.format.inner.common.format_types.size_percent
SizeMM can be imported from ooodev.utils.data_type.size_mm
OffsetColumn can be imported from ooodev.format.inner.common.format_types.offset_column
OffsetRow can be imported from ooodev.format.inner.common.format_types.offset_row
Offset can be imported from ooodev.utils.data_type.offset

style_area_image_from_preset(preset)

Style Area Gradient from Preset.

Parameters:: preset (PresetImageKind) – Preset Image Kind.
Returns:: Chart Fill Image instance.
Return type:: FillImgT

Hint

PresetImageKind can be imported from ooodev.format.inner.preset.preset_image

style_borders(*, right=None, left=None, top=None, bottom=None, border_side=None)

Style Write Character Borders.

Parameters:

left (Side,, optional) – Specifies the line style at the left edge.
right (Side, optional) – Specifies the line style at the right edge.
top (Side, optional) – Specifies the line style at the top edge.
bottom (Side, optional) – Specifies the line style at the bottom edge.
border_side (Side, optional) – Specifies the line style at the top, bottom, left, right edges. If this argument has a value then arguments top, bottom, left, right are ignored

Raises:

CancelEventError – If the event before_style_cell_borders is cancelled and not handled.

Returns:

Borders Style instance or None if cancelled.

Return type:

Borders | None

Hint

BorderLine can be imported from ooodev.format.writer.direct.char.borders
BorderLine2 can be imported from ooodev.format.writer.direct.char.borders
BorderLineKind can be imported from ooodev.format.writer.direct.char.borders
LineSize can be imported from ooodev.format.writer.direct.char.borders
Side can be imported from ooodev.format.inner.direct.structs.side

style_borders_side(*, line=BorderLineKind.SOLID, color=0, width=LineSize.THIN)

Style All Write Character Borders.

Parameters:

line (BorderLineStyleEnum, optional) – Line Style of the border. Default BorderLineKind.SOLID.
color (Color, optional) – Color of the border. Default StandardColor.BLACK
width (LineSize, float, UnitT, optional) – Contains the width in of a single line or the width of outer part of a double line (in pt units) or Class UnitT. If this value is zero, no line is drawn. Default LineSize.THIN

Raises:

CancelEventError – If the event before_style_cell_borders is cancelled and not handled.

Returns:

Borders Style instance or None if cancelled.

Return type:

Borders | None

Hint

BorderLine2 can be imported from ooo.dyn.table.border_line2
BorderLine can be imported from ooo.dyn.table.border_line
BorderLineKind can be imported from ooodev.format.inner.direct.structs.side
LineSize can be imported from ooodev.format.inner.direct.structs.side

style_font(name=None, size=None, font_style=None, lang=None)

Style Font.

Parameters:

name (str | None, optional) – Font Name.
size (float | UnitT | None, optional) – Font Size in PT units or UnitT.
font_style (str | None, optional) – Font Style such as Bold Italics
lang (FontLangT | None, optional) – Font Language.

Raises:

CancelEventError – If the event before_style_font_only is cancelled and not handled.

Returns:

Font Only instance or None if cancelled.

Return type:

FontOnlyT | None