:: com :: sun :: star :: form :: component ::

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

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)

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.  
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

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.


 
Top of Page