Files
Terminal.Gui/docs/api/Terminal.Gui/Terminal.Gui.RadioGroup.html
Charlie Kindel 7f27d78cc7 Release Candiate 2 (#1248)
* tweaked version # for v1.0.0-beta.10

* tweaked version # for v1.0.0-beta.11

* Updated readme and revision history for 1.0

* tweaked rel notes

* Regenerated docs for v1.0.0.0

* updating build docs

* updating docs

* updated readme

* updated readme

* more docs

* more docs

* Refactored for clarity

* tweaks

* updated info on versioning

* merged with main. updated relnotes

* updated api docs

* updated README to point to new docs

* merged from future v1.0.0 branch

* regen apidocs

* add code coverage badge generation to publish

* add code coverage badge generation to publish

* tweaked badge
2021-04-26 09:31:37 -07:00

1074 lines
43 KiB
HTML

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class RadioGroup
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class RadioGroup
">
<meta name="generator" content="docfx 2.56.7.0">
<link rel="shortcut icon" href="../../favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../../">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">
<img id="logo" class="svg" src="../../images/logo48.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Terminal.Gui.RadioGroup">
<h1 id="Terminal_Gui_RadioGroup" data-uid="Terminal.Gui.RadioGroup" class="text-break">Class RadioGroup
</h1>
<div class="markdown level0 summary">
<a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a> shows a group of radio labels, only one of those can be selected at a given time
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
<div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
<div class="level3"><span class="xref">RadioGroup</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">System.IDisposable</span></div>
<div><span class="xref">System.ComponentModel.ISupportInitializeNotification</span></div>
<div><span class="xref">System.ComponentModel.ISupportInitialize</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Added">View.Added</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Removed">View.Removed</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKey">View.HotKey</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">View.HotKeySpecifier</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Shortcut">View.Shortcut</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutTag">View.ShortcutTag</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutAction">View.ShortcutAction</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Data">View.Data</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">View.TabIndexes</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndex">View.TabIndex</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabStop">View.TabStop</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocus">View.CanFocus</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearLayoutNeeded">View.ClearLayoutNeeded()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetChildNeedsDisplay">View.SetChildNeedsDisplay()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawFrame_Terminal_Gui_Rect_System_Int32_System_Boolean_">View.DrawFrame(Rect, Int32, Boolean)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawHotString_NStack_ustring_Terminal_Gui_Attribute_Terminal_Gui_Attribute_">View.DrawHotString(ustring, Attribute, Attribute)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawHotString_NStack_ustring_System_Boolean_Terminal_Gui_ColorScheme_">View.DrawHotString(ustring, Boolean, ColorScheme)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnAdded_Terminal_Gui_View_">View.OnAdded(View)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnRemoved_Terminal_Gui_View_">View.OnRemoved(View)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave_Terminal_Gui_View_">View.OnLeave(View)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus">View.SetFocus()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStarted">View.LayoutStarted</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Initialized">View.Initialized</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">View.Text</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AutoSize">View.AutoSize</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">View.TextAlignment</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VerticalTextAlignment">View.VerticalTextAlignment</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextDirection">View.TextDirection</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsInitialized">View.IsInitialized</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseClick_Terminal_Gui_View_MouseEventArgs_">View.OnMouseClick(View.MouseEventArgs)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Dispose_System_Boolean_">View.Dispose(Boolean)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BeginInit">View.BeginInit()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EndInit">View.EndInit()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Visible">View.Visible</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetWidth_System_Int32_System_Int32__">View.SetWidth(Int32, Int32)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetHeight_System_Int32_System_Int32__">View.SetHeight(Int32, Int32)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentWidth_System_Int32__">View.GetCurrentWidth(Int32)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentHeight_System_Int32__">View.GetCurrentHeight(Int32)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
<h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
<h5 id="Terminal_Gui_RadioGroup_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class RadioGroup : View, IDisposable, ISupportInitializeNotification, ISupportInitialize</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<a id="Terminal_Gui_RadioGroup__ctor_" data-uid="Terminal.Gui.RadioGroup.#ctor*"></a>
<h4 id="Terminal_Gui_RadioGroup__ctor" data-uid="Terminal.Gui.RadioGroup.#ctor">RadioGroup()</h4>
<div class="markdown level1 summary">
Initializes a new instance of the <a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a> class using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a> layout.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public RadioGroup()</code></pre>
</div>
<a id="Terminal_Gui_RadioGroup__ctor_" data-uid="Terminal.Gui.RadioGroup.#ctor*"></a>
<h4 id="Terminal_Gui_RadioGroup__ctor_NStack_ustring___System_Int32_" data-uid="Terminal.Gui.RadioGroup.#ctor(NStack.ustring[],System.Int32)">RadioGroup(ustring[], Int32)</h4>
<div class="markdown level1 summary">
Initializes a new instance of the <a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a> class using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a> layout.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public RadioGroup(ustring[] radioLabels, int selected = 0)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">NStack.ustring</span>[]</td>
<td><span class="parametername">radioLabels</span></td>
<td>The radio labels; an array of strings that can contain hotkeys using an underscore before the letter.</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">selected</span></td>
<td>The index of the item to be selected, the value is clamped to the number of items.</td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_RadioGroup__ctor_" data-uid="Terminal.Gui.RadioGroup.#ctor*"></a>
<h4 id="Terminal_Gui_RadioGroup__ctor_System_Int32_System_Int32_NStack_ustring___System_Int32_" data-uid="Terminal.Gui.RadioGroup.#ctor(System.Int32,System.Int32,NStack.ustring[],System.Int32)">RadioGroup(Int32, Int32, ustring[], Int32)</h4>
<div class="markdown level1 summary">
Initializes a new instance of the <a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a> class using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> layout.
The <a class="xref" href="Terminal.Gui.View.html">View</a> frame is computed from the provided radio labels.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public RadioGroup(int x, int y, ustring[] radioLabels, int selected = 0)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">x</span></td>
<td>The x coordinate.</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">y</span></td>
<td>The y coordinate.</td>
</tr>
<tr>
<td><span class="xref">NStack.ustring</span>[]</td>
<td><span class="parametername">radioLabels</span></td>
<td>The radio labels; an array of strings that can contain hotkeys using an underscore before the letter.</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">selected</span></td>
<td>The item to be selected, the value is clamped to the number of items.</td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_RadioGroup__ctor_" data-uid="Terminal.Gui.RadioGroup.#ctor*"></a>
<h4 id="Terminal_Gui_RadioGroup__ctor_Terminal_Gui_Rect_NStack_ustring___System_Int32_" data-uid="Terminal.Gui.RadioGroup.#ctor(Terminal.Gui.Rect,NStack.ustring[],System.Int32)">RadioGroup(Rect, ustring[], Int32)</h4>
<div class="markdown level1 summary">
Initializes a new instance of the <a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a> class using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> layout.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public RadioGroup(Rect rect, ustring[] radioLabels, int selected = 0)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
<td><span class="parametername">rect</span></td>
<td>Boundaries for the radio group.</td>
</tr>
<tr>
<td><span class="xref">NStack.ustring</span>[]</td>
<td><span class="parametername">radioLabels</span></td>
<td>The radio labels; an array of strings that can contain hotkeys using an underscore before the letter.</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">selected</span></td>
<td>The index of item to be selected, the value is clamped to the number of items.</td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<a id="Terminal_Gui_RadioGroup_DisplayMode_" data-uid="Terminal.Gui.RadioGroup.DisplayMode*"></a>
<h4 id="Terminal_Gui_RadioGroup_DisplayMode" data-uid="Terminal.Gui.RadioGroup.DisplayMode">DisplayMode</h4>
<div class="markdown level1 summary">
Gets or sets the <a class="xref" href="Terminal.Gui.DisplayModeLayout.html">DisplayModeLayout</a> for this <a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a>.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public DisplayModeLayout DisplayMode { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.Gui.DisplayModeLayout.html">DisplayModeLayout</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_RadioGroup_HorizontalSpace_" data-uid="Terminal.Gui.RadioGroup.HorizontalSpace*"></a>
<h4 id="Terminal_Gui_RadioGroup_HorizontalSpace" data-uid="Terminal.Gui.RadioGroup.HorizontalSpace">HorizontalSpace</h4>
<div class="markdown level1 summary">
Gets or sets the horizontal space for this <a class="xref" href="Terminal.Gui.RadioGroup.html">RadioGroup</a> if the <a class="xref" href="Terminal.Gui.RadioGroup.html#Terminal_Gui_RadioGroup_DisplayMode">DisplayMode</a> is <a class="xref" href="Terminal.Gui.DisplayModeLayout.html#Terminal_Gui_DisplayModeLayout_Horizontal">Horizontal</a>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int HorizontalSpace { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_RadioGroup_RadioLabels_" data-uid="Terminal.Gui.RadioGroup.RadioLabels*"></a>
<h4 id="Terminal_Gui_RadioGroup_RadioLabels" data-uid="Terminal.Gui.RadioGroup.RadioLabels">RadioLabels</h4>
<div class="markdown level1 summary">
The radio labels to display
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ustring[] RadioLabels { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">NStack.ustring</span>[]</td>
<td>The radio labels.</td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_RadioGroup_SelectedItem_" data-uid="Terminal.Gui.RadioGroup.SelectedItem*"></a>
<h4 id="Terminal_Gui_RadioGroup_SelectedItem" data-uid="Terminal.Gui.RadioGroup.SelectedItem">SelectedItem</h4>
<div class="markdown level1 summary">
The currently selected item from the list of radio labels
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int SelectedItem { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td>The selected.</td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<a id="Terminal_Gui_RadioGroup_MouseEvent_" data-uid="Terminal.Gui.RadioGroup.MouseEvent*"></a>
<h4 id="Terminal_Gui_RadioGroup_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.RadioGroup.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
<div class="markdown level1 summary">
Method invoked when a mouse event is generated
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent me)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
<td><span class="parametername">me</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
<a id="Terminal_Gui_RadioGroup_OnEnter_" data-uid="Terminal.Gui.RadioGroup.OnEnter*"></a>
<h4 id="Terminal_Gui_RadioGroup_OnEnter_Terminal_Gui_View_" data-uid="Terminal.Gui.RadioGroup.OnEnter(Terminal.Gui.View)">OnEnter(View)</h4>
<div class="markdown level1 summary">
Method invoked when a view gets focus.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool OnEnter(View view)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
<td><span class="parametername">view</span></td>
<td>The view that is losing focus.</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter_Terminal_Gui_View_">View.OnEnter(View)</a></div>
<a id="Terminal_Gui_RadioGroup_OnSelectedItemChanged_" data-uid="Terminal.Gui.RadioGroup.OnSelectedItemChanged*"></a>
<h4 id="Terminal_Gui_RadioGroup_OnSelectedItemChanged_System_Int32_System_Int32_" data-uid="Terminal.Gui.RadioGroup.OnSelectedItemChanged(System.Int32,System.Int32)">OnSelectedItemChanged(Int32, Int32)</h4>
<div class="markdown level1 summary">
Called whenever the current selected item changes. Invokes the <a class="xref" href="Terminal.Gui.RadioGroup.html#Terminal_Gui_RadioGroup_SelectedItemChanged">SelectedItemChanged</a> event.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public virtual void OnSelectedItemChanged(int selectedItem, int previousSelectedItem)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">selectedItem</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">previousSelectedItem</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_RadioGroup_PositionCursor_" data-uid="Terminal.Gui.RadioGroup.PositionCursor*"></a>
<h4 id="Terminal_Gui_RadioGroup_PositionCursor" data-uid="Terminal.Gui.RadioGroup.PositionCursor">PositionCursor()</h4>
<div class="markdown level1 summary">
Positions the cursor in the right position based on the currently focused view in the chain.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
</div>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
<a id="Terminal_Gui_RadioGroup_ProcessColdKey_" data-uid="Terminal.Gui.RadioGroup.ProcessColdKey*"></a>
<h4 id="Terminal_Gui_RadioGroup_ProcessColdKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.RadioGroup.ProcessColdKey(Terminal.Gui.KeyEvent)">ProcessColdKey(KeyEvent)</h4>
<div class="markdown level1 summary">
This method can be overwritten by views that
want to provide accelerator functionality
(Alt-key for example), but without
interefering with normal ProcessKey behavior.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool ProcessColdKey(KeyEvent kb)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
<td><span class="parametername">kb</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a></div>
<h5 id="Terminal_Gui_RadioGroup_ProcessColdKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
<div class="markdown level1 remarks">
<p>
After keys are sent to the subviews on the
current view, all the view are
processed and the key is passed to the views
to allow some of them to process the keystroke
as a cold-key. </p>
<p>
This functionality is used, for example, by
default buttons to act on the enter key.
Processing this as a hot-key would prevent
non-default buttons from consuming the enter
keypress when they have the focus.
</p>
</div>
<a id="Terminal_Gui_RadioGroup_ProcessKey_" data-uid="Terminal.Gui.RadioGroup.ProcessKey*"></a>
<h4 id="Terminal_Gui_RadioGroup_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.RadioGroup.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
<div class="markdown level1 summary">
If the view is focused, gives the view a
chance to process the keystroke.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent kb)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
<td><span class="parametername">kb</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
<h5 id="Terminal_Gui_RadioGroup_ProcessKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
<div class="markdown level1 remarks">
<p>
Views can override this method if they are
interested in processing the given keystroke.
If they consume the keystroke, they must
return true to stop the keystroke from being
processed by other widgets or consumed by the
widget engine. If they return false, the
keystroke will be passed using the ProcessColdKey
method to other views to process.
</p>
<p>
The View implementation does nothing but return false,
so it is not necessary to call base.ProcessKey if you
derive directly from View, but you should if you derive
other View subclasses.
</p>
</div>
<a id="Terminal_Gui_RadioGroup_Redraw_" data-uid="Terminal.Gui.RadioGroup.Redraw*"></a>
<h4 id="Terminal_Gui_RadioGroup_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.RadioGroup.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
<div class="markdown level1 summary">
Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override void Redraw(Rect bounds)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
<td><span class="parametername">bounds</span></td>
<td>The bounds (view-relative region) to redraw.</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
<h5 id="Terminal_Gui_RadioGroup_Redraw_Terminal_Gui_Rect__remarks">Remarks</h5>
<div class="markdown level1 remarks">
<p>
Always use <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">Bounds</a> (view-relative) when calling <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">Redraw(Rect)</a>, NOT <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> (superview-relative).
</p>
<p>
Views should set the color that they want to use on entry, as otherwise this will inherit
the last color that was set globally on the driver.
</p>
<p>
Overrides of <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">Redraw(Rect)</a> must ensure they do not set <code>Driver.Clip</code> to a clip region
larger than the <code>region</code> parameter.
</p>
</div>
<a id="Terminal_Gui_RadioGroup_Refresh_" data-uid="Terminal.Gui.RadioGroup.Refresh*"></a>
<h4 id="Terminal_Gui_RadioGroup_Refresh" data-uid="Terminal.Gui.RadioGroup.Refresh">Refresh()</h4>
<div class="markdown level1 summary">
Allow to invoke the <a class="xref" href="Terminal.Gui.RadioGroup.html#Terminal_Gui_RadioGroup_SelectedItemChanged">SelectedItemChanged</a> after their creation.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Refresh()</code></pre>
</div>
<h3 id="events">Events
</h3>
<h4 id="Terminal_Gui_RadioGroup_SelectedItemChanged" data-uid="Terminal.Gui.RadioGroup.SelectedItemChanged">SelectedItemChanged</h4>
<div class="markdown level1 summary">
Invoked when the selected radio label has changed.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public event Action&lt;RadioGroup.SelectedItemChangedArgs&gt; SelectedItemChanged</code></pre>
</div>
<h5 class="eventType">Event Type</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.RadioGroup.SelectedItemChangedArgs.html">RadioGroup.SelectedItemChangedArgs</a>&gt;</td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">System.IDisposable</span>
</div>
<div>
<span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
</div>
<div>
<span class="xref">System.ComponentModel.ISupportInitialize</span>
</div>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../../styles/docfx.js"></script>
<script type="text/javascript" src="../../styles/main.js"></script>
</body>
</html>