Terminal.Gui.TextField.html 44 KB

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