ooodev.adapter.drawing.text_properties_partial module

class ooodev.adapter.drawing.text_properties_partial.TextPropertiesPartial(component)[source]

Bases: object

Partial class for TextProperties.

See also

API TextProperties

Parameters:: component (TextProperties) –

__init__(component)[source]

Constructor

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

property is_numbering: bool | None

Gets/Sets - If this is True, numbering is ON for the text of this Shape.

optional

Return type:: bool | None

property numbering_rules: IndexReplaceComp | None

Gets/Sets the numbering levels.

The different rules accessible with this com.sun.star.container.XIndexReplace interface are sequences of property values as described in the service com.sun.star.style.NumberingRule.

optional

Returns:: IndexReplaceComp object or None if not available.
Return type:: IndexReplaceComp | None

property text_animation_amount: UnitPX

This is the number of pixels the text is moved in each animation step.

When setting this property, you can use either an integer or a UnitT object.

Returns:: The number of pixels the text is moved in each animation step.
Return type:: UnitPX

Hint

UnitPX can be imported from ooodev.units.

property text_animation_count: int

This number defines how many times the text animation is repeated.

If this is set to zero, the repeat is endless.

Return type:: int

property text_animation_delay: int

This is the delay in thousandths of a second between each of the animation steps.

Return type:: int

property text_animation_direction: TextAnimationDirection

Gets/Sets - This enumeration defines the direction in which the text moves.

Returns:: The direction in which the text moves.
Return type:: TextAnimationDirection

Hint

TextAnimationDirection can be imported from ooo.dyn.drawing.text_animation_direction.

property text_animation_kind: TextAnimationKind

Gets/Sets - This enumeration defines the type of animation.

Returns:: The type of animation.
Return type:: TextAnimationKind

Hint

TextAnimationKind can be imported from ooo.dyn.drawing.text_animation_kind.

property text_animation_start_inside: bool

Gets/Sets - If this value is True, the text is visible at the start of the animation.

Return type:: bool

property text_animation_stop_inside: bool

Gets/Sets - If this value is True, the text is visible at the end of the animation.

Return type:: bool

property text_auto_grow_height: bool

Gets/Sets – If this value is True, the height of the Shape is automatically expanded/shrunk when text is added to or removed from the Shape.

Return type:: bool

property text_auto_grow_width: bool

Gets/Sets - If this value is True, the width of the Shape is automatically expanded/shrunk when text is added to or removed from the Shape.

Return type:: bool

property text_columns: TextColumnsComp | None

Column layout properties for the text.

optional

since

LibreOffice 7.2

Returns:: TextColumnsComp object or None if not available.
Return type:: TextColumnsComp | None

property text_contour_frame: bool

Gets/Sets - If this value is True, the left edge of every line of text is aligned with the left edge of this Shape.

Return type:: bool

property text_fit_to_size: TextFitToSizeType

Gets/Sets - With this set to a value other than NONE, the text inside of the Shape is stretched or scaled to fit into the Shape.

Returns:: The type of text fit to size.
Return type:: TextFitToSizeType

Hint

TextFitToSizeType can be imported from ooo.dyn.drawing.text_fit_to_size_type.

property text_horizontal_adjust: TextHorizontalAdjust

Gets/Sets - Adjusts the horizontal position of the text inside of the Shape.

Returns:: Horizontal position of the text inside of the Shape.
Return type:: TextHorizontalAdjust

Hint

TextHorizontalAdjust can be imported from ooo.dyn.drawing.text_horizontal_adjust.

property text_left_distance: UnitMM100

This is the distance from the left edge of the Shape to the left edge of the text.

This is only useful if Text.TextHorizontalAdjust is BLOCK or STRETCH or if Text.TextFitSize is True.

When setting this property, you can use either an integer or a UnitT object.

Returns:: The distance from the left edge of the Shape to the left edge of the text.
Return type:: UnitMM100

Hint

UnitMM100 can be imported from ooodev.units.

property text_lower_distance: UnitMM100

Gets/Sets the distance from the lower edge of the Shape to the lower edge of the text.

This is only useful if Text.TextHorizontalAdjust is BLOCK or STRETCH or if Text.TextFitSize is True.

When setting this property, you can use either an integer or a UnitT object.

Returns:: The distance from the lower edge of the Shape to the lower edge of the text.
Return type:: UnitMM100

Hint

UnitMM100 can be imported from ooodev.units.

property text_maximum_frame_height: UnitMM100

Gets/Sets - With this property you can set the maximum height for a shape with text.

On edit, the auto grow feature will not grow the object higher than the value of this property.

When setting this property, you can use either an integer or a UnitT object.

Returns:: The maximum height for a shape with text.
Return type:: UnitMM100

Hint

UnitMM100 can be imported from ooodev.units.

property text_maximum_frame_width: UnitMM100

Gets/Sets - With this property you can set the maximum width for a shape with text.

On edit, the auto grow feature will not grow the objects wider than the value of this property.

When setting this property, you can use either an integer or a UnitT object.

Returns:: The maximum width for a shape with text.
Return type:: UnitMM100

Hint

UnitMM100 can be imported from ooodev.units.

property text_minimum_frame_height: UnitMM100

Gets/Sets with this property you can set the minimum height for a shape with text.

On edit, the auto grow feature will not shrink the objects height smaller than the value of this property.

When setting this property, you can use either an integer or a UnitT object.

Returns:: The minimum height for a shape with text.
Return type:: UnitMM100

Hint

UnitMM100 can be imported from ooodev.units.

property text_minimum_frame_width: UnitMM100

Gets/Sets - With this property you can set the minimum width for a shape with text.

On edit, the auto grow feature will not shrink the object width smaller than the value of this property.

When setting this property, you can use either an integer or a UnitT object.

Returns:: The minimum width for a shape with text.
Return type:: UnitMM100

Hint

UnitMM100 can be imported from ooodev.units.

property text_right_distance: UnitMM100

Gets/Sets the distance from the right edge of the Shape to the right edge of the text.

This is only useful if Text.TextHorizontalAdjust is BLOCK or STRETCH or if Text.TextFitSize is True.

When setting this property, you can use either an integer or a UnitT object.

Returns:: The distance from the right edge of the Shape to the right edge of the text.
Return type:: UnitMM100

Hint

UnitMM100 can be imported from ooodev.units.

property text_upper_distance: UnitMM100

This is the distance from the upper edge of the Shape to the upper edge of the text.

This is only useful if Text.TextHorizontalAdjust is BLOCK or STRETCH or if Text.TextFitSize is True.

When setting this property, you can use either an integer or a UnitT object.

Returns:: The distance from the upper edge of the Shape to the upper edge of the text.
Return type:: UnitMM100

Hint

UnitMM100 can be imported from ooodev.units.

property text_vertical_adjust: TextVerticalAdjust

Gets/Sets - This enum adjusts the vertical position of the text inside of the Shape.

Returns:: Vertical position of the text inside of the Shape.
Return type:: TextVerticalAdjust

Hint

TextVerticalAdjust can be imported from ooo.dyn.drawing.text_vertical_adjust.

property text_writing_mode: WritingMode

This value selects the writing mode for the text.

Returns:: Writing mode for the text.
Return type:: WritingMode

Hint

WritingMode can be imported from ooo.dyn.text.writing_mode.