Class RadioGroup
Displays a group of labels each with a selected indicator. Only one of those can be selected at a given time.
Implements
System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
Inherited Members
Namespace: Terminal.Gui
Assembly: Terminal.Gui.dll
Syntax
public class RadioGroup : ViewConstructors
RadioGroup()
Initializes a new instance of the RadioGroup class using Computed layout.
Declaration
public RadioGroup()RadioGroup(ustring[], Int32)
Initializes a new instance of the RadioGroup class using Computed layout.
Declaration
public RadioGroup(ustring[] radioLabels, int selected = 0)Parameters
| Type | Name | Description |
|---|---|---|
| NStack.ustring[] | radioLabels | The radio labels; an array of strings that can contain hotkeys using an underscore before the letter. |
| System.Int32 | selected | The index of the item to be selected, the value is clamped to the number of items. |
RadioGroup(Int32, Int32, ustring[], Int32)
Initializes a new instance of the RadioGroup class using Absolute layout.
The View frame is computed from the provided radio labels.
Declaration
public RadioGroup(int x, int y, ustring[] radioLabels, int selected = 0)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | x | The x coordinate. |
| System.Int32 | y | The y coordinate. |
| NStack.ustring[] | radioLabels | The radio labels; an array of strings that can contain hotkeys using an underscore before the letter. |
| System.Int32 | selected | The item to be selected, the value is clamped to the number of items. |
RadioGroup(Rect, ustring[], Int32)
Initializes a new instance of the RadioGroup class using Absolute layout.
Declaration
public RadioGroup(Rect rect, ustring[] radioLabels, int selected = 0)Parameters
| Type | Name | Description |
|---|---|---|
| Rect | rect | Boundaries for the radio group. |
| NStack.ustring[] | radioLabels | The radio labels; an array of strings that can contain hotkeys using an underscore before the letter. |
| System.Int32 | selected | The index of item to be selected, the value is clamped to the number of items. |
Properties
DisplayMode
Gets or sets the DisplayModeLayout for this RadioGroup.
Declaration
public DisplayModeLayout DisplayMode { get; set; }Property Value
| Type | Description |
|---|---|
| DisplayModeLayout |
HorizontalSpace
Declaration
public int HorizontalSpace { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
RadioLabels
The radio labels to display
Declaration
public ustring[] RadioLabels { get; set; }Property Value
| Type | Description |
|---|---|
| NStack.ustring[] | The radio labels. |
SelectedItem
The currently selected item from the list of radio labels
Declaration
public int SelectedItem { get; set; }Property Value
| Type | Description |
|---|---|
| System.Int32 | The selected. |
Methods
MouseEvent(MouseEvent)
Method invoked when a mouse event is generated
Declaration
public override bool MouseEvent(MouseEvent me)Parameters
| Type | Name | Description |
|---|---|---|
| MouseEvent | me |
Returns
| Type | Description |
|---|---|
| System.Boolean | true, if the event was handled, false otherwise. |
Overrides
OnEnter(View)
Method invoked when a view gets focus.
Declaration
public override bool OnEnter(View view)Parameters
| Type | Name | Description |
|---|---|---|
| View | view | The view that is losing focus. |
Returns
| Type | Description |
|---|---|
| System.Boolean | true, if the event was handled, false otherwise. |
Overrides
OnSelectedItemChanged(Int32, Int32)
Called whenever the current selected item changes. Invokes the SelectedItemChanged event.
Declaration
public virtual void OnSelectedItemChanged(int selectedItem, int previousSelectedItem)Parameters
| Type | Name | Description |
|---|---|---|
| System.Int32 | selectedItem | |
| System.Int32 | previousSelectedItem |
PositionCursor()
Positions the cursor in the right position based on the currently focused view in the chain.
Declaration
public override void PositionCursor()Overrides
ProcessColdKey(KeyEvent)
This method can be overwritten by views that
want to provide accelerator functionality
(Alt-key for example), but without
interefering with normal ProcessKey behavior.
Declaration
public override bool ProcessColdKey(KeyEvent kb)Parameters
| Type | Name | Description |
|---|---|---|
| KeyEvent | kb |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
ProcessKey(KeyEvent)
If the view is focused, gives the view a
chance to process the keystroke.
Declaration
public override bool ProcessKey(KeyEvent kb)Parameters
| Type | Name | Description |
|---|---|---|
| KeyEvent | kb |
Returns
| Type | Description |
|---|---|
| System.Boolean |
Overrides
Redraw(Rect)
Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
Declaration
public override void Redraw(Rect bounds)Parameters
| Type | Name | Description |
|---|---|---|
| Rect | bounds | The bounds (view-relative region) to redraw. |
Overrides
Refresh()
Allow to invoke the SelectedItemChanged after their creation.
Declaration
public void Refresh()Events
SelectedItemChanged
Invoked when the selected radio label has changed.
Declaration
public event Action<SelectedItemChangedArgs> SelectedItemChangedEvent Type
| Type | Description |
|---|---|
| System.Action<SelectedItemChangedArgs> |
Implements
System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize