Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: 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.
Developers Guide
Drawings - General Drawing Properties

Included Services - Summary
::com::sun::star::style::CharacterProperties

The properties in this service set default formats for text inside the Shape.

::com::sun::star::style::CharacterPropertiesAsian

The properties in this service set default formats for asian text inside the Shape. (details)

::com::sun::star::style::CharacterPropertiesComplex

The properties in this service set default formats for complex text inside the Shape. (details)

::com::sun::star::style::ParagraphProperties

The properties in this service set default formats for text inside the Shape.

::com::sun::star::style::ParagraphPropertiesAsian

The properties in this service set default formats for asian text inside the Shape. (details)

::com::sun::star::style::ParagraphPropertiesComplex

The properties in this service set default formats for complex text inside the Shape. (details)

Properties' Summary
boolean
IsNumbering
[ OPTIONAL ]
If this is true, numbering is ON for the text of this Shape.  
::com::sun::star::container::XIndexReplace
NumberingRules
[ OPTIONAL ]
describes the numbering levels.  
boolean
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.  
boolean
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.  
boolean
TextContourFrame
If this value is true, the left edge of every line of text is aligned with the left edge of this Shape.  
TextFitToSizeType
TextFitToSize
With this set to true, the text inside of the Shape is stretched to fit into the Shape.  
TextHorizontalAdjust
TextHorizontalAdjust
adjusts the horizontal position of the text inside of the Shape.  
TextVerticalAdjust
TextVerticalAdjust
adjusts the vertical position of the text inside of the Shape.  
long
TextLeftDistance
This is the distance from the left edge of the Shape to the left edge of the text.  
long
TextRightDistance
This is the distance from the right edge of the Shape to the right edge of the text.  
long
TextUpperDistance
This is the distance from the upper edge of the Shape to the upper edge of the text.  
long
TextLowerDistance
This is the distance from the lower edge of the Shape to the lower edge of the text.  
long
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.  
long
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.  
long
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.  
long
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.  
short
TextAnimationAmount
This is the number of pixels the text is moved in each animation step.  
short
TextAnimationCount
This number defines how many times the text animation is repeated.  
short
TextAnimationDelay
This is the delay in thousandths of a second between each of the animation steps.  
TextAnimationDirection
TextAnimationDirection
This enumeration defines the direction in which the text moves.  
TextAnimationKind
TextAnimationKind
This value defines the type of animation.  
boolean
TextAnimationStartInside
If this value is true, the text is visible at the start of the animation.  
boolean
TextAnimationStopInside
If this value is true, the text is visible at the end of the animation.  
::com::sun::star::text::WritingMode
TextWritingMode
This value selects the writing mode for the text.  
Included Services - Details
::com::sun::star::style::CharacterProperties
Description
The properties in this service set default formats for text inside the Shape.
::com::sun::star::style::CharacterPropertiesAsian
Usage Restrictions
optional
Description
The properties in this service set default formats for asian text inside the Shape.
::com::sun::star::style::CharacterPropertiesComplex
Usage Restrictions
optional
Description
The properties in this service set default formats for complex text inside the Shape.
::com::sun::star::style::ParagraphProperties
Description
The properties in this service set default formats for text inside the Shape.
::com::sun::star::style::ParagraphPropertiesAsian
Usage Restrictions
optional
Description
The properties in this service set default formats for asian text inside the Shape.
::com::sun::star::style::ParagraphPropertiesComplex
Usage Restrictions
optional
Description
The properties in this service set default formats for complex text inside the Shape.
Properties' Details
IsNumbering
boolean IsNumbering;
Usage Restrictions
optional
Description
If this is true, numbering is ON for the text of this Shape.
NumberingRules
::com::sun::star::container::XIndexReplace NumberingRules;
Usage Restrictions
optional
Description
describes 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.

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
TextFitToSizeType TextFitToSize;
Description
With this set to true, the text inside of the Shape is stretched to fit into the Shape.
TextHorizontalAdjust
TextHorizontalAdjust TextHorizontalAdjust;
Description
adjusts the horizontal position of the text inside of the Shape.
TextVerticalAdjust
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
TextAnimationDirection TextAnimationDirection;
Description
This enumeration defines the direction in which the text moves.
TextAnimationKind
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

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.