| Properties' Summary |
short
Align |
specifies the horizontal alignment of the text in the control.
|
boolean
AutoHScroll |
[ OPTIONAL ]
If set to true an horizontal scrollbar will be added automaticly
when needed.
|
boolean
AutoVScroll |
[ OPTIONAL ]
If set to true an vertical scrollbar will be added automaticly
when needed.
|
::com::sun::star::util::Color
BackgroundColor |
specifies the background color (RGB) of the control.
|
short
Border |
specifies the border style of the control.
|
long
BorderColor |
[ OPTIONAL ]
specifies the color of the border, if present
|
short
EchoChar |
[ OPTIONAL ]
specifies the echo character for a password edit field.
|
boolean
Enabled |
determines whether the control is enabled or disabled.
|
FontDescriptor
FontDescriptor |
specifies the font attributes of the text in the control.
|
short
FontEmphasisMark |
specifies the ::com::sun::star::text::FontEmphasis
value of the text in the control.
|
short
FontRelief |
specifies the ::com::sun::star::text::FontRelief
value of the text in the control.
|
boolean
HardLineBreaks |
specifies if hard line breaks will be returned in the
XTextComponent::getText method.
|
string
HelpText |
specifies the help text of the control.
|
string
HelpURL |
specifies the help URL of the control.
|
boolean
HideInactiveSelection |
[ OPTIONAL ]
specifies whether the selection in the control should be hidden when
the control is not active (focused).
|
boolean
HScroll |
specifies if the content of the control can be scrolled in
the horizontal direction.
|
short
LineEndFormat |
[ OPTIONAL ]
specifies which line end type should be used for multi line text
|
short
MaxTextLen |
specifies the maximum character count.
|
boolean
MultiLine |
specifies that the control may have more than one line.
|
boolean
PaintTransparent |
[ OPTIONAL ]
specifies whether the control paints it background or not.
|
boolean
Printable |
specifies that the control will be printed with the document.
|
boolean
ReadOnly |
specifies that the content of the control cannot be modified by the user.
|
boolean
Tabstop |
specifies that the control can be reached with the TAB key.
|
string
Text |
specifies the text displayed in the control.
|
::com::sun::star::util::Color
TextColor |
specifies the text color (RGB) of the control.
|
::com::sun::star::util::Color
TextLineColor |
specifies the text line color (RGB) of the control.
|
boolean
VScroll |
specifies if the content of the control can be scrolled in
the vertical direction.
|
short
WritingMode |
[ OPTIONAL ]
denotes the writing mode used in the control, as specified in the
::com::sun::star::text::WritingMode2 constants group.
|
::com::sun::star::style::VerticalAlignment
VerticalAlign |
[ OPTIONAL ]
specifies the vertical alignment of the text in the control.
|
| Properties' Details |
Align
short Align;
- Description
- specifies the horizontal alignment of the text in the control.
0: left
1: center
2: right
|
|
AutoHScroll
boolean AutoHScroll;
- Usage Restrictions
- optional
- Description
- If set to true an horizontal scrollbar will be added automaticly
when needed.
- Since
- OOo 2.3
|
|
AutoVScroll
boolean AutoVScroll;
- Usage Restrictions
- optional
- Description
- If set to true an vertical scrollbar will be added automaticly
when needed.
- Since
- OOo 2.3
|
|
BackgroundColor
::com::sun::star::util::Color BackgroundColor;
- Description
- specifies the background color (RGB) of the control.
|
|
Border
short Border;
- Description
- specifies the border style of the control.
0: No border
1: 3D border
2: simple border
|
|
BorderColor
long BorderColor;
- Usage Restrictions
- optional
- Description
- specifies the color of the border, if present
Not every border style (see Border) may support coloring.
For instance, usually a border with 3D effect will ignore the BorderColor setting.
- Since
- OOo 2.0
|
|
EchoChar
short EchoChar;
- Usage Restrictions
- optional
- Description
- specifies the echo character for a password edit field.
|
|
Enabled
boolean Enabled;
- Description
- determines whether the control is enabled or disabled.
|
|
FontDescriptor
FontDescriptor FontDescriptor;
- Description
- specifies the font attributes of the text in the control.
|
|
FontEmphasisMark
short FontEmphasisMark;
- Description
- specifies the ::com::sun::star::text::FontEmphasis
value of the text in the control.
|
|
FontRelief
short FontRelief;
- Description
- specifies the ::com::sun::star::text::FontRelief
value of the text in the control.
|
|
HardLineBreaks
boolean HardLineBreaks;
- Description
- specifies if hard line breaks will be returned in the
XTextComponent::getText method.
|
|
HelpText
string HelpText;
- Description
- specifies the help text of the control.
|
|
HelpURL
string HelpURL;
- Description
- specifies the help URL of the control.
|
|
HideInactiveSelection
boolean HideInactiveSelection;
- Usage Restrictions
- optional
- Description
- specifies whether the selection in the control should be hidden when
the control is not active (focused).
- Since
- OOo 2.0
|
|
HScroll
boolean HScroll;
- Description
- specifies if the content of the control can be scrolled in
the horizontal direction.
|
|
LineEndFormat
short LineEndFormat;
- Usage Restrictions
- optional
- Description
- specifies which line end type should be used for multi line text
Controls working with this model care for this setting when the user enters
text. Every line break entered into the control will be treated according to this
setting, so that the Text property always contains only
line ends in the format specified.
Possible values are all constants from the LineEndFormat group.
Note that this setting is usually not relevant when you set new text via the API.
No matter which line end format is used in this new text then, usual control implementations
should recognize all line end formats and display them properly.
- Since
- OOo 2.0
|
|
MaxTextLen
short MaxTextLen;
- Description
- specifies the maximum character count.
There's no limitation, if set to 0.
|
|
MultiLine
boolean MultiLine;
- Description
- specifies that the control may have more than one line.
|
|
PaintTransparent
boolean PaintTransparent;
- Usage Restrictions
- optional
- Description
- specifies whether the control paints it background or not.
- Since
- OOo 2.3
|
|
Printable
boolean Printable;
- Description
- specifies that the control will be printed with the document.
|
|
ReadOnly
boolean ReadOnly;
- Description
- specifies that the content of the control cannot be modified by the user.
|
|
Tabstop
boolean Tabstop;
- Description
- specifies that the control can be reached with the TAB key.
|
|
Text
string Text;
- Description
- specifies the text displayed in the control.
|
|
TextColor
::com::sun::star::util::Color TextColor;
- Description
- specifies the text color (RGB) of the control.
|
|
TextLineColor
::com::sun::star::util::Color TextLineColor;
- Description
- specifies the text line color (RGB) of the control.
|
|
VScroll
boolean VScroll;
- Description
- specifies if the content of the control can be scrolled in
the vertical direction.
|
|
WritingMode
short WritingMode;
- Usage Restrictions
- optional
- Description
- denotes the writing mode used in the control, as specified in the
::com::sun::star::text::WritingMode2 constants group.
Only ::com::sun::star::text::WritingMode2::LR_TB and
::com::sun::star::text::WritingMode2::RL_TB are supported at the moment.
- Since
- OOo 3.1
|
|
VerticalAlign
::com::sun::star::style::VerticalAlignment VerticalAlign;
- Usage Restrictions
- optional
- Description
- specifies the vertical alignment of the text in the control.
- Since
- OOo 3.3
|
|
Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.
