Terminal.Gui.TextField.html 50 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294
  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.56.7.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">Search Results for <span></span></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></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.IDisposable</span></div>
  91. <div><span class="xref">System.ComponentModel.ISupportInitializeNotification</span></div>
  92. <div><span class="xref">System.ComponentModel.ISupportInitialize</span></div>
  93. </div>
  94. <div class="inheritedMembers">
  95. <h5>Inherited Members</h5>
  96. <div>
  97. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Added">View.Added</a>
  98. </div>
  99. <div>
  100. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Removed">View.Removed</a>
  101. </div>
  102. <div>
  103. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  104. </div>
  105. <div>
  106. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  107. </div>
  108. <div>
  109. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  110. </div>
  111. <div>
  112. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  113. </div>
  114. <div>
  115. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  116. </div>
  117. <div>
  118. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKey">View.HotKey</a>
  119. </div>
  120. <div>
  121. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">View.HotKeySpecifier</a>
  122. </div>
  123. <div>
  124. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Shortcut">View.Shortcut</a>
  125. </div>
  126. <div>
  127. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutTag">View.ShortcutTag</a>
  128. </div>
  129. <div>
  130. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutAction">View.ShortcutAction</a>
  131. </div>
  132. <div>
  133. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Data">View.Data</a>
  134. </div>
  135. <div>
  136. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  137. </div>
  138. <div>
  139. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  140. </div>
  141. <div>
  142. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">View.TabIndexes</a>
  143. </div>
  144. <div>
  145. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndex">View.TabIndex</a>
  146. </div>
  147. <div>
  148. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabStop">View.TabStop</a>
  149. </div>
  150. <div>
  151. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  152. </div>
  153. <div>
  154. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  155. </div>
  156. <div>
  157. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  158. </div>
  159. <div>
  160. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  161. </div>
  162. <div>
  163. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  164. </div>
  165. <div>
  166. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  167. </div>
  168. <div>
  169. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  170. </div>
  171. <div>
  172. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  173. </div>
  174. <div>
  175. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  176. </div>
  177. <div>
  178. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  179. </div>
  180. <div>
  181. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  182. </div>
  183. <div>
  184. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  185. </div>
  186. <div>
  187. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearLayoutNeeded">View.ClearLayoutNeeded()</a>
  188. </div>
  189. <div>
  190. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  191. </div>
  192. <div>
  193. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetChildNeedsDisplay">View.SetChildNeedsDisplay()</a>
  194. </div>
  195. <div>
  196. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  197. </div>
  198. <div>
  199. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  200. </div>
  201. <div>
  202. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  203. </div>
  204. <div>
  205. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  206. </div>
  207. <div>
  208. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  209. </div>
  210. <div>
  211. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  212. </div>
  213. <div>
  214. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  215. </div>
  216. <div>
  217. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  218. </div>
  219. <div>
  220. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  221. </div>
  222. <div>
  223. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  224. </div>
  225. <div>
  226. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  227. </div>
  228. <div>
  229. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  230. </div>
  231. <div>
  232. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  233. </div>
  234. <div>
  235. <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>
  236. </div>
  237. <div>
  238. <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>
  239. </div>
  240. <div>
  241. <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>
  242. </div>
  243. <div>
  244. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  245. </div>
  246. <div>
  247. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  248. </div>
  249. <div>
  250. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnAdded_Terminal_Gui_View_">View.OnAdded(View)</a>
  251. </div>
  252. <div>
  253. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnRemoved_Terminal_Gui_View_">View.OnRemoved(View)</a>
  254. </div>
  255. <div>
  256. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  257. </div>
  258. <div>
  259. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  260. </div>
  261. <div>
  262. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  263. </div>
  264. <div>
  265. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  266. </div>
  267. <div>
  268. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  269. </div>
  270. <div>
  271. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  272. </div>
  273. <div>
  274. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  275. </div>
  276. <div>
  277. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus">View.SetFocus()</a>
  278. </div>
  279. <div>
  280. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  281. </div>
  282. <div>
  283. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  284. </div>
  285. <div>
  286. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  287. </div>
  288. <div>
  289. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  290. </div>
  291. <div>
  292. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  293. </div>
  294. <div>
  295. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  296. </div>
  297. <div>
  298. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  299. </div>
  300. <div>
  301. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  302. </div>
  303. <div>
  304. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  305. </div>
  306. <div>
  307. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  308. </div>
  309. <div>
  310. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  311. </div>
  312. <div>
  313. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  314. </div>
  315. <div>
  316. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStarted">View.LayoutStarted</a>
  317. </div>
  318. <div>
  319. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  320. </div>
  321. <div>
  322. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Initialized">View.Initialized</a>
  323. </div>
  324. <div>
  325. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  326. </div>
  327. <div>
  328. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AutoSize">View.AutoSize</a>
  329. </div>
  330. <div>
  331. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">View.TextAlignment</a>
  332. </div>
  333. <div>
  334. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsInitialized">View.IsInitialized</a>
  335. </div>
  336. <div>
  337. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  338. </div>
  339. <div>
  340. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  341. </div>
  342. <div>
  343. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  344. </div>
  345. <div>
  346. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  347. </div>
  348. <div>
  349. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseClick_Terminal_Gui_View_MouseEventArgs_">View.OnMouseClick(View.MouseEventArgs)</a>
  350. </div>
  351. <div>
  352. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Dispose_System_Boolean_">View.Dispose(Boolean)</a>
  353. </div>
  354. <div>
  355. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BeginInit">View.BeginInit()</a>
  356. </div>
  357. <div>
  358. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EndInit">View.EndInit()</a>
  359. </div>
  360. <div>
  361. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Visible">View.Visible</a>
  362. </div>
  363. <div>
  364. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetWidth_System_Int32_System_Int32__">View.SetWidth(Int32, Int32)</a>
  365. </div>
  366. <div>
  367. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetHeight_System_Int32_System_Int32__">View.SetHeight(Int32, Int32)</a>
  368. </div>
  369. <div>
  370. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
  371. </div>
  372. <div>
  373. <span class="xref">System.Object.Equals(System.Object)</span>
  374. </div>
  375. <div>
  376. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  377. </div>
  378. <div>
  379. <span class="xref">System.Object.GetHashCode()</span>
  380. </div>
  381. <div>
  382. <span class="xref">System.Object.GetType()</span>
  383. </div>
  384. <div>
  385. <span class="xref">System.Object.MemberwiseClone()</span>
  386. </div>
  387. <div>
  388. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  389. </div>
  390. </div>
  391. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  392. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  393. <h5 id="Terminal_Gui_TextField_syntax">Syntax</h5>
  394. <div class="codewrapper">
  395. <pre><code class="lang-csharp hljs">public class TextField : View, IDisposable, ISupportInitializeNotification, ISupportInitialize</code></pre>
  396. </div>
  397. <h5 id="Terminal_Gui_TextField_remarks"><strong>Remarks</strong></h5>
  398. <div class="markdown level0 remarks">
  399. 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.
  400. </div>
  401. <h3 id="constructors">Constructors
  402. </h3>
  403. <a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
  404. <h4 id="Terminal_Gui_TextField__ctor" data-uid="Terminal.Gui.TextField.#ctor">TextField()</h4>
  405. <div class="markdown level1 summary">
  406. 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.
  407. </div>
  408. <div class="markdown level1 conceptual"></div>
  409. <h5 class="decalaration">Declaration</h5>
  410. <div class="codewrapper">
  411. <pre><code class="lang-csharp hljs">public TextField()</code></pre>
  412. </div>
  413. <a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
  414. <h4 id="Terminal_Gui_TextField__ctor_NStack_ustring_" data-uid="Terminal.Gui.TextField.#ctor(NStack.ustring)">TextField(ustring)</h4>
  415. <div class="markdown level1 summary">
  416. 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.
  417. </div>
  418. <div class="markdown level1 conceptual"></div>
  419. <h5 class="decalaration">Declaration</h5>
  420. <div class="codewrapper">
  421. <pre><code class="lang-csharp hljs">public TextField(ustring text)</code></pre>
  422. </div>
  423. <h5 class="parameters">Parameters</h5>
  424. <table class="table table-bordered table-striped table-condensed">
  425. <thead>
  426. <tr>
  427. <th>Type</th>
  428. <th>Name</th>
  429. <th>Description</th>
  430. </tr>
  431. </thead>
  432. <tbody>
  433. <tr>
  434. <td><span class="xref">NStack.ustring</span></td>
  435. <td><span class="parametername">text</span></td>
  436. <td>Initial text contents.</td>
  437. </tr>
  438. </tbody>
  439. </table>
  440. <a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
  441. <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>
  442. <div class="markdown level1 summary">
  443. 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.
  444. </div>
  445. <div class="markdown level1 conceptual"></div>
  446. <h5 class="decalaration">Declaration</h5>
  447. <div class="codewrapper">
  448. <pre><code class="lang-csharp hljs">public TextField(int x, int y, int w, ustring text)</code></pre>
  449. </div>
  450. <h5 class="parameters">Parameters</h5>
  451. <table class="table table-bordered table-striped table-condensed">
  452. <thead>
  453. <tr>
  454. <th>Type</th>
  455. <th>Name</th>
  456. <th>Description</th>
  457. </tr>
  458. </thead>
  459. <tbody>
  460. <tr>
  461. <td><span class="xref">System.Int32</span></td>
  462. <td><span class="parametername">x</span></td>
  463. <td>The x coordinate.</td>
  464. </tr>
  465. <tr>
  466. <td><span class="xref">System.Int32</span></td>
  467. <td><span class="parametername">y</span></td>
  468. <td>The y coordinate.</td>
  469. </tr>
  470. <tr>
  471. <td><span class="xref">System.Int32</span></td>
  472. <td><span class="parametername">w</span></td>
  473. <td>The width.</td>
  474. </tr>
  475. <tr>
  476. <td><span class="xref">NStack.ustring</span></td>
  477. <td><span class="parametername">text</span></td>
  478. <td>Initial text contents.</td>
  479. </tr>
  480. </tbody>
  481. </table>
  482. <a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
  483. <h4 id="Terminal_Gui_TextField__ctor_System_String_" data-uid="Terminal.Gui.TextField.#ctor(System.String)">TextField(String)</h4>
  484. <div class="markdown level1 summary">
  485. 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.
  486. </div>
  487. <div class="markdown level1 conceptual"></div>
  488. <h5 class="decalaration">Declaration</h5>
  489. <div class="codewrapper">
  490. <pre><code class="lang-csharp hljs">public TextField(string text)</code></pre>
  491. </div>
  492. <h5 class="parameters">Parameters</h5>
  493. <table class="table table-bordered table-striped table-condensed">
  494. <thead>
  495. <tr>
  496. <th>Type</th>
  497. <th>Name</th>
  498. <th>Description</th>
  499. </tr>
  500. </thead>
  501. <tbody>
  502. <tr>
  503. <td><span class="xref">System.String</span></td>
  504. <td><span class="parametername">text</span></td>
  505. <td>Initial text contents.</td>
  506. </tr>
  507. </tbody>
  508. </table>
  509. <h3 id="properties">Properties
  510. </h3>
  511. <a id="Terminal_Gui_TextField_CanFocus_" data-uid="Terminal.Gui.TextField.CanFocus*"></a>
  512. <h4 id="Terminal_Gui_TextField_CanFocus" data-uid="Terminal.Gui.TextField.CanFocus">CanFocus</h4>
  513. <div class="markdown level1 summary">
  514. Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.Responder.html">Responder</a> can focus.
  515. </div>
  516. <div class="markdown level1 conceptual"></div>
  517. <h5 class="decalaration">Declaration</h5>
  518. <div class="codewrapper">
  519. <pre><code class="lang-csharp hljs">public override bool CanFocus { get; set; }</code></pre>
  520. </div>
  521. <h5 class="propertyValue">Property Value</h5>
  522. <table class="table table-bordered table-striped table-condensed">
  523. <thead>
  524. <tr>
  525. <th>Type</th>
  526. <th>Description</th>
  527. </tr>
  528. </thead>
  529. <tbody>
  530. <tr>
  531. <td><span class="xref">System.Boolean</span></td>
  532. <td><code>true</code> if can focus; otherwise, <code>false</code>.</td>
  533. </tr>
  534. </tbody>
  535. </table>
  536. <h5 class="overrides">Overrides</h5>
  537. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocus">View.CanFocus</a></div>
  538. <a id="Terminal_Gui_TextField_CursorPosition_" data-uid="Terminal.Gui.TextField.CursorPosition*"></a>
  539. <h4 id="Terminal_Gui_TextField_CursorPosition" data-uid="Terminal.Gui.TextField.CursorPosition">CursorPosition</h4>
  540. <div class="markdown level1 summary">
  541. Sets or gets the current cursor position.
  542. </div>
  543. <div class="markdown level1 conceptual"></div>
  544. <h5 class="decalaration">Declaration</h5>
  545. <div class="codewrapper">
  546. <pre><code class="lang-csharp hljs">public int CursorPosition { get; set; }</code></pre>
  547. </div>
  548. <h5 class="propertyValue">Property Value</h5>
  549. <table class="table table-bordered table-striped table-condensed">
  550. <thead>
  551. <tr>
  552. <th>Type</th>
  553. <th>Description</th>
  554. </tr>
  555. </thead>
  556. <tbody>
  557. <tr>
  558. <td><span class="xref">System.Int32</span></td>
  559. <td></td>
  560. </tr>
  561. </tbody>
  562. </table>
  563. <a id="Terminal_Gui_TextField_DesiredCursorVisibility_" data-uid="Terminal.Gui.TextField.DesiredCursorVisibility*"></a>
  564. <h4 id="Terminal_Gui_TextField_DesiredCursorVisibility" data-uid="Terminal.Gui.TextField.DesiredCursorVisibility">DesiredCursorVisibility</h4>
  565. <div class="markdown level1 summary">
  566. Get / Set the wished cursor when the field is focused
  567. </div>
  568. <div class="markdown level1 conceptual"></div>
  569. <h5 class="decalaration">Declaration</h5>
  570. <div class="codewrapper">
  571. <pre><code class="lang-csharp hljs">public CursorVisibility DesiredCursorVisibility { get; set; }</code></pre>
  572. </div>
  573. <h5 class="propertyValue">Property Value</h5>
  574. <table class="table table-bordered table-striped table-condensed">
  575. <thead>
  576. <tr>
  577. <th>Type</th>
  578. <th>Description</th>
  579. </tr>
  580. </thead>
  581. <tbody>
  582. <tr>
  583. <td><a class="xref" href="Terminal.Gui.CursorVisibility.html">CursorVisibility</a></td>
  584. <td></td>
  585. </tr>
  586. </tbody>
  587. </table>
  588. <a id="Terminal_Gui_TextField_Frame_" data-uid="Terminal.Gui.TextField.Frame*"></a>
  589. <h4 id="Terminal_Gui_TextField_Frame" data-uid="Terminal.Gui.TextField.Frame">Frame</h4>
  590. <div class="markdown level1 summary">
  591. 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>).
  592. </div>
  593. <div class="markdown level1 conceptual"></div>
  594. <h5 class="decalaration">Declaration</h5>
  595. <div class="codewrapper">
  596. <pre><code class="lang-csharp hljs">public override Rect Frame { get; set; }</code></pre>
  597. </div>
  598. <h5 class="propertyValue">Property Value</h5>
  599. <table class="table table-bordered table-striped table-condensed">
  600. <thead>
  601. <tr>
  602. <th>Type</th>
  603. <th>Description</th>
  604. </tr>
  605. </thead>
  606. <tbody>
  607. <tr>
  608. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  609. <td>The frame.</td>
  610. </tr>
  611. </tbody>
  612. </table>
  613. <h5 class="overrides">Overrides</h5>
  614. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a></div>
  615. <h5 id="Terminal_Gui_TextField_Frame_remarks">Remarks</h5>
  616. <div class="markdown level1 remarks">
  617. <p>
  618. 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.
  619. </p>
  620. <p>
  621. Altering the Frame of a view will trigger the redrawing of the
  622. 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>.
  623. </p>
  624. </div>
  625. <a id="Terminal_Gui_TextField_ReadOnly_" data-uid="Terminal.Gui.TextField.ReadOnly*"></a>
  626. <h4 id="Terminal_Gui_TextField_ReadOnly" data-uid="Terminal.Gui.TextField.ReadOnly">ReadOnly</h4>
  627. <div class="markdown level1 summary">
  628. If set to true its not allow any changes in the text.
  629. </div>
  630. <div class="markdown level1 conceptual"></div>
  631. <h5 class="decalaration">Declaration</h5>
  632. <div class="codewrapper">
  633. <pre><code class="lang-csharp hljs">public bool ReadOnly { get; set; }</code></pre>
  634. </div>
  635. <h5 class="propertyValue">Property Value</h5>
  636. <table class="table table-bordered table-striped table-condensed">
  637. <thead>
  638. <tr>
  639. <th>Type</th>
  640. <th>Description</th>
  641. </tr>
  642. </thead>
  643. <tbody>
  644. <tr>
  645. <td><span class="xref">System.Boolean</span></td>
  646. <td></td>
  647. </tr>
  648. </tbody>
  649. </table>
  650. <a id="Terminal_Gui_TextField_Secret_" data-uid="Terminal.Gui.TextField.Secret*"></a>
  651. <h4 id="Terminal_Gui_TextField_Secret" data-uid="Terminal.Gui.TextField.Secret">Secret</h4>
  652. <div class="markdown level1 summary">
  653. Sets the secret property.
  654. </div>
  655. <div class="markdown level1 conceptual"></div>
  656. <h5 class="decalaration">Declaration</h5>
  657. <div class="codewrapper">
  658. <pre><code class="lang-csharp hljs">public bool Secret { get; set; }</code></pre>
  659. </div>
  660. <h5 class="propertyValue">Property Value</h5>
  661. <table class="table table-bordered table-striped table-condensed">
  662. <thead>
  663. <tr>
  664. <th>Type</th>
  665. <th>Description</th>
  666. </tr>
  667. </thead>
  668. <tbody>
  669. <tr>
  670. <td><span class="xref">System.Boolean</span></td>
  671. <td></td>
  672. </tr>
  673. </tbody>
  674. </table>
  675. <h5 id="Terminal_Gui_TextField_Secret_remarks">Remarks</h5>
  676. <div class="markdown level1 remarks">
  677. This makes the text entry suitable for entering passwords.
  678. </div>
  679. <a id="Terminal_Gui_TextField_SelectedLength_" data-uid="Terminal.Gui.TextField.SelectedLength*"></a>
  680. <h4 id="Terminal_Gui_TextField_SelectedLength" data-uid="Terminal.Gui.TextField.SelectedLength">SelectedLength</h4>
  681. <div class="markdown level1 summary">
  682. Length of the selected text.
  683. </div>
  684. <div class="markdown level1 conceptual"></div>
  685. <h5 class="decalaration">Declaration</h5>
  686. <div class="codewrapper">
  687. <pre><code class="lang-csharp hljs">public int SelectedLength { get; set; }</code></pre>
  688. </div>
  689. <h5 class="propertyValue">Property Value</h5>
  690. <table class="table table-bordered table-striped table-condensed">
  691. <thead>
  692. <tr>
  693. <th>Type</th>
  694. <th>Description</th>
  695. </tr>
  696. </thead>
  697. <tbody>
  698. <tr>
  699. <td><span class="xref">System.Int32</span></td>
  700. <td></td>
  701. </tr>
  702. </tbody>
  703. </table>
  704. <a id="Terminal_Gui_TextField_SelectedStart_" data-uid="Terminal.Gui.TextField.SelectedStart*"></a>
  705. <h4 id="Terminal_Gui_TextField_SelectedStart" data-uid="Terminal.Gui.TextField.SelectedStart">SelectedStart</h4>
  706. <div class="markdown level1 summary">
  707. Start position of the selected text.
  708. </div>
  709. <div class="markdown level1 conceptual"></div>
  710. <h5 class="decalaration">Declaration</h5>
  711. <div class="codewrapper">
  712. <pre><code class="lang-csharp hljs">public int SelectedStart { get; set; }</code></pre>
  713. </div>
  714. <h5 class="propertyValue">Property Value</h5>
  715. <table class="table table-bordered table-striped table-condensed">
  716. <thead>
  717. <tr>
  718. <th>Type</th>
  719. <th>Description</th>
  720. </tr>
  721. </thead>
  722. <tbody>
  723. <tr>
  724. <td><span class="xref">System.Int32</span></td>
  725. <td></td>
  726. </tr>
  727. </tbody>
  728. </table>
  729. <a id="Terminal_Gui_TextField_SelectedText_" data-uid="Terminal.Gui.TextField.SelectedText*"></a>
  730. <h4 id="Terminal_Gui_TextField_SelectedText" data-uid="Terminal.Gui.TextField.SelectedText">SelectedText</h4>
  731. <div class="markdown level1 summary">
  732. The selected text.
  733. </div>
  734. <div class="markdown level1 conceptual"></div>
  735. <h5 class="decalaration">Declaration</h5>
  736. <div class="codewrapper">
  737. <pre><code class="lang-csharp hljs">public ustring SelectedText { get; set; }</code></pre>
  738. </div>
  739. <h5 class="propertyValue">Property Value</h5>
  740. <table class="table table-bordered table-striped table-condensed">
  741. <thead>
  742. <tr>
  743. <th>Type</th>
  744. <th>Description</th>
  745. </tr>
  746. </thead>
  747. <tbody>
  748. <tr>
  749. <td><span class="xref">NStack.ustring</span></td>
  750. <td></td>
  751. </tr>
  752. </tbody>
  753. </table>
  754. <a id="Terminal_Gui_TextField_Text_" data-uid="Terminal.Gui.TextField.Text*"></a>
  755. <h4 id="Terminal_Gui_TextField_Text" data-uid="Terminal.Gui.TextField.Text">Text</h4>
  756. <div class="markdown level1 summary">
  757. Sets or gets the text held by the view.
  758. </div>
  759. <div class="markdown level1 conceptual"></div>
  760. <h5 class="decalaration">Declaration</h5>
  761. <div class="codewrapper">
  762. <pre><code class="lang-csharp hljs">public ustring Text { get; set; }</code></pre>
  763. </div>
  764. <h5 class="propertyValue">Property Value</h5>
  765. <table class="table table-bordered table-striped table-condensed">
  766. <thead>
  767. <tr>
  768. <th>Type</th>
  769. <th>Description</th>
  770. </tr>
  771. </thead>
  772. <tbody>
  773. <tr>
  774. <td><span class="xref">NStack.ustring</span></td>
  775. <td></td>
  776. </tr>
  777. </tbody>
  778. </table>
  779. <h5 id="Terminal_Gui_TextField_Text_remarks">Remarks</h5>
  780. <div class="markdown level1 remarks">
  781. </div>
  782. <a id="Terminal_Gui_TextField_Used_" data-uid="Terminal.Gui.TextField.Used*"></a>
  783. <h4 id="Terminal_Gui_TextField_Used" data-uid="Terminal.Gui.TextField.Used">Used</h4>
  784. <div class="markdown level1 summary">
  785. 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
  786. </div>
  787. <div class="markdown level1 conceptual"></div>
  788. <h5 class="decalaration">Declaration</h5>
  789. <div class="codewrapper">
  790. <pre><code class="lang-csharp hljs">public bool Used { get; set; }</code></pre>
  791. </div>
  792. <h5 class="propertyValue">Property Value</h5>
  793. <table class="table table-bordered table-striped table-condensed">
  794. <thead>
  795. <tr>
  796. <th>Type</th>
  797. <th>Description</th>
  798. </tr>
  799. </thead>
  800. <tbody>
  801. <tr>
  802. <td><span class="xref">System.Boolean</span></td>
  803. <td></td>
  804. </tr>
  805. </tbody>
  806. </table>
  807. <h3 id="methods">Methods
  808. </h3>
  809. <a id="Terminal_Gui_TextField_ClearAllSelection_" data-uid="Terminal.Gui.TextField.ClearAllSelection*"></a>
  810. <h4 id="Terminal_Gui_TextField_ClearAllSelection" data-uid="Terminal.Gui.TextField.ClearAllSelection">ClearAllSelection()</h4>
  811. <div class="markdown level1 summary">
  812. Clear the selected text.
  813. </div>
  814. <div class="markdown level1 conceptual"></div>
  815. <h5 class="decalaration">Declaration</h5>
  816. <div class="codewrapper">
  817. <pre><code class="lang-csharp hljs">public void ClearAllSelection()</code></pre>
  818. </div>
  819. <a id="Terminal_Gui_TextField_Copy_" data-uid="Terminal.Gui.TextField.Copy*"></a>
  820. <h4 id="Terminal_Gui_TextField_Copy" data-uid="Terminal.Gui.TextField.Copy">Copy()</h4>
  821. <div class="markdown level1 summary">
  822. Copy the selected text to the clipboard.
  823. </div>
  824. <div class="markdown level1 conceptual"></div>
  825. <h5 class="decalaration">Declaration</h5>
  826. <div class="codewrapper">
  827. <pre><code class="lang-csharp hljs">public virtual void Copy()</code></pre>
  828. </div>
  829. <a id="Terminal_Gui_TextField_Cut_" data-uid="Terminal.Gui.TextField.Cut*"></a>
  830. <h4 id="Terminal_Gui_TextField_Cut" data-uid="Terminal.Gui.TextField.Cut">Cut()</h4>
  831. <div class="markdown level1 summary">
  832. Cut the selected text to the clipboard.
  833. </div>
  834. <div class="markdown level1 conceptual"></div>
  835. <h5 class="decalaration">Declaration</h5>
  836. <div class="codewrapper">
  837. <pre><code class="lang-csharp hljs">public virtual void Cut()</code></pre>
  838. </div>
  839. <a id="Terminal_Gui_TextField_MouseEvent_" data-uid="Terminal.Gui.TextField.MouseEvent*"></a>
  840. <h4 id="Terminal_Gui_TextField_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.TextField.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  841. <div class="markdown level1 summary">
  842. Method invoked when a mouse event is generated
  843. </div>
  844. <div class="markdown level1 conceptual"></div>
  845. <h5 class="decalaration">Declaration</h5>
  846. <div class="codewrapper">
  847. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent ev)</code></pre>
  848. </div>
  849. <h5 class="parameters">Parameters</h5>
  850. <table class="table table-bordered table-striped table-condensed">
  851. <thead>
  852. <tr>
  853. <th>Type</th>
  854. <th>Name</th>
  855. <th>Description</th>
  856. </tr>
  857. </thead>
  858. <tbody>
  859. <tr>
  860. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  861. <td><span class="parametername">ev</span></td>
  862. <td></td>
  863. </tr>
  864. </tbody>
  865. </table>
  866. <h5 class="returns">Returns</h5>
  867. <table class="table table-bordered table-striped table-condensed">
  868. <thead>
  869. <tr>
  870. <th>Type</th>
  871. <th>Description</th>
  872. </tr>
  873. </thead>
  874. <tbody>
  875. <tr>
  876. <td><span class="xref">System.Boolean</span></td>
  877. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  878. </tr>
  879. </tbody>
  880. </table>
  881. <h5 class="overrides">Overrides</h5>
  882. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  883. <a id="Terminal_Gui_TextField_OnEnter_" data-uid="Terminal.Gui.TextField.OnEnter*"></a>
  884. <h4 id="Terminal_Gui_TextField_OnEnter_Terminal_Gui_View_" data-uid="Terminal.Gui.TextField.OnEnter(Terminal.Gui.View)">OnEnter(View)</h4>
  885. <div class="markdown level1 summary">
  886. Method invoked when a view gets focus.
  887. </div>
  888. <div class="markdown level1 conceptual"></div>
  889. <h5 class="decalaration">Declaration</h5>
  890. <div class="codewrapper">
  891. <pre><code class="lang-csharp hljs">public override bool OnEnter(View view)</code></pre>
  892. </div>
  893. <h5 class="parameters">Parameters</h5>
  894. <table class="table table-bordered table-striped table-condensed">
  895. <thead>
  896. <tr>
  897. <th>Type</th>
  898. <th>Name</th>
  899. <th>Description</th>
  900. </tr>
  901. </thead>
  902. <tbody>
  903. <tr>
  904. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  905. <td><span class="parametername">view</span></td>
  906. <td>The view that is losing focus.</td>
  907. </tr>
  908. </tbody>
  909. </table>
  910. <h5 class="returns">Returns</h5>
  911. <table class="table table-bordered table-striped table-condensed">
  912. <thead>
  913. <tr>
  914. <th>Type</th>
  915. <th>Description</th>
  916. </tr>
  917. </thead>
  918. <tbody>
  919. <tr>
  920. <td><span class="xref">System.Boolean</span></td>
  921. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  922. </tr>
  923. </tbody>
  924. </table>
  925. <h5 class="overrides">Overrides</h5>
  926. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter_Terminal_Gui_View_">View.OnEnter(View)</a></div>
  927. <a id="Terminal_Gui_TextField_OnLeave_" data-uid="Terminal.Gui.TextField.OnLeave*"></a>
  928. <h4 id="Terminal_Gui_TextField_OnLeave_Terminal_Gui_View_" data-uid="Terminal.Gui.TextField.OnLeave(Terminal.Gui.View)">OnLeave(View)</h4>
  929. <div class="markdown level1 summary">
  930. Method invoked when a view loses focus.
  931. </div>
  932. <div class="markdown level1 conceptual"></div>
  933. <h5 class="decalaration">Declaration</h5>
  934. <div class="codewrapper">
  935. <pre><code class="lang-csharp hljs">public override bool OnLeave(View view)</code></pre>
  936. </div>
  937. <h5 class="parameters">Parameters</h5>
  938. <table class="table table-bordered table-striped table-condensed">
  939. <thead>
  940. <tr>
  941. <th>Type</th>
  942. <th>Name</th>
  943. <th>Description</th>
  944. </tr>
  945. </thead>
  946. <tbody>
  947. <tr>
  948. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  949. <td><span class="parametername">view</span></td>
  950. <td>The view that is getting focus.</td>
  951. </tr>
  952. </tbody>
  953. </table>
  954. <h5 class="returns">Returns</h5>
  955. <table class="table table-bordered table-striped table-condensed">
  956. <thead>
  957. <tr>
  958. <th>Type</th>
  959. <th>Description</th>
  960. </tr>
  961. </thead>
  962. <tbody>
  963. <tr>
  964. <td><span class="xref">System.Boolean</span></td>
  965. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  966. </tr>
  967. </tbody>
  968. </table>
  969. <h5 class="overrides">Overrides</h5>
  970. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave_Terminal_Gui_View_">View.OnLeave(View)</a></div>
  971. <a id="Terminal_Gui_TextField_OnTextChanging_" data-uid="Terminal.Gui.TextField.OnTextChanging*"></a>
  972. <h4 id="Terminal_Gui_TextField_OnTextChanging_NStack_ustring_" data-uid="Terminal.Gui.TextField.OnTextChanging(NStack.ustring)">OnTextChanging(ustring)</h4>
  973. <div class="markdown level1 summary">
  974. Virtual method that invoke the <a class="xref" href="Terminal.Gui.TextField.html#Terminal_Gui_TextField_TextChanging">TextChanging</a> event if it&apos;s defined.
  975. </div>
  976. <div class="markdown level1 conceptual"></div>
  977. <h5 class="decalaration">Declaration</h5>
  978. <div class="codewrapper">
  979. <pre><code class="lang-csharp hljs">public virtual TextChangingEventArgs OnTextChanging(ustring newText)</code></pre>
  980. </div>
  981. <h5 class="parameters">Parameters</h5>
  982. <table class="table table-bordered table-striped table-condensed">
  983. <thead>
  984. <tr>
  985. <th>Type</th>
  986. <th>Name</th>
  987. <th>Description</th>
  988. </tr>
  989. </thead>
  990. <tbody>
  991. <tr>
  992. <td><span class="xref">NStack.ustring</span></td>
  993. <td><span class="parametername">newText</span></td>
  994. <td>The new text to be replaced.</td>
  995. </tr>
  996. </tbody>
  997. </table>
  998. <h5 class="returns">Returns</h5>
  999. <table class="table table-bordered table-striped table-condensed">
  1000. <thead>
  1001. <tr>
  1002. <th>Type</th>
  1003. <th>Description</th>
  1004. </tr>
  1005. </thead>
  1006. <tbody>
  1007. <tr>
  1008. <td><a class="xref" href="Terminal.Gui.TextChangingEventArgs.html">TextChangingEventArgs</a></td>
  1009. <td>Returns the <a class="xref" href="Terminal.Gui.TextChangingEventArgs.html">TextChangingEventArgs</a></td>
  1010. </tr>
  1011. </tbody>
  1012. </table>
  1013. <a id="Terminal_Gui_TextField_Paste_" data-uid="Terminal.Gui.TextField.Paste*"></a>
  1014. <h4 id="Terminal_Gui_TextField_Paste" data-uid="Terminal.Gui.TextField.Paste">Paste()</h4>
  1015. <div class="markdown level1 summary">
  1016. Paste the selected text from the clipboard.
  1017. </div>
  1018. <div class="markdown level1 conceptual"></div>
  1019. <h5 class="decalaration">Declaration</h5>
  1020. <div class="codewrapper">
  1021. <pre><code class="lang-csharp hljs">public virtual void Paste()</code></pre>
  1022. </div>
  1023. <a id="Terminal_Gui_TextField_PositionCursor_" data-uid="Terminal.Gui.TextField.PositionCursor*"></a>
  1024. <h4 id="Terminal_Gui_TextField_PositionCursor" data-uid="Terminal.Gui.TextField.PositionCursor">PositionCursor()</h4>
  1025. <div class="markdown level1 summary">
  1026. Sets the cursor position.
  1027. </div>
  1028. <div class="markdown level1 conceptual"></div>
  1029. <h5 class="decalaration">Declaration</h5>
  1030. <div class="codewrapper">
  1031. <pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
  1032. </div>
  1033. <h5 class="overrides">Overrides</h5>
  1034. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
  1035. <a id="Terminal_Gui_TextField_ProcessKey_" data-uid="Terminal.Gui.TextField.ProcessKey*"></a>
  1036. <h4 id="Terminal_Gui_TextField_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.TextField.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  1037. <div class="markdown level1 summary">
  1038. Processes key presses for the <a class="xref" href="Terminal.Gui.TextField.html">TextField</a>.
  1039. </div>
  1040. <div class="markdown level1 conceptual"></div>
  1041. <h5 class="decalaration">Declaration</h5>
  1042. <div class="codewrapper">
  1043. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent kb)</code></pre>
  1044. </div>
  1045. <h5 class="parameters">Parameters</h5>
  1046. <table class="table table-bordered table-striped table-condensed">
  1047. <thead>
  1048. <tr>
  1049. <th>Type</th>
  1050. <th>Name</th>
  1051. <th>Description</th>
  1052. </tr>
  1053. </thead>
  1054. <tbody>
  1055. <tr>
  1056. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  1057. <td><span class="parametername">kb</span></td>
  1058. <td></td>
  1059. </tr>
  1060. </tbody>
  1061. </table>
  1062. <h5 class="returns">Returns</h5>
  1063. <table class="table table-bordered table-striped table-condensed">
  1064. <thead>
  1065. <tr>
  1066. <th>Type</th>
  1067. <th>Description</th>
  1068. </tr>
  1069. </thead>
  1070. <tbody>
  1071. <tr>
  1072. <td><span class="xref">System.Boolean</span></td>
  1073. <td></td>
  1074. </tr>
  1075. </tbody>
  1076. </table>
  1077. <h5 class="overrides">Overrides</h5>
  1078. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  1079. <h5 id="Terminal_Gui_TextField_ProcessKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
  1080. <div class="markdown level1 remarks">
  1081. The <a class="xref" href="Terminal.Gui.TextField.html">TextField</a> control responds to the following keys:
  1082. <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>
  1083. </div>
  1084. <a id="Terminal_Gui_TextField_Redraw_" data-uid="Terminal.Gui.TextField.Redraw*"></a>
  1085. <h4 id="Terminal_Gui_TextField_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.TextField.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  1086. <div class="markdown level1 summary">
  1087. Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
  1088. </div>
  1089. <div class="markdown level1 conceptual"></div>
  1090. <h5 class="decalaration">Declaration</h5>
  1091. <div class="codewrapper">
  1092. <pre><code class="lang-csharp hljs">public override void Redraw(Rect bounds)</code></pre>
  1093. </div>
  1094. <h5 class="parameters">Parameters</h5>
  1095. <table class="table table-bordered table-striped table-condensed">
  1096. <thead>
  1097. <tr>
  1098. <th>Type</th>
  1099. <th>Name</th>
  1100. <th>Description</th>
  1101. </tr>
  1102. </thead>
  1103. <tbody>
  1104. <tr>
  1105. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1106. <td><span class="parametername">bounds</span></td>
  1107. <td>The bounds (view-relative region) to redraw.</td>
  1108. </tr>
  1109. </tbody>
  1110. </table>
  1111. <h5 class="overrides">Overrides</h5>
  1112. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  1113. <h5 id="Terminal_Gui_TextField_Redraw_Terminal_Gui_Rect__remarks">Remarks</h5>
  1114. <div class="markdown level1 remarks">
  1115. <p>
  1116. 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).
  1117. </p>
  1118. <p>
  1119. Views should set the color that they want to use on entry, as otherwise this will inherit
  1120. the last color that was set globally on the driver.
  1121. </p>
  1122. <p>
  1123. 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
  1124. larger than the <code>region</code> parameter.
  1125. </p>
  1126. </div>
  1127. <h3 id="events">Events
  1128. </h3>
  1129. <h4 id="Terminal_Gui_TextField_TextChanged" data-uid="Terminal.Gui.TextField.TextChanged">TextChanged</h4>
  1130. <div class="markdown level1 summary">
  1131. Changed event, raised when the text has changed.
  1132. </div>
  1133. <div class="markdown level1 conceptual"></div>
  1134. <h5 class="decalaration">Declaration</h5>
  1135. <div class="codewrapper">
  1136. <pre><code class="lang-csharp hljs">public event Action&lt;ustring&gt; TextChanged</code></pre>
  1137. </div>
  1138. <h5 class="eventType">Event Type</h5>
  1139. <table class="table table-bordered table-striped table-condensed">
  1140. <thead>
  1141. <tr>
  1142. <th>Type</th>
  1143. <th>Description</th>
  1144. </tr>
  1145. </thead>
  1146. <tbody>
  1147. <tr>
  1148. <td><span class="xref">System.Action</span>&lt;<span class="xref">NStack.ustring</span>&gt;</td>
  1149. <td></td>
  1150. </tr>
  1151. </tbody>
  1152. </table>
  1153. <h5 id="Terminal_Gui_TextField_TextChanged_remarks">Remarks</h5>
  1154. <div class="markdown level1 remarks">
  1155. This event is raised when the <a class="xref" href="Terminal.Gui.TextField.html#Terminal_Gui_TextField_Text">Text</a> changes.
  1156. </div>
  1157. <h4 id="Terminal_Gui_TextField_TextChanging" data-uid="Terminal.Gui.TextField.TextChanging">TextChanging</h4>
  1158. <div class="markdown level1 summary">
  1159. Changing event, raised before the <a class="xref" href="Terminal.Gui.TextField.html#Terminal_Gui_TextField_Text">Text</a> changes and can be canceled or changing the new text.
  1160. </div>
  1161. <div class="markdown level1 conceptual"></div>
  1162. <h5 class="decalaration">Declaration</h5>
  1163. <div class="codewrapper">
  1164. <pre><code class="lang-csharp hljs">public event Action&lt;TextChangingEventArgs&gt; TextChanging</code></pre>
  1165. </div>
  1166. <h5 class="eventType">Event Type</h5>
  1167. <table class="table table-bordered table-striped table-condensed">
  1168. <thead>
  1169. <tr>
  1170. <th>Type</th>
  1171. <th>Description</th>
  1172. </tr>
  1173. </thead>
  1174. <tbody>
  1175. <tr>
  1176. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.TextChangingEventArgs.html">TextChangingEventArgs</a>&gt;</td>
  1177. <td></td>
  1178. </tr>
  1179. </tbody>
  1180. </table>
  1181. <h3 id="implements">Implements</h3>
  1182. <div>
  1183. <span class="xref">System.IDisposable</span>
  1184. </div>
  1185. <div>
  1186. <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
  1187. </div>
  1188. <div>
  1189. <span class="xref">System.ComponentModel.ISupportInitialize</span>
  1190. </div>
  1191. </article>
  1192. </div>
  1193. <div class="hidden-sm col-md-2" role="complementary">
  1194. <div class="sideaffix">
  1195. <div class="contribution">
  1196. <ul class="nav">
  1197. </ul>
  1198. </div>
  1199. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  1200. <h5>In This Article</h5>
  1201. <div></div>
  1202. </nav>
  1203. </div>
  1204. </div>
  1205. </div>
  1206. </div>
  1207. <footer>
  1208. <div class="grad-bottom"></div>
  1209. <div class="footer">
  1210. <div class="container">
  1211. <span class="pull-right">
  1212. <a href="#top">Back to top</a>
  1213. </span>
  1214. <span>Generated by <strong>DocFX</strong></span>
  1215. </div>
  1216. </div>
  1217. </footer>
  1218. </div>
  1219. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  1220. <script type="text/javascript" src="../../styles/docfx.js"></script>
  1221. <script type="text/javascript" src="../../styles/main.js"></script>
  1222. </body>
  1223. </html>