Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Services' Summary Interfaces' Summary Properties' Summary Services' Details Interfaces' Details Properties' Details

:: com :: sun :: star :: awt ::

service UnoControlCheckBoxModel
Description
specifies the standard model of an UnoControlCheckBox.
Included Services - Summary
UnoControlModel
(referenced entity's summary:)
specifies the standard model of an UnoControl in the Smalltalk model view controller design.
Properties' Summary
short
Align		 [ OPTIONAL ]
specifies the horizontal alignment of the text in the control.  
long
BackgroundColor		 [ OPTIONAL ]
specifies the background color (RGB) of the control.  
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.  
short
ImagePosition		 [ OPTIONAL ]
specifies the position of the image, if any, relative to the text, if any  
string
ImageURL		 [ OPTIONAL ]
specifies an URL to an image to display besides the label of the control  
[ transient ] ::com::sun::star::graphic::XGraphic
Graphic		 [ OPTIONAL ]
specifies a graphic to be displayed besides the label of the control  
string
Label		 specifies the label of the control.  
boolean
MultiLine		 [ OPTIONAL ]
specifies that the text may be displayed on more than one line.  
boolean
Printable		 specifies that the control will be printed with the document.  
short
State		 specifies the state of the control.  
boolean
Tabstop		 specifies that the control can be reached with the TAB key.  
::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
TriState		 specifies that the control may have the state "don't know".  
::com::sun::star::style::VerticalAlignment
VerticalAlign		 [ OPTIONAL ]
specifies the vertical alignment of the text in the control.  
short
VisualEffect		 [ OPTIONAL ]
specifies a visual effect to apply to the check box control  
short
WritingMode		 [ OPTIONAL ]
denotes the writing mode used in the control, as specified in the ::com::sun::star::text::WritingMode2 constants group.  
Included Services - Details
UnoControlModel
(referenced entity's summary:)
specifies the standard model of an UnoControl in the Smalltalk model view controller design.
Properties' Details
Align
short Align;
Usage Restrictions
optional
Description
specifies the horizontal alignment of the text in the control. 
 0: left
 1: center
 2: right
Since
OOo 2.0
BackgroundColor
long BackgroundColor;
Usage Restrictions
optional
Description
specifies the background color (RGB) of the control.
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.
ImagePosition
short ImagePosition;
Usage Restrictions
optional
Description
specifies the position of the image, if any, relative to the text, if any

Valid values of this property are specified with ImagePosition.
ImageURL
string ImageURL;
Usage Restrictions
optional
Description
specifies an URL to an image to display besides the label of the control
See also
Graphic
Graphic
[ transient ] ::com::sun::star::graphic::XGraphic Graphic;
Usage Restrictions
optional
Description
specifies a graphic to be displayed besides the label of the control

If this property is present, it interacts with the ImageURLin the following way:

  • If ImageURL is set, Graphic will be reset to an object as loaded from the given image URL, or NULL if ImageURL does not point to a valid image file.
  • If Graphic is set, ImageURL will be reset to an empty string.

Since
OOo 2.1
Label
string Label;
Description
specifies the label of the control.
MultiLine
boolean MultiLine;
Usage Restrictions
optional
Description
specifies that the text may be displayed on more than one line.
Since
OOo 2.0
Printable
boolean Printable;
Description
specifies that the control will be printed with the document.
State
short State;
Description
specifies the state of the control. 
 0: not checked
 1: checked
 2: don't know
Tabstop
boolean Tabstop;
Description
specifies that the control can be reached with the TAB key.
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.
TriState
boolean TriState;
Description
specifies that the control may have the state "don't know".
VerticalAlign
::com::sun::star::style::VerticalAlignment VerticalAlign;
Usage Restrictions
optional
Description
specifies the vertical alignment of the text in the control.
Since
OOo 2.0
VisualEffect
short VisualEffect;
Usage Restrictions
optional
Description
specifies a visual effect to apply to the check box control

Possible values for this property are VisualEffect::FLAT and VisualEffect::LOOK3D.

Since
OOo 2.0
See also
VisualEffect
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

 Top of Page

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.

Apache Software Foundation

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

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