Difference between revisions of "Documentation/DevGuide/Basic/Option Button"

Revision as of 07:37, 5 June 2008

An option button control com.sun.star.awt.UnoControlRadioButton is a simple switch with two states, that is selected by the user. Usually option buttons are used in groups to display several options, that the user may select. While option buttons and check boxes seem to be similar, selecting one option button deselects all the other option buttons in the same group.

Template:Documentation/Note

Usually a group box, or horizontal and vertical lines are used, because those controls visually group the option buttons together, but in principal this can be any control. There is no functional relationship between an option button and a group box. Option buttons are grouped through consecutive tab indices only.

The state of an option button is accessed by the State property, where 0 is not checked and 1 is checked.

 Function IsChecked( oOptionButtonModel As Object ) As Boolean
     Dim bChecked As Boolean
     If oOptionButtonModel.State = 1 Then
         bChecked = True
     Else
         bChecked = False
     End If
     IsChecked = bChecked
 End Function