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 RadioButton
Description
specifies a component which acts as a radio button as needed in HTMLForms.

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

Like in HTML, radio buttons are grouped together if and only if they have the same name (see ::com::sun::star::form::FormComponent::Name).
Included Services - Summary
::com::sun::star::awt::UnoControlRadioButtonModel
(referenced entity's summary:)
specifies the standard model of an ::com::sun::star::awt::UnoControlRadioButton.
::com::sun::star::form::FormControlModel
(referenced entity's summary:)
specifies a control model within a form.
Exported Interfaces - Summary
::com::sun::star::form::XReset

can be used to reset the control to it's default text. (details)
Properties' Summary
short
DefaultState		 contains a default value for the control.  
string
RefValue		 contains a reference value which is used for submission in a HTML form.  
string
UncheckedRefValue		 [ OPTIONAL ]
specifies a value which is to be associated with the control when it's not selected.  
Included Services - Details
::com::sun::star::awt::UnoControlRadioButtonModel
(referenced entity's summary:)
specifies the standard model of an ::com::sun::star::awt::UnoControlRadioButton.
::com::sun::star::form::FormControlModel
(referenced entity's summary:)
specifies a control model within a form.
Exported Interfaces - Details
::com::sun::star::form::XReset
Description
can be used to reset the control to it's default text.
See also
RadioButton::DefaultState
Properties' Details
DefaultState
short DefaultState;
Description
contains a default value for the control.

This value is used when the control is initially displayed, and for resetting it.

In a group of radio buttons only one button should be checked by default.

See also
::com::sun::star::awt::UnoControlRadioButtonModel::State, ::com::sun::star::form::XReset
RefValue
string RefValue;
Description
contains a reference value which is used for submission in a HTML form.

If the form the control belongs to is to be submitted (see ::com::sun::star::form::XSubmit), and the control is checked, this reference value is used for submission.
UncheckedRefValue
string UncheckedRefValue;
Usage Restrictions
optional
Description
specifies a value which is to be associated with the control when it's not selected.

In various situations, the RefValue is associated with the control if and only if it is selected.
UncheckedRefValue provides a extensions of this concept: If present, the value should be associated with the control when it is not selected.

 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.