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 :: form :: component ::

service CommandButton
Description
specifies the control model for a clickable button which is part of a form component hierarchy.
See also
ImageButton

Included Services - Summary
::com::sun::star::awt::UnoControlButtonModel
(referenced entity's summary:)
specifies the standard model of an ::com::sun::star::awt::UnoControlButton.
::com::sun::star::form::FormControlModel
(referenced entity's summary:)
specifies a control model within a form.
Exported Interfaces - Summary
::com::sun::star::form::XImageProducerSupplier

supplies the image producer when the button is to display an image. (details)

::com::sun::star::form::XReset

allows resetting the button (details)

Properties' Summary
::com::sun::star::form::FormButtonType
ButtonType
describes the action to be executed by the button when pressed.  
string
TargetFrame
describes the frame, where to open the document specified by the TargetURL.  
string
TargetURL
specifies the URL, which should be opened if the button was clicked.  
boolean
DefaultState
[ OPTIONAL ]
specifies the default toggle state for the button, used when it is reset.  
Included Services - Details
::com::sun::star::awt::UnoControlButtonModel
(referenced entity's summary:)
specifies the standard model of an ::com::sun::star::awt::UnoControlButton.
::com::sun::star::form::FormControlModel
(referenced entity's summary:)
specifies a control model within a form.
Exported Interfaces - Details
::com::sun::star::form::XImageProducerSupplier
Description
supplies the image producer when the button is to display an image.

If the ::com::sun::star::awt::UnoControlButtonModel::ImageURL points to the location of an image to be displayed on the button, this interface can be used to retrieve an image producer, which itself will supply the image.

Usually, a control belonging to the model will use this interface to obtain the image to be painted

::com::sun::star::form::XReset
Usage Restrictions
optional
Description
allows resetting the button

This property is meaningful only when ::com::sun::star::awt::UnoControlButtonModel::Toggle is true. In this case, the DefaultState controls to which State the button will be reset, when ::com::sun::star::form::XReset::reset is invoked.

For a given implementation of the interface, if this (optional) interface is present, then also the optional property DefaultState must be present.

Properties' Details
ButtonType
::com::sun::star::form::FormButtonType ButtonType;
Description
describes the action to be executed by the button when pressed.
TargetFrame
string TargetFrame;
Description
describes the frame, where to open the document specified by the TargetURL.

This property is evaluated if the button is of type URL.

As always, there is a number of target names which have a special meaning, and force a special ::com::sun::star::frame::Frame to be used.

TargetURL
string TargetURL;
Description
specifies the URL, which should be opened if the button was clicked.

This property is evaluated if the button is of type URL.

See also
::com::sun::star::form::FormButtonType
DefaultState
boolean DefaultState;
Usage Restrictions
optional
Description
specifies the default toggle state for the button, used when it is reset.

This property is meaningful only when ::com::sun::star::awt::UnoControlButtonModel::Toggle is true. In this case, the DefaultState controls to which State the button will be reset.

For a given implementation of the interface, if this (optional) property is present, then also the optional interface ::com::sun::star::form::XReset must be present.


 
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.