Terminal.Gui.TextField.html 47 KB

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