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 :: awt ::

service UnoControlPatternFieldModel
Description
specifies the standard model of an UnoControlPatternField.

Included Services - Summary
UnoControlModel
(referenced entity's summary:)
specifies the standard model of an UnoControl in the Smalltalk model view controller design.
Properties' Summary
::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  
string
EditMask
specifies the edit mask.  
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.  
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).  
string
LiteralMask
specifies the literal mask.  
short
MaxTextLen
specifies the maximum character count.  
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
StrictFormat
specifies that the text is checked during the user input.  
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.  
short
WritingMode
[ OPTIONAL ]
denotes the writing mode used in the control, as specified in the ::com::sun::star::text::WritingMode2 constants group.  
short
MouseWheelBehavior
[ OPTIONAL ]
defines how the mouse wheel can be used to scroll through the control's content.  
::com::sun::star::style::VerticalAlignment
VerticalAlign
[ OPTIONAL ]
specifies the vertical alignment of the text in the control.  
Included Services - Details
UnoControlModel
(referenced entity's summary:)
specifies the standard model of an UnoControl in the Smalltalk model view controller design.
Properties' Details
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
EditMask
string EditMask;
Description
specifies the edit mask.
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.
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
LiteralMask
string LiteralMask;
Description
specifies the literal mask.
MaxTextLen
short MaxTextLen;
Description
specifies the maximum character count.
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.
StrictFormat
boolean StrictFormat;
Description
specifies that the text is checked during the user input.
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.
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
MouseWheelBehavior
short MouseWheelBehavior;
Usage Restrictions
optional
Description
defines how the mouse wheel can be used to scroll through the control's content.

Usually, the mouse wheel spins the numeric value displayed in the control. Using this property, and one of the MouseWheelBehavior constants, you can control under which circumstances this is possible.

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

 
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.