Class # WebRadioGroup --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- ## Description Allows you to add a set of radio buttons to a web page. ## Properties

table-centered_columns_3_and_4

| Name | Type | Read-Only | Shared | |------------------------------------------------|----------------------------------------------------|-----------|--------| | `ContextualMenu` | `WebMenuItem` | | | | `ControlID` | `String` | ✓ | | | `Enabled` | `Boolean` | | | | `Height` | `Integer` | | | | `Horizontal` | `Boolean` | | | | `Indicator` | `Indicators` | | | | `LastAddedIndex` | `Integer` | ✓ | | | `Left` | `Integer` | | | | `LockBottom` | `Boolean` | | | | `LockHorizontal` | `Boolean` | | | | `LockLeft` | `Boolean` | | | | `LockRight` | `Boolean` | | | | `LockTop` | `Boolean` | | | | `LockVertical` | `Boolean` | | | | `Name` | `String` | ✓ | | | `Page` | `WebPage` | ✓ | | | `PanelIndex` | `Integer` | | | | `Parent` | `WebView` | ✓ | | | `SelectedIndex` | `Integer` | | | | `TabIndex` | `Integer` | | | | `Tooltip` | `WebToolTip` | | | | `Top` | `Integer` | | | | `Visible` | `Boolean` | | | | `Width` | `Integer` | | | ## Methods

table-centered_column_4

| Name | Parameters | Returns | Shared | |------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------|--------| | `AcceptPictureDrop` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All` | | | | `AcceptRawDataDrop` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All` | | | | `AcceptTextDrop` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All` | | | | `Add` | item As `WebRadioButton` | | | | `AddAt` | index As `Integer`, item As `WebRadioButton` | | | | `AllowPictureDrag` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All` | | | | `AllowRawDataDrag` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All` | | | | `AllowTextDrag` | dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All` | | | | `Close` | | | | | `Count` | | `Integer` | | | `CSSClasses` | | `WebCSSClasses` | | | `ExecuteJavaScript` | script As `String` | | | | `GotoURL` | url As `String`, inNewWindow As `Boolean` = `False` | | | | `ItemAt` | index As `Integer` | `WebRadioButton` | | | `RemoveAll` | | | | | `RemoveAt` | index As `Integer` | | | | `SelectedItem` | | `WebRadioButton` | | | `SetFocus` | | | | | `Style` | | `WebStyle` | | | | `Assigns` style As `WebStyle` | | | | `UpdateBrowser` | | | | ## Events

table-centered_column_4

| Name | Parameters | Returns | |----------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------| | `Closed` | | | | `ContextualMenuSelected` | hitItem As `WebMenuItem` | | | `DropObject` | obj As `WebDragItem`, action As `WebDragItem.DragActionTypes`, x As `Integer`, y As `Integer` | | | `Hidden` | | | | `Opening` | | | | `Shown` | | | | `SelectionChanged` | button As `WebRadioButton` | | ## Property descriptions

---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

forsearch

WebRadioGroup.ContextualMenu **ContextualMenu** As `WebMenuItem` > If you assign a `WebMenuItem` to the control, it will be displayed when the user right-clicks the control. > > On a `WebPage`, you can disable/remove the default contextual menu by an empty `WebMenuItem` class object to this property. > > This code populates a contextual menu in the Shown event of the control. > > ``` xojo > Var menu As New WebMenuItem > > menu.AddMenuItem("One") > menu.AddMenuItem("Two") > menu.AddMenuItem("Three") > Me.ContextualMenu = menu > ``` > > The menu selection is then handled by the ContextualMenuSelected event when the user right-clicks on the control. For example, it can be of the form: > > ``` xojo > Select Case hitItem.Text > Case "One" > MessageBox("One") > Case "Two" > MessageBox("Two") > Case "Three" > MessageBox("Three") > End Select > ```

forsearch

WebRadioGroup.ControlID **ControlID** As `String` > Identifies the control on a per session basis. > > This property is read-only.

forsearch

WebRadioGroup.Enabled **Enabled** As `Boolean` > When `True` the **WebControl** is drawn enabled and responds to user action. When `False`, the control appears as disabled and does not respond to user actions. > > In the case of `WebTimer`, when set to `False` this disables and stops the WebTimer. When set to `True`, it starts the WebTimer. > > Disable a button when a check box value changes: > > ``` xojo > If AllowSaveCheckBox.Value Then > SaveButton.Enabled = True > Else > AllowSaveButton.Enabled = False > End If > ```

forsearch

WebRadioGroup.Height **Height** As `Integer` > The height (in pixels) of the control.

forsearch

WebRadioGroup.Horizontal **Horizontal** As `Boolean` > When `True` the WebRadioGroup buttons drawn horizontally rather than vertically.

forsearch

WebRadioGroup.Indicator **Indicator** As `Indicators` > The color scheme for the control.

forsearch

WebRadioGroup.LastAddedIndex **LastAddedIndex** As `Integer` > The index of the last `WebRadioButton` added. > > The property is read-only.

forsearch

WebRadioGroup.Left **Left** As `Integer` > The position of the left side of the **WebUIControl** in pixels, relative to the web page.

forsearch

WebRadioGroup.LockBottom **LockBottom** As `Boolean` > Determines whether the bottom edge of the control should stay at a set distance from the bottom edge of the parent control, if there is one, or the owning web page.

forsearch

WebRadioGroup.LockHorizontal **LockHorizontal** As `Boolean` > LockHorizontal overrides LockLeft and LockRight. It allows you to proportionally lock a control's position to the center of its parent control (or web page). > > For example, if you place a control in the center of the page and sets both LockHorizontal and LockVertical, the control will stay in the center of the page.

forsearch

WebRadioGroup.LockLeft **LockLeft** As `Boolean` > Determines whether the left edge of the control should stay at a set distance from the left edge of the parent control, if there is one, or the owning web page.

forsearch

WebRadioGroup.LockRight **LockRight** As `Boolean` > Determines whether the right edge of the control should stay at a set distance from the right edge of the parent control, if there is one, or the owning web page.

forsearch

WebRadioGroup.LockTop **LockTop** As `Boolean` > Determines whether the top edge of the control should stay at a set distance from the top edge of the parent control, if there is one, or the owning web page.

forsearch

WebRadioGroup.LockVertical **LockVertical** As `Boolean` > LockVertical overrides LockTop and LockBottom. It allows you to proportionally lock a control's position to keep it centered within the parent control or web page. > > For example, if you place a control in the center of the page, and sets both LockHorizontal and LockVertical, the control will stay in the center of the page.

forsearch

WebRadioGroup.Name **Name** As `String` > The name of the control. > > This property is read-only.

forsearch

WebRadioGroup.Page **Page** As `WebPage` > Identifies the web page that contains the control. > > This property is read-only.

forsearch

WebRadioGroup.PanelIndex **PanelIndex** As `Integer` > If the control has been placed on a WebTabPanel or `WebPagePanel` control, this is the panel (page/tab) that the control is on. If the control is not on a panel, it returns -1. > > The first panel is numbered zero. If the control has been placed on a panel of a WebTabPanel or `WebPagePanel` control, it returns the panel number. If the control is not on a `WebPagePanel` or WebTabPanel, it returns -1. If you change the PanelIndex to a nonexistent panel, the control will disappear until you give it a PanelIndex value that corresponds to a panel that exists. > > If you are looking to change the currently selected panel (page/tab), use `SelectedPanelIndex`. > > This code displays the panel index of the control that is on the page. > > ``` xojo > MessageBox(Me.SelectedPanelIndex.ToString) > ```

forsearch

WebRadioGroup.Parent **Parent** As `WebView` > Used to get the control's parent control or page. If the parent control is a `WebContainer`, then it returns the `WebContainer`. If it is on a `WebPage`, it returns the `WebPage`. > > This property is read-only.

forsearch

WebRadioGroup.SelectedIndex **SelectedIndex** As `Integer` > Returns the row of the selected radio button. > > Use the `SelectionChanged` event to determine which radio button was clicked. The indexes are zero-based. > > A value of -1 means there is no selection. You can assign this value to remove the selection as well. > > This code selects a radio button, which has the effect of de-selecting all the other radio buttons in the group: > > ``` xojo > RadioGroup1.SelectedIndex = 1 > ``` > > Use `SelectedIndex` in the `SelectionChanged` event handler to determine which radio button was pressed. > > For example, the following code in the `SelectionChanged` event handler will display a message based upon which radio button is pressed: > > ``` xojo > Select Case Me.SelectedIndex > Case 0 ' Row 1 > MessageBox("You clicked the top button.") > Case 1 ' Row 2 > MessageBox("You clicked the bottom button.") > End Select > ```

forsearch

WebRadioGroup.TabIndex **TabIndex** As `Integer` > The **WebRadioGroup's** control's position in the Tab Order. The control with a TabIndex of 0 is the first **WebUIControl** to get the focus when the page opens in the browser. > > This example sets the control's TabIndex. > > ``` xojo > Me.TabIndex = 2 > ```

forsearch

WebRadioGroup.Tooltip **Tooltip** As `WebToolTip` > Text of a message displayed as a tooltip. > > The tip is displayed when the user places the mouse on the control and leaves it there. > > This code in the Shown event of a Button sets the tooltip: > > ``` xojo > Me.Tooltip = "Save changes" > ```

forsearch

WebRadioGroup.Top **Top** As `Integer` > The top of the control in local coordinates relative to the web page.

forsearch

WebRadioGroup.Visible **Visible** As `Boolean` > If `True`, the control is drawn. If `False`, it's not. > > Hide a control based on a checkbox setting: > > ``` xojo > If ShowEmailCheckbox.Value Then > EmailField.Visible = True > Else > EmailField.Visible = False > End If > ```

forsearch

WebRadioGroup.Width **Width** As `Integer` > The width (in pixels) of the web control. > > This code in the Shown event handler increases the size of the control: > > ``` xojo > Me.Width = Me.Width + 50 > ``` ## Method descriptions

forsearch

WebRadioGroup.AcceptPictureDrop **AcceptPictureDrop**(dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All`) > Allows the control to accept a picture drop of a `WebDragItem`.

forsearch

WebRadioGroup.AcceptRawDataDrop **AcceptRawDataDrop**(dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All`) > Allows the control to accept a raw data drop of a `WebDragItem`.

forsearch

WebRadioGroup.AcceptTextDrop **AcceptTextDrop**(dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All`) > Allows the control to accept a picture drop of a `WebDragItem`.

forsearch

WebRadioGroup.Add **Add**(item As `WebRadioButton`) > Creates a new row at the *index* passed, filling the columns with the *items* passed. > > This example inserts a row at index 4 into a WebRadioGroup and populates columns 0 and 1: > > ``` xojo > WebRadioGroup1.AddAt(4, "Trixie", "10") > ```

forsearch

WebRadioGroup.AddAt **AddAt**(index As `Integer`, item As `WebRadioButton`) > Creates a new row at the *index* passed, filling the columns with the *items* passed. > > This example inserts a row at index 4 into a WebRadioGroup and populates columns 0 and 1: > > ``` xojo > WebRadioGroup1.AddAt(4, "Trixie", "10") > ```

forsearch

WebRadioGroup.AllowPictureDrag **AllowPictureDrag**(dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All`) > Allows the control to be dragged as a picture.

forsearch

WebRadioGroup.AllowRawDataDrag **AllowRawDataDrag**(dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All`) > Allows the control to be dragged as raw data.

forsearch

WebRadioGroup.AllowTextDrag **AllowTextDrag**(dragActionType As `WebDragItem.DragActionTypes` = `WebDragItem.DragActionTypes.All`) > Allows the control to be dragged as text.

forsearch

WebRadioGroup.Close **Close** > Removes the control from the page.

forsearch

WebRadioGroup.Count **Count** As `Integer` > Returns the number of rows in the WebRadioGroup.

forsearch

WebRadioGroup.CSSClasses **CSSClasses** > Returns the instance of `WebCSSClasses` for this control allowing you to add CSS classes to and remove CSS classes from the control.

forsearch

WebRadioGroup.ExecuteJavaScript **ExecuteJavaScript**(script As `String`) > Executes the JavaScript passed. The JavaScript passed can call a JavaScript function in a WebPageSource control. > > The Xojo web framework uses EcmaScript 6 which is more strict than previous versions of JavaScript. For more details, see the [EcmaScript 6 documentation](https://www.ecma-international.org/ecma-262/6.0/). > > This code in the Pressed event of a Button displays an alert using JavaScript: > > ``` xojo > Me.ExecuteJavaScript("alert('Hello!');") > ``` > > This code will select the text in a WebTextField (or WebTextArea): > > ``` xojo > WebTextField1.ExecuteJavascript("document.getElementById('" + _ > WebTextField1.ControlID + "_inner').select();") > ```

forsearch

WebRadioGroup.GotoURL **GotoURL**(url As `String`, inNewWindow As `Boolean` = `False`) > Opens the passed *url* in place of the current web page or downloads a file. If *inNewWindow* is `True`, the browser is asked to open the *url* in a new window. > > If the browser has popup windows disabled and *inNewWindow* is `True`, the method silently fails and the page is not shown. > > If *inNewWindow* is `False`, the running web app is replaced with the specified *url*. If you want to display an external web site within your web app, use the `WebHTMLViewer` control. > > Display a web site in a new popup window: > > ``` xojo > Me.GotoURL("http://www.wikipedia.org", True) > ```

forsearch

WebRadioGroup.ItemAt **ItemAt**(index As `Integer`) As `WebRadioButton` > Returns the `WebRadioButton` at the index passed.

forsearch

WebRadioGroup.RemoveAll **RemoveAll** > Removes all rows (buttons) from the group.

forsearch

WebRadioGroup.RemoveAt **RemoveAt**(index As `Integer`) > Removes the row (button) at the index passed. > > This example removes the very first row (button) in the group: > > ``` xojo > RadioGroup1.RemoveAt(0) > ```

forsearch

WebRadioGroup.SelectedItem **SelectedItem** As `WebRadioButton` > Returns the selected `WebRadioButton`. > > This example displays a `MessageBox` with the current date and time if the user has selected the radio button whose caption is "Today": > > ``` xojo > If RadioGroup1.SelectedItem.Caption = "Today" Then > MessageBox("Today is: " + DateTime.Now.ToString) > End If > ```

forsearch

WebRadioGroup.SetFocus **SetFocus** > Sets the focus to the `Control`. > > This code checks for a required value when a button is pressed: > > ``` xojo > If UserNameField.Text.IsEmpty Then > MessageBox("Please enter your UserName.") > UserNameField.SetFocus > Return > End If > ```

forsearch

WebRadioGroup.Style **Style** As `WebStyle` > Returns the `WebStyle` for the control. --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- **Style**(`Assigns` style As `WebStyle`) > Assigns the *style* to the control. > > In this example, in any event of the control, set the text to bold: > > ``` xojo > Var style As New WebStyle > style.Bold = True > Me.Style = style > ```

forsearch

WebRadioGroup.UpdateBrowser **UpdateBrowser** > Forces the current values of the control to be sent to the browser. > > This method is useful when you are computing values in a loop and wish to update the browser immediately rather than wait until the current method ends. > > This code iterates through a `RowSet` of `database rows`, updates a `ProgressBar` and then forces the updated `ProgressBar` to be sent to the browser via UpdateBrowser. > > ``` xojo > ProgressBar1.MaximumValue = SalesData.RowCount > For Each row As DatabaseRow in SalesData > AnalyzeSales(row) > ProgressBar1.Value = ProgressBar1.Value + 1 > ProgressBar1.UpdateBrowser > Next > ``` ## Event descriptions

forsearch

WebRadioGroup.Closed **Closed** > The control has been removed from the browser either because the page has closed or the control's Close method was called.

forsearch

WebRadioGroup.ContextualMenuSelected **ContextualMenuSelected**(hitItem As `WebMenuItem`) > Called when a contextual menu item is selected. This selected item is contained in *hitItem*. > > This code populates a contextual menu in the Opening event of a `WebToolbar`: > > ``` xojo > Var menu As New WebMenuItem > > menu.AddMenuItem("One") > menu.AddMenuItem("Two") > menu.AddMenuItem("Three") > Me.ContextualMenu = menu > ``` > > The menu selection is then handled by the ContextualMenuSelected event when the user right-clicks on the control. For example, it can be of the form: > > ``` xojo > Select Case hitItem.Text > Case "One" > MessageBox("One") > Case "Two" > MessageBox("Two") > Case "Three" > MessageBox("Three") > End Select > ```

forsearch

WebRadioGroup.DropObject **DropObject**(obj As `WebDragItem`, action As `WebDragItem.DragActionTypes`, x As `Integer`, y As `Integer`) > Called when a dragged item is over a control that can accept it. The dragged item is contained in *obj* and the type of drag is identified by *action*.

forsearch

WebRadioGroup.Hidden **Hidden** > The control is about to become no longer visible. This could be because the page is being closed, is being replaced as the foreground page by another page or because the control or a parent control's Visible property has been set to `False`. > >

> >

> > Note > >

> > This event is equivalent to the `DesktopWindow.Deactivated` event in a desktop app. > >

forsearch

WebRadioGroup.Opening **Opening** > The control has been created and the page is opening but has not been sent to the browser yet. > > The Opening event handler can be used to initialize non-visual properties and settings for controls. > > In most cases, you should use the `Shown` event to initialize controls.

forsearch

WebRadioGroup.Shown **Shown** > The control has appeared on the currently displayed page. This could be because its parent page just finished loading, its parent page has come to the foreground or the control is now visible having been previously invisible because it or its parent control's Visible property has been set to `True`. > > Use the Shown event for initializing your controls or doing anything that would interact with other controls or user interface elements on the web page instead of the `Opening` event. > >

> >

> > Note > >

> > This event is the web equivalent to the `DesktopWindow.Activated` event. > >

> > This code in the Shown event of a `WebListBox` adds 2 rows with 3 columns: > > ``` xojo > Me.RemoveAllRows > Me.AddRow("Row 1", "Bob", "Roberts") > Me.AddRow("Row 2", "Barb", "Reynolds") > ``` > > This example sets the text of a label: > > ``` xojo > If Session.LoggedIn Then > Me.Text = "Welcome!" > Else > Me.Text = "Welcome, " + Session.UserName > End If > ```

forsearch

WebRadioGroup.SelectionChanged **SelectionChanged**(button As `WebRadioButton`) > The selected radio button has been changed. > > Use the `SelectedIndex` property to determine which radio button was pressed.. > > This code in the SelectionChanged event of a default WebRadioGroup tells you which radio button was pressed by position/index: > > ``` xojo > Select Case Me.SelectedIndex > Case 0 > MessageBox("You clicked the top button.") > Case 1 > MessageBox("You clicked the bottom button.") > End Select > ``` > > You can also use the `SelectedItem` method to determine the selected radio button based on its caption: > > ``` xojo > Select Case Me.SelectedItem.Caption > Case "First" > MessageBox("First button") > Case "Second" > MessageBox("Second button") > End Select > ``` ## Notes By default, the WebRadioGroup control creates a group with two rows and one column, but this is easily changed via the `Horizontal` and InitialValue properties in the Inspector. To determine which radiobutton was pressed, use the SelectionChanged event. The `SelectedIndex` property and `SelectedItem` method can be used to identify which `WebRadioButton` was selected. You can access the individual buttons using the `ItemAt` method and `SelectedIndex` property. ## Sample code This code selects a radio button, which has the effect of de-selecting all the other radio buttons in the group: ``` xojo RadioGroup1.SelectedIndex = 1 ``` --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- Use `SelectedIndex` in the `SelectionChanged` event handler to determine which radio button was pressed. For example, the following code in the `SelectionChanged` event handler will display a message based upon which radio button is pressed: ``` xojo Select Case Me.SelectedIndex Case 0 ' Row 1 MessageBox("You clicked the top button.") Case 1 ' Row 2 MessageBox("You clicked the bottom button.") End Select ``` ## Compatibility | | | |-----------------------|-----| | **Project Types** | Web | | **Operating Systems** | All |

`WebUIControl` parent class; `WebRadioButton` class; `WebCheckBox`, `WebPopupMenu` controls