Difference between revisions of "RadioButton"

From Xojo Documentation

(See Also)
Line 16: Line 16:
 
{{Event | name=MouseUp | params=x as [[Integer]], y as [[Integer]] | returntype=[[Boolean]] | description=MouseUp(x as Integer, y as Integer) as Boolean
The mouse button was released inside the control's region at the location passed in to x,y.  }}
 
{{Event | name=MouseUp | params=x as [[Integer]], y as [[Integer]] | returntype=[[Boolean]] | description=MouseUp(x as Integer, y as Integer) as Boolean
The mouse button was released inside the control's region at the location passed in to x,y.  }}
 
</dynamicTable>
 
</dynamicTable>
 
  
 
<dynamicTable id="Properties" super="RectControl" class="propertyTable" title="Properties" columns="3">
 
<dynamicTable id="Properties" super="RectControl" class="propertyTable" title="Properties" columns="3">
Line 24: Line 23:
 
{{Property | name=TextFont | type=String | platform=all | description=( String)&nbsp;&nbsp;Name of the font used to display the button caption.  }}
 
{{Property | name=TextFont | type=String | platform=all | description=( String)&nbsp;&nbsp;Name of the font used to display the button caption.  }}
 
{{Property | name=TextSize | type=Single | platform=all | modifiedinversion=2009r4 | description=( Single)&nbsp;&nbsp;Size of the font used to display the button caption.  }}
 
{{Property | name=TextSize | type=Single | platform=all | modifiedinversion=2009r4 | description=( Single)&nbsp;&nbsp;Size of the font used to display the button caption.  }}
 +
{{Property | name=TextUnit | description=( FontUnits)&nbsp;&nbsp;The units for the text size of the font used to display the button caption.}}
 
{{Property | name=Underline | type=Boolean | platform=all | description=( Boolean)&nbsp;&nbsp;Applies the underline style to the button caption. }}
 
{{Property | name=Underline | type=Boolean | platform=all | description=( Boolean)&nbsp;&nbsp;Applies the underline style to the button caption. }}
 
{{Property | name=Value | type=Boolean | platform=all | description=( Boolean)&nbsp;&nbsp;Gets or sets the value of the radio button: True if the RadioButton is checked and False if it is not checked }}
 
{{Property | name=Value | type=Boolean | platform=all | description=( Boolean)&nbsp;&nbsp;Gets or sets the value of the radio button: True if the RadioButton is checked and False if it is not checked }}
 
</dynamicTable>
 
</dynamicTable>
 
  
 
<dynamicTable id="Methods" super="RectControl" class="methodTable" title="Methods" columns="3">
 
<dynamicTable id="Methods" super="RectControl" class="methodTable" title="Methods" columns="3">

Revision as of 14:35, 18 April 2019


For web apps, see RadioGroup.

Class (inherits from RectControl)

The standard radio button control used by desktop applications. RadioButtons are often placed within GroupBox controls.

Events
Action DropObject MouseExit
Close GotFocus MouseMove
ConstructContextualMenu KeyDown MouseUp
ContextualMenuAction KeyUp MouseWheel
DragEnter LostFocus Open
DragExit MouseDown
DragOver MouseEnter
Properties
Active fa-lock-32.png LockLeft TextSize
AllowAutoDeactivate LockRight TextUnit
AllowTabStop LockTop Tooltip
Bold MouseCursor Top
Caption MouseX fa-lock-32.png Transparent
Enabled MouseY fa-lock-32.png TrueWindow fa-lock-32.png
Handle fa-lock-32.png Name fa-lock-32.png Underline
Height PanelIndex Value
Index fa-lock-32.png Parent Visible
Italic Scope fa-lock-32.png Width
Left TabIndex Window fa-lock-32.png
LockBottom TextFont
Methods
AcceptFileDrop AcceptTextDrop Invalidate
AcceptPictureDrop Close Refresh
AcceptRawDataDrop DrawInto SetFocus

Notes

If you enclose a group of radio button controls within a parent control (or just the parent window), other radio buttons are automatically deselected when the user clicks a radio button in the group.

If you have more than one group of radio buttons in a window, each group should have its own parent control. RadioButtons within a group will be enabled and disabled automatically when the parent control is enabled/disabled. You can use controls such as GroupBoxes, TabPanels, PagePanels, or even Canvases as parent controls.

If the Caption property contains an ampersand character, it will display only if it is preceded by another ampersand character. This is done to make applications on all platforms behave consistently.

Sample Code

Here's how to set up RadioButtons using a GroupBox.

Three RadioButtons are set up as a Control Set and are placed within a GroupBox.

In this code, the controls are all named "RadioButton1". RadioButton1's Action event is passed the parameter, "index As Integer". The parameter Index contains the value of Index for the RadioButton that was clicked. The event handler has this code:

Sub Action(index As Integer)
Label1.Text = "You chose radio button " + Str(index) + "."
End Sub

To select a RadioButton in a Control Set, you use its Index property in code to refer to the RadioButton whose value you want to set. For example, the following line selects the second RadioButton from code.

RadioButton1(1).Value = True

See Also

GroupBox, PagePanel, TabPanel controls