Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


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

service UnoControlImageControlModel
Description
specifies the standard model of an UnoControlImageControl.

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  
boolean
Enabled
determines whether the control is enabled or disabled.  
string
HelpText
specifies the help text of the control.  
string
HelpURL
specifies the help URL of the control.  
string
ImageURL
specifies an URL to an image to use for the control.  
[ transient ] ::com::sun::star::graphic::XGraphic
Graphic
[ OPTIONAL ]
specifies a graphic to be displayed on the control  
boolean
Printable
specifies that the control will be printed with the document.  
boolean
ScaleImage
specifies if the image is automatically scaled to the size of the control.  
short
ScaleMode
[ OPTIONAL ]
defines how to scale the image  
boolean
Tabstop
[ OPTIONAL ]
specifies that the control can be reached with the TAB key.  
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
Enabled
boolean Enabled;
Description
determines whether the control is enabled or disabled.
HelpText
string HelpText;
Description
specifies the help text of the control.
HelpURL
string HelpURL;
Description
specifies the help URL of the control.
ImageURL
string ImageURL;
Description
specifies an URL to an image to use for the control.
See also
Graphic
Graphic
[ transient ] ::com::sun::star::graphic::XGraphic Graphic;
Usage Restrictions
optional
Description
specifies a graphic to be displayed on 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
Printable
boolean Printable;
Description
specifies that the control will be printed with the document.
ScaleImage
boolean ScaleImage;
Description
specifies if the image is automatically scaled to the size of the control.
ScaleMode
short ScaleMode;
Usage Restrictions
optional
Description
defines how to scale the image

If this property is present, it supersedes the ScaleImage property.

The value of this property is one of the ImageScaleMode constants.

Since
OOo 3.1
Tabstop
boolean Tabstop;
Usage Restrictions
optional
Description
specifies that the control can be reached with the TAB key.
Since
OOo 1.1.2

 
Top of Page

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.