<html> <head> <title>Service RadioButton</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="RadioButton-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 RadioButton</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>specifies a component which acts as a radio button as needed in <a href="HTMLForm.html">HTMLForm</a>s. </dd> <dd><p>Radio buttons are controls which can be grouped together, and in every group, only one of the controls can be check. This means if one of them is checked by a user interaction, all other controls in the same group are automatically unchecked</p> <p>Like in HTML, radio buttons are grouped together if and only if they have the same name (see ::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../FormComponent.html">FormComponent</a>::<a href="../FormComponent.html#Name">Name</a>).</p> </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/UnoControlRadioButtonModel.html">UnoControlRadioButtonModel</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/UnoControlRadioButton.html">UnoControlRadioButton</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="../XReset.html">XReset</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>can be used to reset the control to it's default text. </dd> <dt><b/></dt> <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">short<br> <a href="#DefaultState">DefaultState</a></td> <td class="imsum_right">contains a default value for the control. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#RefValue">RefValue</a></td> <td class="imsum_right">contains a reference value which is used for submission in a HTML form. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#UncheckedRefValue">UncheckedRefValue</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specifies a value which is to be associated with the control when it's <em>not</em> selected. </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="DefaultState" class="membertitle">DefaultState</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>DefaultState</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains a default value for the control. </dd> <dd><p>This value is used when the control is initially displayed, and for resetting it.</p> <p> In a group of radio buttons only one button should be checked by default.</p> </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../../awt/module-ix.html">awt</a>::<a href="../../awt/UnoControlRadioButtonModel.html">UnoControlRadioButtonModel</a>::<a href="../../awt/UnoControlRadioButtonModel.html#State">State</a>, ::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XReset.html">XReset</a></dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="RefValue" class="membertitle">RefValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>RefValue</b>;<hr> <dl> <dt><b>Description</b></dt> <dd>contains a reference value which is used for submission in a HTML form. </dd> <dd><p>If the form the control belongs to is to be submitted (see ::com::sun::star::<a href="../module-ix.html">form</a>::<a href="../XSubmit.html">XSubmit</a>), and the control is checked, this reference value is used for submission.</p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UncheckedRefValue" class="membertitle">UncheckedRefValue</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>UncheckedRefValue</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specifies a value which is to be associated with the control when it's <em>not</em> selected. </dd> <dd><p>In various situations, the <a href="#RefValue">RefValue</a> is associated with the control if and only if it is selected.<br/> <a href="#UncheckedRefValue">UncheckedRefValue</a> provides a extensions of this concept: If present, the value should be associated with the control when it is <em>not</em> selected.</p> </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>