Class RadioGroup

RadioGroup shows a group of radio labels, only one of those can be selected at a given time
Inheritance
System.Object
Responder
View
RadioGroup
Implements
System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
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, IDisposable, ISupportInitializeNotification, ISupportInitialize

Constructors

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

Gets or sets the horizontal space for this RadioGroup if the DisplayMode is Horizontal
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)

Declaration
public override bool MouseEvent(MouseEvent me)
Parameters
Type Name Description
MouseEvent me
Returns
Type Description
System.Boolean
Overrides

OnEnter(View)

Declaration
public override bool OnEnter(View view)
Parameters
Type Name Description
View view
Returns
Type Description
System.Boolean
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()

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 bounds)
Parameters
Type Name Description
Rect bounds
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<RadioGroup.SelectedItemChangedArgs> SelectedItemChanged
Event Type
Type Description
System.Action<RadioGroup.SelectedItemChangedArgs>

Implements

System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize