ooodev.format.calc.modify.cell.alignment package

Module contents

class ooodev.format.calc.modify.cell.alignment.Properties(*, wrap_auto=None, hyphen_active=None, shrink_to_fit=None, direction=None, style_name=StyleCellKind.DEFAULT, style_family='CellStyles')[source]

Bases: CellStyleBaseMulti

Cell Style Properties.

See also

Calc Modify Cell Alignment

New in version 0.9.0.

__init__(*, wrap_auto=None, hyphen_active=None, shrink_to_fit=None, direction=None, style_name=StyleCellKind.DEFAULT, style_family='CellStyles')[source]

Constructor

Parameters:

wrap_auto (bool, optional) – Specifies wrap text automatically.
hyphen_active (bool, optional) – Specifies hyphenation active.
shrink_to_fit (bool, optional) – Specifies if text will shrink to cell.
direction (TextDirectionKind, optional) – Specifies Text Direction.
style_name (StyleCellKind, str, optional) – Specifies the Cell Style that instance applies to. Default is Default Cell Style.
style_family (str, optional) – Style family. Default CellStyles.

Return type:

None

See also

Calc Modify Cell Alignment

classmethod from_style(doc, style_name=StyleCellKind.DEFAULT, style_family='CellStyles')[source]

Gets instance from Document.

Parameters:

doc (object) – UNO Document Object.
style_name (StyleCellKind, str, optional) – Specifies the Cell Style that instance applies to. Default is Default Cell Style.
style_family (str, optional) – Style family. Default CellStyles.

Returns:

Properties instance from style properties.

Return type:

Properties

property prop_inner: Properties

Gets/Sets Inner Properties instance

Return type:: Properties

property prop_style_name: str

Gets/Sets property Style Name

Return type:: str

class ooodev.format.calc.modify.cell.alignment.TextAlign(*, hori_align=None, indent=None, vert_align=None, style_name=StyleCellKind.DEFAULT, style_family='CellStyles')[source]

Bases: CellStyleBaseMulti

Cell Style Text Align.

See also

Calc Modify Cell Alignment

New in version 0.9.0.

__init__(*, hori_align=None, indent=None, vert_align=None, style_name=StyleCellKind.DEFAULT, style_family='CellStyles')[source]

Constructor

Parameters:

hori_align (HoriAlignKind, optional) – Specifies Horizontal Alignment.
indent (float | UnitT | None) – (float, UnitT, optional): Specifies indent in pt (point) units or Class UnitT. Only used when hori_align is set to HoriAlignKind.LEFT
vert_align (VertAdjustKind, optional) – Specifies Vertical Alignment.
style_name (StyleCellKind, str, optional) – Specifies the Cell Style that instance applies to. Default is Default Cell Style.
style_family (str, optional) – Style family. Default CellStyles.

Return type:

None

See also

Calc Modify Cell Alignment

classmethod from_style(doc, style_name=StyleCellKind.DEFAULT, style_family='CellStyles')[source]

Gets instance from Document.

Parameters:

doc (object) – UNO Document Object.
style_name (StyleCellKind, str, optional) – Specifies the Cell Style that instance applies to. Default is Default Cell Style.
style_family (str, optional) – Style family. Default CellStyles.

Returns:

TextAlign instance from style properties.

Return type:

TextAlign

property prop_inner: TextAlign

Gets/Sets Inner Text Align instance

Return type:: TextAlign

property prop_style_name: str

Gets/Sets property Style Name

Return type:: str

class ooodev.format.calc.modify.cell.alignment.TextOrientation(*, vert_stack=None, rotation=None, edge=None, style_name=StyleCellKind.DEFAULT, style_family='CellStyles')[source]

Bases: CellStyleBaseMulti

Cell Style Text Orientation.

See also

Calc Modify Cell Alignment

New in version 0.9.0.

__init__(*, vert_stack=None, rotation=None, edge=None, style_name=StyleCellKind.DEFAULT, style_family='CellStyles')[source]

Constructor

Parameters:

vert_stack (bool, optional) – Specifies if vertical stack is to be used.
rotation (int, Angle, optional) – Specifies if the rotation.
edge (EdgeKind, optional) – Specifies the Reference Edge.
style_name (StyleCellKind, str, optional) – Specifies the Cell Style that instance applies to. Default is Default Cell Style.
style_family (str, optional) – Style family. Default CellStyles.

Return type:

None

See also

Calc Modify Cell Alignment

classmethod from_style(doc, style_name=StyleCellKind.DEFAULT, style_family='CellStyles')[source]

Gets instance from Document.

Parameters:

doc (object) – UNO Document Object.
style_name (StyleCellKind, str, optional) – Specifies the Cell Style that instance applies to. Default is Default Cell Style.
style_family (str, optional) – Style family. Default CellStyles.

Returns:

TextOrientation instance from style properties.

Return type:

TextOrientation

property prop_inner: TextOrientation

Gets/Sets Inner Inner Text Orientation instance

Return type:: TextOrientation

property prop_style_name: str

Gets/Sets property Style Name

Return type:: str