Difference between revisions of "Documentation/DevGuide/Basic/Option Button"
m |
m (adding a simpler example) |
||
Line 14: | Line 14: | ||
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. | 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 <code>State</code> property, where 0 is not checked and 1 is checked. | + | The state of an option button is accessed by the <code>State</code> property of its Model, where 0 is not checked and 1 is checked. |
<source lang="oobas"> | <source lang="oobas"> | ||
Function IsChecked( oOptionButtonModel As Object ) As Boolean | Function IsChecked( oOptionButtonModel As Object ) As Boolean | ||
Line 26: | Line 26: | ||
End Function | End Function | ||
</source> | </source> | ||
+ | The state of an option button is also returned by the <code>getState()</code> method of the control, where False is not checked and True is checked. The code is greatly simplified: | ||
+ | <source lang="oobas"> | ||
+ | If oOptionButton.State Then | ||
+ | ' The option is checked | ||
+ | Else | ||
+ | ' The option is not checked | ||
+ | End If | ||
+ | </source> | ||
+ | |||
{{PDL1}} | {{PDL1}} | ||
[[Category:Documentation/Developer's Guide/Basic and Dialogs]] | [[Category:Documentation/Developer's Guide/Basic and Dialogs]] |
Revision as of 09:54, 3 December 2010
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.
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 of its Model, 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
The state of an option button is also returned by the getState()
method of the control, where False is not checked and True is checked. The code is greatly simplified:
If oOptionButton.State Then ' The option is checked Else ' The option is not checked End If
Content on this page is licensed under the Public Documentation License (PDL). |