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

service ImageButton
Description
This service specifies the control model for a clickable button which is represented by an image.

The image to be displayed is determined by ::com::sun::star::awt::UnoControlImageControlModel::ImageURL property specifies the URL of an image to be displayed.

See also
CommandButton
Included Services - Summary
::com::sun::star::awt::UnoControlImageControlModel
(referenced entity's summary:)
specifies the standard model of an ::com::sun::star::awt::UnoControlImageControl.
::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 caller with an ::com::sun::star::awt::XImageProducer. (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::UnoControlImageControlModel
(referenced entity's summary:)
specifies the standard model of an ::com::sun::star::awt::UnoControlImageControl.
::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 caller with an ::com::sun::star::awt::XImageProducer.

Other components can register as ::com::sun::star::awt::XImageConsumer at this producer. Then they will be notified of any change in the image to be displayed.

Whenever the ::com::sun::star::awt::UnoControlImageControlModel::ImageURL property is changed, the model loads the specified image, and sets it as image source at its ::com::sun::star::awt::XImageProducer. Then, all ::com::sun::star::awt::XImageConsumers are notified and supplied with the binary data of the image.
Usually, controls acting for an ImageButton model are consumers, and use the data stream to display the image
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 © 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.