Terminal.Gui.TextField.html 44 KB

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