Overview | Module | Use | Devguide | Index

Included Services | Exported Interfaces | Properties' Summary | Properties' Details

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

Included Services
::com::sun::star::awt::UnoControlButtonModel | specifies the standard model of an ::com::sun::star::awt::UnoControlButton .
::com::sun::star::form::FormControlModel | specifies a control model within a form.

Exported Interfaces
::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' Summary
ButtonType | describes the action to be executed by the button when pressed.
TargetFrame | describes the frame, where to open the document specified by the TargetURL.
TargetURL | specifies the URL, which should be opened if the button was clicked.

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

Top of Page

Copyright © 2003 Sun Microsystems, Inc.