Terminal.Gui.TextField.html 41 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Class TextField
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class TextField
  11. ">
  12. <meta name="generator" content="docfx 2.54.0.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <meta property="docfx:navrel" content="../../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Terminal.Gui.TextField">
  73. <h1 id="Terminal_Gui_TextField" data-uid="Terminal.Gui.TextField" class="text-break">Class TextField
  74. </h1>
  75. <div class="markdown level0 summary">
  76. Single-line text entry <a class="xref" href="Terminal.Gui.View.html">View</a>
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritance">
  80. <h5>Inheritance</h5>
  81. <div class="level0"><span class="xref">System.Object</span></div>
  82. <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
  83. <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
  84. <div class="level3"><span class="xref">TextField</span></div>
  85. <div class="level4"><a class="xref" href="Terminal.Gui.DateField.html">DateField</a></div>
  86. <div class="level4"><a class="xref" href="Terminal.Gui.TimeField.html">TimeField</a></div>
  87. </div>
  88. <div classs="implements">
  89. <h5>Implements</h5>
  90. <div><span class="xref">System.Collections.IEnumerable</span></div>
  91. </div>
  92. <div class="inheritedMembers">
  93. <h5>Inherited Members</h5>
  94. <div>
  95. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  96. </div>
  97. <div>
  98. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  99. </div>
  100. <div>
  101. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  102. </div>
  103. <div>
  104. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  105. </div>
  106. <div>
  107. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  108. </div>
  109. <div>
  110. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  111. </div>
  112. <div>
  113. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  114. </div>
  115. <div>
  116. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  117. </div>
  118. <div>
  119. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  120. </div>
  121. <div>
  122. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  123. </div>
  124. <div>
  125. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  126. </div>
  127. <div>
  128. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetEnumerator">View.GetEnumerator()</a>
  129. </div>
  130. <div>
  131. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  132. </div>
  133. <div>
  134. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  135. </div>
  136. <div>
  137. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  138. </div>
  139. <div>
  140. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  141. </div>
  142. <div>
  143. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  144. </div>
  145. <div>
  146. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  147. </div>
  148. <div>
  149. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  150. </div>
  151. <div>
  152. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  153. </div>
  154. <div>
  155. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  156. </div>
  157. <div>
  158. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
  159. </div>
  160. <div>
  161. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  162. </div>
  163. <div>
  164. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  165. </div>
  166. <div>
  167. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  168. </div>
  169. <div>
  170. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  171. </div>
  172. <div>
  173. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  174. </div>
  175. <div>
  176. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  177. </div>
  178. <div>
  179. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  180. </div>
  181. <div>
  182. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  183. </div>
  184. <div>
  185. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  186. </div>
  187. <div>
  188. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  189. </div>
  190. <div>
  191. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  192. </div>
  193. <div>
  194. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  195. </div>
  196. <div>
  197. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  198. </div>
  199. <div>
  200. <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>
  201. </div>
  202. <div>
  203. <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>
  204. </div>
  205. <div>
  206. <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>
  207. </div>
  208. <div>
  209. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  210. </div>
  211. <div>
  212. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  213. </div>
  214. <div>
  215. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter">View.OnEnter()</a>
  216. </div>
  217. <div>
  218. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  219. </div>
  220. <div>
  221. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  222. </div>
  223. <div>
  224. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  225. </div>
  226. <div>
  227. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  228. </div>
  229. <div>
  230. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  231. </div>
  232. <div>
  233. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  234. </div>
  235. <div>
  236. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  237. </div>
  238. <div>
  239. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus_Terminal_Gui_View_">View.SetFocus(View)</a>
  240. </div>
  241. <div>
  242. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  243. </div>
  244. <div>
  245. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  246. </div>
  247. <div>
  248. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  249. </div>
  250. <div>
  251. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  252. </div>
  253. <div>
  254. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  255. </div>
  256. <div>
  257. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  258. </div>
  259. <div>
  260. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  261. </div>
  262. <div>
  263. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  264. </div>
  265. <div>
  266. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  267. </div>
  268. <div>
  269. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  270. </div>
  271. <div>
  272. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  273. </div>
  274. <div>
  275. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  276. </div>
  277. <div>
  278. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  279. </div>
  280. <div>
  281. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  282. </div>
  283. <div>
  284. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  285. </div>
  286. <div>
  287. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  288. </div>
  289. <div>
  290. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  291. </div>
  292. <div>
  293. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  294. </div>
  295. <div>
  296. <span class="xref">System.Object.Equals(System.Object)</span>
  297. </div>
  298. <div>
  299. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  300. </div>
  301. <div>
  302. <span class="xref">System.Object.GetHashCode()</span>
  303. </div>
  304. <div>
  305. <span class="xref">System.Object.GetType()</span>
  306. </div>
  307. <div>
  308. <span class="xref">System.Object.MemberwiseClone()</span>
  309. </div>
  310. <div>
  311. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  312. </div>
  313. </div>
  314. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  315. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  316. <h5 id="Terminal_Gui_TextField_syntax">Syntax</h5>
  317. <div class="codewrapper">
  318. <pre><code class="lang-csharp hljs">public class TextField : View, IEnumerable</code></pre>
  319. </div>
  320. <h5 id="Terminal_Gui_TextField_remarks"><strong>Remarks</strong></h5>
  321. <div class="markdown level0 remarks">
  322. The <a class="xref" href="Terminal.Gui.TextField.html">TextField</a> <a class="xref" href="Terminal.Gui.View.html">View</a> provides editing functionality and mouse support.
  323. </div>
  324. <h3 id="constructors">Constructors
  325. </h3>
  326. <a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
  327. <h4 id="Terminal_Gui_TextField__ctor" data-uid="Terminal.Gui.TextField.#ctor">TextField()</h4>
  328. <div class="markdown level1 summary">
  329. Initializes a new instance of the <a class="xref" href="Terminal.Gui.TextField.html">TextField</a> class using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a> positioning.
  330. </div>
  331. <div class="markdown level1 conceptual"></div>
  332. <h5 class="decalaration">Declaration</h5>
  333. <div class="codewrapper">
  334. <pre><code class="lang-csharp hljs">public TextField()</code></pre>
  335. </div>
  336. <a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
  337. <h4 id="Terminal_Gui_TextField__ctor_NStack_ustring_" data-uid="Terminal.Gui.TextField.#ctor(NStack.ustring)">TextField(ustring)</h4>
  338. <div class="markdown level1 summary">
  339. Initializes a new instance of the <a class="xref" href="Terminal.Gui.TextField.html">TextField</a> class using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a> positioning.
  340. </div>
  341. <div class="markdown level1 conceptual"></div>
  342. <h5 class="decalaration">Declaration</h5>
  343. <div class="codewrapper">
  344. <pre><code class="lang-csharp hljs">public TextField(ustring text)</code></pre>
  345. </div>
  346. <h5 class="parameters">Parameters</h5>
  347. <table class="table table-bordered table-striped table-condensed">
  348. <thead>
  349. <tr>
  350. <th>Type</th>
  351. <th>Name</th>
  352. <th>Description</th>
  353. </tr>
  354. </thead>
  355. <tbody>
  356. <tr>
  357. <td><span class="xref">NStack.ustring</span></td>
  358. <td><span class="parametername">text</span></td>
  359. <td>Initial text contents.</td>
  360. </tr>
  361. </tbody>
  362. </table>
  363. <a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
  364. <h4 id="Terminal_Gui_TextField__ctor_System_Int32_System_Int32_System_Int32_NStack_ustring_" data-uid="Terminal.Gui.TextField.#ctor(System.Int32,System.Int32,System.Int32,NStack.ustring)">TextField(Int32, Int32, Int32, ustring)</h4>
  365. <div class="markdown level1 summary">
  366. Initializes a new instance of the <a class="xref" href="Terminal.Gui.TextField.html">TextField</a> class using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> positioning.
  367. </div>
  368. <div class="markdown level1 conceptual"></div>
  369. <h5 class="decalaration">Declaration</h5>
  370. <div class="codewrapper">
  371. <pre><code class="lang-csharp hljs">public TextField(int x, int y, int w, ustring text)</code></pre>
  372. </div>
  373. <h5 class="parameters">Parameters</h5>
  374. <table class="table table-bordered table-striped table-condensed">
  375. <thead>
  376. <tr>
  377. <th>Type</th>
  378. <th>Name</th>
  379. <th>Description</th>
  380. </tr>
  381. </thead>
  382. <tbody>
  383. <tr>
  384. <td><span class="xref">System.Int32</span></td>
  385. <td><span class="parametername">x</span></td>
  386. <td>The x coordinate.</td>
  387. </tr>
  388. <tr>
  389. <td><span class="xref">System.Int32</span></td>
  390. <td><span class="parametername">y</span></td>
  391. <td>The y coordinate.</td>
  392. </tr>
  393. <tr>
  394. <td><span class="xref">System.Int32</span></td>
  395. <td><span class="parametername">w</span></td>
  396. <td>The width.</td>
  397. </tr>
  398. <tr>
  399. <td><span class="xref">NStack.ustring</span></td>
  400. <td><span class="parametername">text</span></td>
  401. <td>Initial text contents.</td>
  402. </tr>
  403. </tbody>
  404. </table>
  405. <a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
  406. <h4 id="Terminal_Gui_TextField__ctor_System_String_" data-uid="Terminal.Gui.TextField.#ctor(System.String)">TextField(String)</h4>
  407. <div class="markdown level1 summary">
  408. Initializes a new instance of the <a class="xref" href="Terminal.Gui.TextField.html">TextField</a> class using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a> positioning.
  409. </div>
  410. <div class="markdown level1 conceptual"></div>
  411. <h5 class="decalaration">Declaration</h5>
  412. <div class="codewrapper">
  413. <pre><code class="lang-csharp hljs">public TextField(string text)</code></pre>
  414. </div>
  415. <h5 class="parameters">Parameters</h5>
  416. <table class="table table-bordered table-striped table-condensed">
  417. <thead>
  418. <tr>
  419. <th>Type</th>
  420. <th>Name</th>
  421. <th>Description</th>
  422. </tr>
  423. </thead>
  424. <tbody>
  425. <tr>
  426. <td><span class="xref">System.String</span></td>
  427. <td><span class="parametername">text</span></td>
  428. <td>Initial text contents.</td>
  429. </tr>
  430. </tbody>
  431. </table>
  432. <h3 id="fields">Fields
  433. </h3>
  434. <h4 id="Terminal_Gui_TextField_TextChanged" data-uid="Terminal.Gui.TextField.TextChanged">TextChanged</h4>
  435. <div class="markdown level1 summary">
  436. Changed event, raised when the text has clicked.
  437. </div>
  438. <div class="markdown level1 conceptual"></div>
  439. <h5 class="decalaration">Declaration</h5>
  440. <div class="codewrapper">
  441. <pre><code class="lang-csharp hljs">public Action&lt;ustring&gt; TextChanged</code></pre>
  442. </div>
  443. <h5 class="fieldValue">Field Value</h5>
  444. <table class="table table-bordered table-striped table-condensed">
  445. <thead>
  446. <tr>
  447. <th>Type</th>
  448. <th>Description</th>
  449. </tr>
  450. </thead>
  451. <tbody>
  452. <tr>
  453. <td><span class="xref">System.Action</span>&lt;<span class="xref">NStack.ustring</span>&gt;</td>
  454. <td></td>
  455. </tr>
  456. </tbody>
  457. </table>
  458. <h5 id="Terminal_Gui_TextField_TextChanged_remarks">Remarks</h5>
  459. <div class="markdown level1 remarks">
  460. This event is raised when the <a class="xref" href="Terminal.Gui.TextField.html#Terminal_Gui_TextField_Text">Text</a> changes.
  461. </div>
  462. <h3 id="properties">Properties
  463. </h3>
  464. <a id="Terminal_Gui_TextField_CanFocus_" data-uid="Terminal.Gui.TextField.CanFocus*"></a>
  465. <h4 id="Terminal_Gui_TextField_CanFocus" data-uid="Terminal.Gui.TextField.CanFocus">CanFocus</h4>
  466. <div class="markdown level1 summary">
  467. Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.Responder.html">Responder</a> can focus.
  468. </div>
  469. <div class="markdown level1 conceptual"></div>
  470. <h5 class="decalaration">Declaration</h5>
  471. <div class="codewrapper">
  472. <pre><code class="lang-csharp hljs">public override bool CanFocus { get; set; }</code></pre>
  473. </div>
  474. <h5 class="propertyValue">Property Value</h5>
  475. <table class="table table-bordered table-striped table-condensed">
  476. <thead>
  477. <tr>
  478. <th>Type</th>
  479. <th>Description</th>
  480. </tr>
  481. </thead>
  482. <tbody>
  483. <tr>
  484. <td><span class="xref">System.Boolean</span></td>
  485. <td><code>true</code> if can focus; otherwise, <code>false</code>.</td>
  486. </tr>
  487. </tbody>
  488. </table>
  489. <h5 class="overrides">Overrides</h5>
  490. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_CanFocus">Responder.CanFocus</a></div>
  491. <a id="Terminal_Gui_TextField_CursorPosition_" data-uid="Terminal.Gui.TextField.CursorPosition*"></a>
  492. <h4 id="Terminal_Gui_TextField_CursorPosition" data-uid="Terminal.Gui.TextField.CursorPosition">CursorPosition</h4>
  493. <div class="markdown level1 summary">
  494. Sets or gets the current cursor position.
  495. </div>
  496. <div class="markdown level1 conceptual"></div>
  497. <h5 class="decalaration">Declaration</h5>
  498. <div class="codewrapper">
  499. <pre><code class="lang-csharp hljs">public int CursorPosition { get; set; }</code></pre>
  500. </div>
  501. <h5 class="propertyValue">Property Value</h5>
  502. <table class="table table-bordered table-striped table-condensed">
  503. <thead>
  504. <tr>
  505. <th>Type</th>
  506. <th>Description</th>
  507. </tr>
  508. </thead>
  509. <tbody>
  510. <tr>
  511. <td><span class="xref">System.Int32</span></td>
  512. <td></td>
  513. </tr>
  514. </tbody>
  515. </table>
  516. <a id="Terminal_Gui_TextField_Frame_" data-uid="Terminal.Gui.TextField.Frame*"></a>
  517. <h4 id="Terminal_Gui_TextField_Frame" data-uid="Terminal.Gui.TextField.Frame">Frame</h4>
  518. <div class="markdown level1 summary">
  519. Gets or sets the frame for the view. The frame is relative to the view&apos;s container (<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">SuperView</a>).
  520. </div>
  521. <div class="markdown level1 conceptual"></div>
  522. <h5 class="decalaration">Declaration</h5>
  523. <div class="codewrapper">
  524. <pre><code class="lang-csharp hljs">public override Rect Frame { get; set; }</code></pre>
  525. </div>
  526. <h5 class="propertyValue">Property Value</h5>
  527. <table class="table table-bordered table-striped table-condensed">
  528. <thead>
  529. <tr>
  530. <th>Type</th>
  531. <th>Description</th>
  532. </tr>
  533. </thead>
  534. <tbody>
  535. <tr>
  536. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  537. <td>The frame.</td>
  538. </tr>
  539. </tbody>
  540. </table>
  541. <h5 class="overrides">Overrides</h5>
  542. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a></div>
  543. <h5 id="Terminal_Gui_TextField_Frame_remarks">Remarks</h5>
  544. <div class="markdown level1 remarks">
  545. <p>
  546. Change the Frame when using the <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> layout style to move or resize views.
  547. </p>
  548. <p>
  549. Altering the Frame of a view will trigger the redrawing of the
  550. view as well as the redrawing of the affected regions of the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">SuperView</a>.
  551. </p>
  552. </div>
  553. <a id="Terminal_Gui_TextField_ReadOnly_" data-uid="Terminal.Gui.TextField.ReadOnly*"></a>
  554. <h4 id="Terminal_Gui_TextField_ReadOnly" data-uid="Terminal.Gui.TextField.ReadOnly">ReadOnly</h4>
  555. <div class="markdown level1 summary">
  556. If set to true its not allow any changes in the text.
  557. </div>
  558. <div class="markdown level1 conceptual"></div>
  559. <h5 class="decalaration">Declaration</h5>
  560. <div class="codewrapper">
  561. <pre><code class="lang-csharp hljs">public bool ReadOnly { get; set; }</code></pre>
  562. </div>
  563. <h5 class="propertyValue">Property Value</h5>
  564. <table class="table table-bordered table-striped table-condensed">
  565. <thead>
  566. <tr>
  567. <th>Type</th>
  568. <th>Description</th>
  569. </tr>
  570. </thead>
  571. <tbody>
  572. <tr>
  573. <td><span class="xref">System.Boolean</span></td>
  574. <td></td>
  575. </tr>
  576. </tbody>
  577. </table>
  578. <a id="Terminal_Gui_TextField_Secret_" data-uid="Terminal.Gui.TextField.Secret*"></a>
  579. <h4 id="Terminal_Gui_TextField_Secret" data-uid="Terminal.Gui.TextField.Secret">Secret</h4>
  580. <div class="markdown level1 summary">
  581. Sets the secret property.
  582. </div>
  583. <div class="markdown level1 conceptual"></div>
  584. <h5 class="decalaration">Declaration</h5>
  585. <div class="codewrapper">
  586. <pre><code class="lang-csharp hljs">public bool Secret { get; set; }</code></pre>
  587. </div>
  588. <h5 class="propertyValue">Property Value</h5>
  589. <table class="table table-bordered table-striped table-condensed">
  590. <thead>
  591. <tr>
  592. <th>Type</th>
  593. <th>Description</th>
  594. </tr>
  595. </thead>
  596. <tbody>
  597. <tr>
  598. <td><span class="xref">System.Boolean</span></td>
  599. <td></td>
  600. </tr>
  601. </tbody>
  602. </table>
  603. <h5 id="Terminal_Gui_TextField_Secret_remarks">Remarks</h5>
  604. <div class="markdown level1 remarks">
  605. This makes the text entry suitable for entering passwords.
  606. </div>
  607. <a id="Terminal_Gui_TextField_SelectedLength_" data-uid="Terminal.Gui.TextField.SelectedLength*"></a>
  608. <h4 id="Terminal_Gui_TextField_SelectedLength" data-uid="Terminal.Gui.TextField.SelectedLength">SelectedLength</h4>
  609. <div class="markdown level1 summary">
  610. Length of the selected text.
  611. </div>
  612. <div class="markdown level1 conceptual"></div>
  613. <h5 class="decalaration">Declaration</h5>
  614. <div class="codewrapper">
  615. <pre><code class="lang-csharp hljs">public int SelectedLength { get; set; }</code></pre>
  616. </div>
  617. <h5 class="propertyValue">Property Value</h5>
  618. <table class="table table-bordered table-striped table-condensed">
  619. <thead>
  620. <tr>
  621. <th>Type</th>
  622. <th>Description</th>
  623. </tr>
  624. </thead>
  625. <tbody>
  626. <tr>
  627. <td><span class="xref">System.Int32</span></td>
  628. <td></td>
  629. </tr>
  630. </tbody>
  631. </table>
  632. <a id="Terminal_Gui_TextField_SelectedStart_" data-uid="Terminal.Gui.TextField.SelectedStart*"></a>
  633. <h4 id="Terminal_Gui_TextField_SelectedStart" data-uid="Terminal.Gui.TextField.SelectedStart">SelectedStart</h4>
  634. <div class="markdown level1 summary">
  635. Start position of the selected text.
  636. </div>
  637. <div class="markdown level1 conceptual"></div>
  638. <h5 class="decalaration">Declaration</h5>
  639. <div class="codewrapper">
  640. <pre><code class="lang-csharp hljs">public int SelectedStart { get; set; }</code></pre>
  641. </div>
  642. <h5 class="propertyValue">Property Value</h5>
  643. <table class="table table-bordered table-striped table-condensed">
  644. <thead>
  645. <tr>
  646. <th>Type</th>
  647. <th>Description</th>
  648. </tr>
  649. </thead>
  650. <tbody>
  651. <tr>
  652. <td><span class="xref">System.Int32</span></td>
  653. <td></td>
  654. </tr>
  655. </tbody>
  656. </table>
  657. <a id="Terminal_Gui_TextField_SelectedText_" data-uid="Terminal.Gui.TextField.SelectedText*"></a>
  658. <h4 id="Terminal_Gui_TextField_SelectedText" data-uid="Terminal.Gui.TextField.SelectedText">SelectedText</h4>
  659. <div class="markdown level1 summary">
  660. The selected text.
  661. </div>
  662. <div class="markdown level1 conceptual"></div>
  663. <h5 class="decalaration">Declaration</h5>
  664. <div class="codewrapper">
  665. <pre><code class="lang-csharp hljs">public ustring SelectedText { get; set; }</code></pre>
  666. </div>
  667. <h5 class="propertyValue">Property Value</h5>
  668. <table class="table table-bordered table-striped table-condensed">
  669. <thead>
  670. <tr>
  671. <th>Type</th>
  672. <th>Description</th>
  673. </tr>
  674. </thead>
  675. <tbody>
  676. <tr>
  677. <td><span class="xref">NStack.ustring</span></td>
  678. <td></td>
  679. </tr>
  680. </tbody>
  681. </table>
  682. <a id="Terminal_Gui_TextField_Text_" data-uid="Terminal.Gui.TextField.Text*"></a>
  683. <h4 id="Terminal_Gui_TextField_Text" data-uid="Terminal.Gui.TextField.Text">Text</h4>
  684. <div class="markdown level1 summary">
  685. Sets or gets the text held by the view.
  686. </div>
  687. <div class="markdown level1 conceptual"></div>
  688. <h5 class="decalaration">Declaration</h5>
  689. <div class="codewrapper">
  690. <pre><code class="lang-csharp hljs">public ustring Text { get; set; }</code></pre>
  691. </div>
  692. <h5 class="propertyValue">Property Value</h5>
  693. <table class="table table-bordered table-striped table-condensed">
  694. <thead>
  695. <tr>
  696. <th>Type</th>
  697. <th>Description</th>
  698. </tr>
  699. </thead>
  700. <tbody>
  701. <tr>
  702. <td><span class="xref">NStack.ustring</span></td>
  703. <td></td>
  704. </tr>
  705. </tbody>
  706. </table>
  707. <h5 id="Terminal_Gui_TextField_Text_remarks">Remarks</h5>
  708. <div class="markdown level1 remarks">
  709. </div>
  710. <a id="Terminal_Gui_TextField_Used_" data-uid="Terminal.Gui.TextField.Used*"></a>
  711. <h4 id="Terminal_Gui_TextField_Used" data-uid="Terminal.Gui.TextField.Used">Used</h4>
  712. <div class="markdown level1 summary">
  713. Tracks whether the text field should be considered &quot;used&quot;, that is, that the user has moved in the entry, so new input should be appended at the cursor position, rather than clearing the entry
  714. </div>
  715. <div class="markdown level1 conceptual"></div>
  716. <h5 class="decalaration">Declaration</h5>
  717. <div class="codewrapper">
  718. <pre><code class="lang-csharp hljs">public bool Used { get; set; }</code></pre>
  719. </div>
  720. <h5 class="propertyValue">Property Value</h5>
  721. <table class="table table-bordered table-striped table-condensed">
  722. <thead>
  723. <tr>
  724. <th>Type</th>
  725. <th>Description</th>
  726. </tr>
  727. </thead>
  728. <tbody>
  729. <tr>
  730. <td><span class="xref">System.Boolean</span></td>
  731. <td></td>
  732. </tr>
  733. </tbody>
  734. </table>
  735. <h3 id="methods">Methods
  736. </h3>
  737. <a id="Terminal_Gui_TextField_ClearAllSelection_" data-uid="Terminal.Gui.TextField.ClearAllSelection*"></a>
  738. <h4 id="Terminal_Gui_TextField_ClearAllSelection" data-uid="Terminal.Gui.TextField.ClearAllSelection">ClearAllSelection()</h4>
  739. <div class="markdown level1 summary">
  740. Clear the selected text.
  741. </div>
  742. <div class="markdown level1 conceptual"></div>
  743. <h5 class="decalaration">Declaration</h5>
  744. <div class="codewrapper">
  745. <pre><code class="lang-csharp hljs">public void ClearAllSelection()</code></pre>
  746. </div>
  747. <a id="Terminal_Gui_TextField_Copy_" data-uid="Terminal.Gui.TextField.Copy*"></a>
  748. <h4 id="Terminal_Gui_TextField_Copy" data-uid="Terminal.Gui.TextField.Copy">Copy()</h4>
  749. <div class="markdown level1 summary">
  750. Copy the selected text to the clipboard.
  751. </div>
  752. <div class="markdown level1 conceptual"></div>
  753. <h5 class="decalaration">Declaration</h5>
  754. <div class="codewrapper">
  755. <pre><code class="lang-csharp hljs">public virtual void Copy()</code></pre>
  756. </div>
  757. <a id="Terminal_Gui_TextField_Cut_" data-uid="Terminal.Gui.TextField.Cut*"></a>
  758. <h4 id="Terminal_Gui_TextField_Cut" data-uid="Terminal.Gui.TextField.Cut">Cut()</h4>
  759. <div class="markdown level1 summary">
  760. Cut the selected text to the clipboard.
  761. </div>
  762. <div class="markdown level1 conceptual"></div>
  763. <h5 class="decalaration">Declaration</h5>
  764. <div class="codewrapper">
  765. <pre><code class="lang-csharp hljs">public virtual void Cut()</code></pre>
  766. </div>
  767. <a id="Terminal_Gui_TextField_MouseEvent_" data-uid="Terminal.Gui.TextField.MouseEvent*"></a>
  768. <h4 id="Terminal_Gui_TextField_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.TextField.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  769. <div class="markdown level1 summary">
  770. Method invoked when a mouse event is generated
  771. </div>
  772. <div class="markdown level1 conceptual"></div>
  773. <h5 class="decalaration">Declaration</h5>
  774. <div class="codewrapper">
  775. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent ev)</code></pre>
  776. </div>
  777. <h5 class="parameters">Parameters</h5>
  778. <table class="table table-bordered table-striped table-condensed">
  779. <thead>
  780. <tr>
  781. <th>Type</th>
  782. <th>Name</th>
  783. <th>Description</th>
  784. </tr>
  785. </thead>
  786. <tbody>
  787. <tr>
  788. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  789. <td><span class="parametername">ev</span></td>
  790. <td></td>
  791. </tr>
  792. </tbody>
  793. </table>
  794. <h5 class="returns">Returns</h5>
  795. <table class="table table-bordered table-striped table-condensed">
  796. <thead>
  797. <tr>
  798. <th>Type</th>
  799. <th>Description</th>
  800. </tr>
  801. </thead>
  802. <tbody>
  803. <tr>
  804. <td><span class="xref">System.Boolean</span></td>
  805. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  806. </tr>
  807. </tbody>
  808. </table>
  809. <h5 class="overrides">Overrides</h5>
  810. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  811. <a id="Terminal_Gui_TextField_OnLeave_" data-uid="Terminal.Gui.TextField.OnLeave*"></a>
  812. <h4 id="Terminal_Gui_TextField_OnLeave" data-uid="Terminal.Gui.TextField.OnLeave">OnLeave()</h4>
  813. <div class="markdown level1 summary">
  814. Method invoked when a view loses focus.
  815. </div>
  816. <div class="markdown level1 conceptual"></div>
  817. <h5 class="decalaration">Declaration</h5>
  818. <div class="codewrapper">
  819. <pre><code class="lang-csharp hljs">public override bool OnLeave()</code></pre>
  820. </div>
  821. <h5 class="returns">Returns</h5>
  822. <table class="table table-bordered table-striped table-condensed">
  823. <thead>
  824. <tr>
  825. <th>Type</th>
  826. <th>Description</th>
  827. </tr>
  828. </thead>
  829. <tbody>
  830. <tr>
  831. <td><span class="xref">System.Boolean</span></td>
  832. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  833. </tr>
  834. </tbody>
  835. </table>
  836. <h5 class="overrides">Overrides</h5>
  837. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave">View.OnLeave()</a></div>
  838. <a id="Terminal_Gui_TextField_Paste_" data-uid="Terminal.Gui.TextField.Paste*"></a>
  839. <h4 id="Terminal_Gui_TextField_Paste" data-uid="Terminal.Gui.TextField.Paste">Paste()</h4>
  840. <div class="markdown level1 summary">
  841. Paste the selected text from the clipboard.
  842. </div>
  843. <div class="markdown level1 conceptual"></div>
  844. <h5 class="decalaration">Declaration</h5>
  845. <div class="codewrapper">
  846. <pre><code class="lang-csharp hljs">public virtual void Paste()</code></pre>
  847. </div>
  848. <a id="Terminal_Gui_TextField_PositionCursor_" data-uid="Terminal.Gui.TextField.PositionCursor*"></a>
  849. <h4 id="Terminal_Gui_TextField_PositionCursor" data-uid="Terminal.Gui.TextField.PositionCursor">PositionCursor()</h4>
  850. <div class="markdown level1 summary">
  851. Sets the cursor position.
  852. </div>
  853. <div class="markdown level1 conceptual"></div>
  854. <h5 class="decalaration">Declaration</h5>
  855. <div class="codewrapper">
  856. <pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
  857. </div>
  858. <h5 class="overrides">Overrides</h5>
  859. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
  860. <a id="Terminal_Gui_TextField_ProcessKey_" data-uid="Terminal.Gui.TextField.ProcessKey*"></a>
  861. <h4 id="Terminal_Gui_TextField_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.TextField.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  862. <div class="markdown level1 summary">
  863. Processes key presses for the <a class="xref" href="Terminal.Gui.TextField.html">TextField</a>.
  864. </div>
  865. <div class="markdown level1 conceptual"></div>
  866. <h5 class="decalaration">Declaration</h5>
  867. <div class="codewrapper">
  868. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent kb)</code></pre>
  869. </div>
  870. <h5 class="parameters">Parameters</h5>
  871. <table class="table table-bordered table-striped table-condensed">
  872. <thead>
  873. <tr>
  874. <th>Type</th>
  875. <th>Name</th>
  876. <th>Description</th>
  877. </tr>
  878. </thead>
  879. <tbody>
  880. <tr>
  881. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  882. <td><span class="parametername">kb</span></td>
  883. <td></td>
  884. </tr>
  885. </tbody>
  886. </table>
  887. <h5 class="returns">Returns</h5>
  888. <table class="table table-bordered table-striped table-condensed">
  889. <thead>
  890. <tr>
  891. <th>Type</th>
  892. <th>Description</th>
  893. </tr>
  894. </thead>
  895. <tbody>
  896. <tr>
  897. <td><span class="xref">System.Boolean</span></td>
  898. <td></td>
  899. </tr>
  900. </tbody>
  901. </table>
  902. <h5 class="overrides">Overrides</h5>
  903. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  904. <h5 id="Terminal_Gui_TextField_ProcessKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
  905. <div class="markdown level1 remarks">
  906. The <a class="xref" href="Terminal.Gui.TextField.html">TextField</a> control responds to the following keys:
  907. <table><thead><tr><th>Keys</th><th>Function</th></tr></thead><tbody><tr><td><a class="xref" href="Terminal.Gui.Key.html#Terminal_Gui_Key_Delete">Delete</a>, <a class="xref" href="Terminal.Gui.Key.html#Terminal_Gui_Key_Backspace">Backspace</a></td><td>Deletes the character before cursor.</td></tr></tbody></table>
  908. </div>
  909. <a id="Terminal_Gui_TextField_Redraw_" data-uid="Terminal.Gui.TextField.Redraw*"></a>
  910. <h4 id="Terminal_Gui_TextField_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.TextField.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  911. <div class="markdown level1 summary">
  912. Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
  913. </div>
  914. <div class="markdown level1 conceptual"></div>
  915. <h5 class="decalaration">Declaration</h5>
  916. <div class="codewrapper">
  917. <pre><code class="lang-csharp hljs">public override void Redraw(Rect bounds)</code></pre>
  918. </div>
  919. <h5 class="parameters">Parameters</h5>
  920. <table class="table table-bordered table-striped table-condensed">
  921. <thead>
  922. <tr>
  923. <th>Type</th>
  924. <th>Name</th>
  925. <th>Description</th>
  926. </tr>
  927. </thead>
  928. <tbody>
  929. <tr>
  930. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  931. <td><span class="parametername">bounds</span></td>
  932. <td>The bounds (view-relative region) to redraw.</td>
  933. </tr>
  934. </tbody>
  935. </table>
  936. <h5 class="overrides">Overrides</h5>
  937. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  938. <h5 id="Terminal_Gui_TextField_Redraw_Terminal_Gui_Rect__remarks">Remarks</h5>
  939. <div class="markdown level1 remarks">
  940. <p>
  941. 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).
  942. </p>
  943. <p>
  944. Views should set the color that they want to use on entry, as otherwise this will inherit
  945. the last color that was set globaly on the driver.
  946. </p>
  947. <p>
  948. 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
  949. larger than the <code>region</code> parameter.
  950. </p>
  951. </div>
  952. <h3 id="implements">Implements</h3>
  953. <div>
  954. <span class="xref">System.Collections.IEnumerable</span>
  955. </div>
  956. </article>
  957. </div>
  958. <div class="hidden-sm col-md-2" role="complementary">
  959. <div class="sideaffix">
  960. <div class="contribution">
  961. <ul class="nav">
  962. </ul>
  963. </div>
  964. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  965. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  966. </nav>
  967. </div>
  968. </div>
  969. </div>
  970. </div>
  971. <footer>
  972. <div class="grad-bottom"></div>
  973. <div class="footer">
  974. <div class="container">
  975. <span class="pull-right">
  976. <a href="#top">Back to top</a>
  977. </span>
  978. <span>Generated by <strong>DocFX</strong></span>
  979. </div>
  980. </div>
  981. </footer>
  982. </div>
  983. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  984. <script type="text/javascript" src="../../styles/docfx.js"></script>
  985. <script type="text/javascript" src="../../styles/main.js"></script>
  986. </body>
  987. </html>