<html> <head> <title>Service ImageButton</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="ImageButton-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#IncludedServices" class="navisub">Included Services</a></td> <td class="navisub"><a href="#ExportedInterfaces" class="navisub">Exported Interfaces</a></td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../../module-ix.html" class="namechain">::</a> <a href="../../../../module-ix.html" class="namechain">com</a> :: <a href="../../../module-ix.html" class="namechain">sun</a> :: <a href="../../module-ix.html" class="namechain">star</a> :: <a href="../module-ix.html" class="namechain">form</a> :: <a href="module-ix.html" class="namechain">component</a> :: </p> </td> </tr> <tr> <td class="title">service ImageButton</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>This service specifies the control model for a clickable button which is represented by an image. </dd> <dd><p>The image to be displayed is determined by ::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/UnoControlImageControlModel.html">UnoControlImageControlModel</a>::<a href="../../awt/UnoControlImageControlModel.html#ImageURL">ImageURL</a> property specifies the URL of an image to be displayed.</p> </dd> <dt><b>See also</b></dt> <dd><a href="CommandButton.html">CommandButton</a></dd> </dl> </td> </tr> </table> <hr> <a name="IncludedServices"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Included Services</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/UnoControlImageControlModel.html">UnoControlImageControlModel</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>specifies the standard model of an ::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/UnoControlImageControl.html">UnoControlImageControl</a>. </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../FormControlModel.html">FormControlModel</a></td> <td class="imsum_right"><dl> <dt>(referenced entity's summary:)</dt> <dd>specifies a control model within a form. </dd> </dl> </td> </tr> </table> <a name="ExportedInterfaces"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Exported Interfaces</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XImageProducerSupplier.html">XImageProducerSupplier</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>supplies the caller with an ::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/XImageProducer.html">XImageProducer</a>. </dd> <dd><p>Other components can register as ::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/XImageConsumer.html">XImageConsumer</a> at this producer. Then they will be notified of any change in the image to be displayed.</p> <p>Whenever the ::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/UnoControlImageControlModel.html">UnoControlImageControlModel</a>::<a href="../../awt/UnoControlImageControlModel.html#ImageURL">ImageURL</a> property is changed, the model loads the specified image, and sets it as image source at its ::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/XImageProducer.html">XImageProducer</a>. Then, all ::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/XImageConsumer.html">XImageConsumer</a>s are notified and supplied with the binary data of the image.<br/> Usually, controls acting for an <a href="ImageButton.html">ImageButton</a> model are consumers, and use the data stream to display the image</p> </dd> </dl> </td> </tr> </table> <a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Properties' Summary</td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../FormButtonType.html">FormButtonType</a><br> <a href="#ButtonType">ButtonType</a></td> <td class="imsum_right">describes the action to be executed by the button when pressed. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#TargetFrame">TargetFrame</a></td> <td class="imsum_right">describes the frame, where to open the document specified by the TargetURL. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#TargetURL">TargetURL</a></td> <td class="imsum_right">specifies the URL, which should be opened if the button was clicked. </td> </tr> </table> <a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Properties' Details</td> </tr> <tr> <td class="imdetail"><a name="ButtonType" class="membertitle">ButtonType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../FormButtonType.html">FormButtonType</a> <b>ButtonType</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>describes the action to be executed by the button when pressed. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TargetFrame" class="membertitle">TargetFrame</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>TargetFrame</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>describes the frame, where to open the document specified by the TargetURL. </dd> <dd><p>This property is evaluated if the button is of type URL.</p> <p>As always, there is a number of target names which have a special meaning, and force a special ::com::sun::star::<a href="../../frame/module-ix.html">frame</a>::<a href="../../frame/Frame.html">Frame</a> to be used.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TargetURL" class="membertitle">TargetURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>TargetURL</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>specifies the URL, which should be opened if the button was clicked. </dd> <dd><p>This property is evaluated if the button is of type URL.</p> </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../FormButtonType.html">FormButtonType</a></dd> </dl> </td> </tr> </table> </td> </tr> </table> <br> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>