Class RadioGroup
RadioGroup shows a group of radio labels, only one of those can be selected at a given time
Implements
System.Collections.IEnumerable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Terminal.Gui
Assembly: Terminal.Gui.dll
Syntax
public class RadioGroup : View, IEnumerable
Constructors
RadioGroup(Int32, Int32, String[], Int32)
Initializes a new instance of the RadioGroup class
setting up the initial set of radio labels and the item that should be selected.
The View frame is computed from the provided radio labels.
Declaration
public RadioGroup(int x, int y, string[] radioLabels, int selected = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | x | The x coordinate. |
System.Int32 | y | The y coordinate. |
System.String[] | 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(String[], Int32)
Initializes a new instance of the RadioGroup class
setting up the initial set of radio labels and the item that should be selected.
Declaration
public RadioGroup(string[] radioLabels, int selected = 0)
Parameters
Type | Name | Description |
---|---|---|
System.String[] | 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(Rect, String[], Int32)
Initializes a new instance of the RadioGroup class
setting up the initial set of radio labels and the item that should be selected and uses
an absolute layout for the result.
Declaration
public RadioGroup(Rect rect, string[] radioLabels, int selected = 0)
Parameters
Type | Name | Description |
---|---|---|
Rect | rect | Boundaries for the radio group. |
System.String[] | 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. |
Fields
SelectionChanged
Declaration
public Action<int> SelectionChanged
Field Value
Type | Description |
---|---|
System.Action<System.Int32> |
Properties
Cursor
The location of the cursor in the RadioGroup
Declaration
public int Cursor { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
RadioLabels
The radio labels to display
Declaration
public string[] RadioLabels { get; set; }
Property Value
Type | Description |
---|---|
System.String[] | The radio labels. |
Selected
The currently selected item from the list of radio labels
Declaration
public int Selected { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 | The selected. |
Methods
MouseEvent(MouseEvent)
Declaration
public override bool MouseEvent(MouseEvent me)
Parameters
Type | Name | Description |
---|---|---|
MouseEvent | me |
Returns
Type | Description |
---|---|
System.Boolean |
Overrides
PositionCursor()
Declaration
public override void PositionCursor()
Overrides
ProcessColdKey(KeyEvent)
Declaration
public override bool ProcessColdKey(KeyEvent kb)
Parameters
Type | Name | Description |
---|---|---|
KeyEvent | kb |
Returns
Type | Description |
---|---|
System.Boolean |
Overrides
ProcessKey(KeyEvent)
Declaration
public override bool ProcessKey(KeyEvent kb)
Parameters
Type | Name | Description |
---|---|---|
KeyEvent | kb |
Returns
Type | Description |
---|---|
System.Boolean |
Overrides
Redraw(Rect)
Declaration
public override void Redraw(Rect region)
Parameters
Type | Name | Description |
---|---|---|
Rect | region |
Overrides
Implements
System.Collections.IEnumerable