Top   Module   Use   Manual   Index 
 INCLUDED SERVICES | EXPORTED INTERFACES | PROPERTIES' SUMMARY | PROPERTIES' DETAILS 

com :: sun :: star :: drawing ::

service TextProperties

Description
This is a set of properties to describe the style for rendering the text area inside a shape.


Included Services

com::sun::star::style::CharacterProperties
Description
The properties in this service set default formats for text inside the Shape .
com::sun::star::style::ParagraphProperties
Description
The properties in this service set default formats for text inside the Shape .

Properties' Summary

IsNumbering [ OPTIONAL ]
If this is true , numbering is ON for the text of this Shape .
NumberingRules [ OPTIONAL ]
describes the numbering levels.
TextAutoGrowHeight If this value is true , the height of the Shape is automatically expanded/shrunk when text is added to or removed from the Shape .
TextAutoGrowWidth If this value is true , the width of the Shape is automatically expanded/shrunk when text is added to or removed from the Shape .
TextContourFrame If this value is true , the left edge of every line of text is aligned with the left edge of this Shape .
TextFitToSize With this set to true , the text inside of the Shape is stretched to fit into the Shape .
TextHorizontalAdjust adjusts the horizontal position of the text inside of the Shape .
TextVerticalAdjust adjusts the vertical position of the text inside of the Shape .
TextLeftDistance This is the distance from the left edge of the Shape to the left edge of the text.
TextRightDistance This is the distance from the right edge of the Shape to the right edge of the text.
TextUpperDistance This is the distance from the upper edge of the Shape to the upper edge of the text.
TextLowerDistance This is the distance from the lower edge of the Shape to the lower edge of the text.
TextMaximumFrameHeight 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 heigher than the value of this property.
TextMaximumFrameWidth 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.
TextMinimumFrameHeight 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.
TextMinimumFrameWidth 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.
TextAnimationAmount This is the number of pixels the text is moved in each animation step.
TextAnimationCount This number defines how many times the text animation is repeated.
TextAnimationDelay This is the delay in thousandths of a second between each of the animation steps.
TextAnimationDirection This enumeration defines the direction in which the text moves.
TextAnimationKind This value defines the type of animation.
TextAnimationStartInside If this value is true , the text is visible at the start of the animation.
TextAnimationStopInside If this value is true , the text is visible at the end of the animation.
TextWritingMode This value selects the writing mode for the text.

Properties' Details

IsNumbering
 
boolean IsNumbering;
[ OPTIONAL ]
Description
If this is true , numbering is ON for the text of this Shape .
NumberingRules
 
com::sun::star::container::XIndexReplace NumberingRules;
[ OPTIONAL ]
Description
describes the numbering levels.

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

TextAutoGrowHeight
 
boolean TextAutoGrowHeight;
Description
If this value is true , the height of the Shape is automatically expanded/shrunk when text is added to or removed from the Shape .
TextAutoGrowWidth
 
boolean TextAutoGrowWidth;
Description
If this value is true , the width of the Shape is automatically expanded/shrunk when text is added to or removed from the Shape .
TextContourFrame
 
boolean TextContourFrame;
Description
If this value is true , the left edge of every line of text is aligned with the left edge of this Shape .
TextFitToSize
 
com::sun::star::drawing::TextFitToSizeType TextFitToSize;
Description
With this set to true , the text inside of the Shape is stretched to fit into the Shape .
TextHorizontalAdjust
 
com::sun::star::drawing::TextHorizontalAdjust TextHorizontalAdjust;
Description
adjusts the horizontal position of the text inside of the Shape .
TextVerticalAdjust
 
com::sun::star::drawing::TextVerticalAdjust TextVerticalAdjust;
Description
adjusts the vertical position of the text inside of the Shape .
TextLeftDistance
 
long TextLeftDistance;
Description
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 .

TextRightDistance
 
long TextRightDistance;
Description
This is 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 .

TextUpperDistance
 
long TextUpperDistance;
Description
This is the distance from the upper edge of the Shape to the upper edge of the text.

This is only useful if Text::TextVerticalAdjust is BLOCK or if Text::TextFitSize is true .

TextLowerDistance
 
long TextLowerDistance;
Description
This is the distance from the lower edge of the Shape to the lower edge of the text.

This is only useful if Text::TextVerticalAdjust is BLOCK or if Text::TextFitSize is true .

TextMaximumFrameHeight
 
long TextMaximumFrameHeight;
Description
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 heigher than the value of this property.
TextMaximumFrameWidth
 
long TextMaximumFrameWidth;
Description
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.
TextMinimumFrameHeight
 
long TextMinimumFrameHeight;
Description
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.
TextMinimumFrameWidth
 
long TextMinimumFrameWidth;
Description
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.
TextAnimationAmount
 
short TextAnimationAmount;
Description
This is the number of pixels the text is moved in each animation step.
TextAnimationCount
 
short TextAnimationCount;
Description
This number defines how many times the text animation is repeated.

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

TextAnimationDelay
 
short TextAnimationDelay;
Description
This is the delay in thousandths of a second between each of the animation steps.
TextAnimationDirection
 
com::sun::star::drawing::TextAnimationDirection TextAnimationDirection;
Description
This enumeration defines the direction in which the text moves.
TextAnimationKind
 
com::sun::star::drawing::TextAnimationKind TextAnimationKind;
Description
This value defines the type of animation.
TextAnimationStartInside
 
boolean TextAnimationStartInside;
Description
If this value is true , the text is visible at the start of the animation.
TextAnimationStopInside
 
boolean TextAnimationStopInside;
Description
If this value is true , the text is visible at the end of the animation.
TextWritingMode
 
com::sun::star::text::WritingMode TextWritingMode;
Description
This value selects the writing mode for the text.

Top of Page