Terminal.Gui.TextField.html 63 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542
  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.59.3.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. <link href="https://fonts.googleapis.com/css?family=Source Sans Pro" rel="stylesheet">
  18. <link href="https://fonts.googleapis.com/css?family=Source Code Pro" rel="stylesheet">
  19. <meta property="docfx:navrel" content="../../toc.html">
  20. <meta property="docfx:tocrel" content="toc.html">
  21. <meta property="docfx:rel" content="../../">
  22. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  23. <div id="wrapper">
  24. <header>
  25. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  26. <div class="container">
  27. <div class="navbar-header">
  28. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  29. <span class="sr-only">Toggle navigation</span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. <span class="icon-bar"></span>
  33. </button>
  34. <a class="navbar-brand" href="../../index.html">
  35. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  36. </a>
  37. </div>
  38. <div class="collapse navbar-collapse" id="navbar">
  39. <form class="navbar-form navbar-right" role="search" id="search">
  40. <div class="form-group">
  41. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  42. </div>
  43. </form>
  44. </div>
  45. </div>
  46. </nav>
  47. <div class="subnav navbar navbar-default">
  48. <div class="container hide-when-search" id="breadcrumb">
  49. <ul class="breadcrumb">
  50. <li></li>
  51. </ul>
  52. </div>
  53. </div>
  54. </header>
  55. <div class="container body-content">
  56. <div id="search-results">
  57. <div class="search-list">Search Results for <span></span></div>
  58. <div class="sr-items">
  59. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  60. </div>
  61. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  62. </div>
  63. </div>
  64. <div role="main" class="container body-content hide-when-search">
  65. <div class="sidenav hide-when-search">
  66. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  67. <div class="sidetoggle collapse" id="sidetoggle">
  68. <div id="sidetoc"></div>
  69. </div>
  70. </div>
  71. <div class="article row grid-right">
  72. <div class="col-md-10">
  73. <article class="content wrap" id="_content" data-uid="Terminal.Gui.TextField">
  74. <h1 id="Terminal_Gui_TextField" data-uid="Terminal.Gui.TextField" class="text-break">Class TextField
  75. </h1>
  76. <div class="markdown level0 summary">
  77. Single-line text entry <a class="xref" href="Terminal.Gui.View.html">View</a>
  78. </div>
  79. <div class="markdown level0 conceptual"></div>
  80. <div class="inheritance">
  81. <h5>Inheritance</h5>
  82. <div class="level0"><span class="xref">System.Object</span></div>
  83. <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
  84. <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
  85. <div class="level3"><span class="xref">TextField</span></div>
  86. <div class="level4"><a class="xref" href="Terminal.Gui.DateField.html">DateField</a></div>
  87. <div class="level4"><a class="xref" href="Terminal.Gui.TimeField.html">TimeField</a></div>
  88. </div>
  89. <div class="implements">
  90. <h5>Implements</h5>
  91. <div><span class="xref">System.IDisposable</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. <h5 id="Terminal_Gui_TextField_remarks"><strong>Remarks</strong></h5>
  96. <div class="markdown level0 remarks">
  97. 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.
  98. </div>
  99. <div class="inheritedMembers">
  100. <h5>Inherited Members</h5>
  101. <div>
  102. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetMinWidthHeight_Terminal_Gui_Size__">View.GetMinWidthHeight(Size)</a>
  103. </div>
  104. <div>
  105. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetMinWidthHeight">View.SetMinWidthHeight()</a>
  106. </div>
  107. <div>
  108. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_UpdateTextFormatterText">View.UpdateTextFormatterText()</a>
  109. </div>
  110. <div>
  111. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessResizeView">View.ProcessResizeView()</a>
  112. </div>
  113. <div>
  114. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  115. </div>
  116. <div>
  117. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearLayoutNeeded">View.ClearLayoutNeeded()</a>
  118. </div>
  119. <div>
  120. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  121. </div>
  122. <div>
  123. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetChildNeedsDisplay">View.SetChildNeedsDisplay()</a>
  124. </div>
  125. <div>
  126. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  127. </div>
  128. <div>
  129. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  130. </div>
  131. <div>
  132. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  133. </div>
  134. <div>
  135. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  136. </div>
  137. <div>
  138. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  139. </div>
  140. <div>
  141. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  142. </div>
  143. <div>
  144. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  145. </div>
  146. <div>
  147. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  148. </div>
  149. <div>
  150. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  151. </div>
  152. <div>
  153. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  154. </div>
  155. <div>
  156. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  157. </div>
  158. <div>
  159. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  160. </div>
  161. <div>
  162. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  163. </div>
  164. <div>
  165. <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>
  166. </div>
  167. <div>
  168. <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>
  169. </div>
  170. <div>
  171. <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>
  172. </div>
  173. <div>
  174. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_System_Boolean_">View.Move(Int32, Int32, Boolean)</a>
  175. </div>
  176. <div>
  177. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnAdded_Terminal_Gui_View_">View.OnAdded(View)</a>
  178. </div>
  179. <div>
  180. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnRemoved_Terminal_Gui_View_">View.OnRemoved(View)</a>
  181. </div>
  182. <div>
  183. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  184. </div>
  185. <div>
  186. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  187. </div>
  188. <div>
  189. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  190. </div>
  191. <div>
  192. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContentComplete_Terminal_Gui_Rect_">View.OnDrawContentComplete(Rect)</a>
  193. </div>
  194. <div>
  195. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus">View.SetFocus()</a>
  196. </div>
  197. <div>
  198. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_InvokeKeybindings_Terminal_Gui_KeyEvent_">View.InvokeKeybindings(KeyEvent)</a>
  199. </div>
  200. <div>
  201. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddKeyBinding_Terminal_Gui_Key_Terminal_Gui_Command_">View.AddKeyBinding(Key, Command)</a>
  202. </div>
  203. <div>
  204. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ReplaceKeyBinding_Terminal_Gui_Key_Terminal_Gui_Key_">View.ReplaceKeyBinding(Key, Key)</a>
  205. </div>
  206. <div>
  207. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ContainsKeyBinding_Terminal_Gui_Key_">View.ContainsKeyBinding(Key)</a>
  208. </div>
  209. <div>
  210. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybindings">View.ClearKeybindings()</a>
  211. </div>
  212. <div>
  213. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Key_">View.ClearKeybinding(Key)</a>
  214. </div>
  215. <div>
  216. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Command_">View.ClearKeybinding(Command)</a>
  217. </div>
  218. <div>
  219. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddCommand_Terminal_Gui_Command_System_Func_System_Nullable_System_Boolean___">View.AddCommand(Command, Func&lt;Nullable&lt;Boolean&gt;&gt;)</a>
  220. </div>
  221. <div>
  222. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetSupportedCommands">View.GetSupportedCommands()</a>
  223. </div>
  224. <div>
  225. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetKeyFromCommand_Terminal_Gui_Command_">View.GetKeyFromCommand(Command)</a>
  226. </div>
  227. <div>
  228. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  229. </div>
  230. <div>
  231. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  232. </div>
  233. <div>
  234. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  235. </div>
  236. <div>
  237. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  238. </div>
  239. <div>
  240. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  241. </div>
  242. <div>
  243. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  244. </div>
  245. <div>
  246. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  247. </div>
  248. <div>
  249. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  250. </div>
  251. <div>
  252. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  253. </div>
  254. <div>
  255. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  256. </div>
  257. <div>
  258. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  259. </div>
  260. <div>
  261. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetAutoSize">View.GetAutoSize()</a>
  262. </div>
  263. <div>
  264. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetHotKeySpecifierLength_System_Boolean_">View.GetHotKeySpecifierLength(Boolean)</a>
  265. </div>
  266. <div>
  267. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTextFormatterBoundsSize">View.GetTextFormatterBoundsSize()</a>
  268. </div>
  269. <div>
  270. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetBoundsTextFormatterSize">View.GetBoundsTextFormatterSize()</a>
  271. </div>
  272. <div>
  273. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  274. </div>
  275. <div>
  276. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  277. </div>
  278. <div>
  279. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  280. </div>
  281. <div>
  282. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseClick_Terminal_Gui_View_MouseEventArgs_">View.OnMouseClick(View.MouseEventArgs)</a>
  283. </div>
  284. <div>
  285. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnCanFocusChanged">View.OnCanFocusChanged()</a>
  286. </div>
  287. <div>
  288. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnabledChanged">View.OnEnabledChanged()</a>
  289. </div>
  290. <div>
  291. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnVisibleChanged">View.OnVisibleChanged()</a>
  292. </div>
  293. <div>
  294. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Dispose_System_Boolean_">View.Dispose(Boolean)</a>
  295. </div>
  296. <div>
  297. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BeginInit">View.BeginInit()</a>
  298. </div>
  299. <div>
  300. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EndInit">View.EndInit()</a>
  301. </div>
  302. <div>
  303. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetWidth_System_Int32_System_Int32__">View.SetWidth(Int32, Int32)</a>
  304. </div>
  305. <div>
  306. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetHeight_System_Int32_System_Int32__">View.SetHeight(Int32, Int32)</a>
  307. </div>
  308. <div>
  309. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentWidth_System_Int32__">View.GetCurrentWidth(Int32)</a>
  310. </div>
  311. <div>
  312. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentHeight_System_Int32__">View.GetCurrentHeight(Int32)</a>
  313. </div>
  314. <div>
  315. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetNormalColor">View.GetNormalColor()</a>
  316. </div>
  317. <div>
  318. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTopSuperView">View.GetTopSuperView()</a>
  319. </div>
  320. <div>
  321. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKey">View.HotKey</a>
  322. </div>
  323. <div>
  324. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">View.HotKeySpecifier</a>
  325. </div>
  326. <div>
  327. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Shortcut">View.Shortcut</a>
  328. </div>
  329. <div>
  330. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutTag">View.ShortcutTag</a>
  331. </div>
  332. <div>
  333. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutAction">View.ShortcutAction</a>
  334. </div>
  335. <div>
  336. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Data">View.Data</a>
  337. </div>
  338. <div>
  339. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  340. </div>
  341. <div>
  342. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  343. </div>
  344. <div>
  345. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">View.TabIndexes</a>
  346. </div>
  347. <div>
  348. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndex">View.TabIndex</a>
  349. </div>
  350. <div>
  351. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabStop">View.TabStop</a>
  352. </div>
  353. <div>
  354. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  355. </div>
  356. <div>
  357. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  358. </div>
  359. <div>
  360. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  361. </div>
  362. <div>
  363. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  364. </div>
  365. <div>
  366. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  367. </div>
  368. <div>
  369. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  370. </div>
  371. <div>
  372. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  373. </div>
  374. <div>
  375. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  376. </div>
  377. <div>
  378. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  379. </div>
  380. <div>
  381. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  382. </div>
  383. <div>
  384. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ForceValidatePosDim">View.ForceValidatePosDim</a>
  385. </div>
  386. <div>
  387. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextFormatter">View.TextFormatter</a>
  388. </div>
  389. <div>
  390. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  391. </div>
  392. <div>
  393. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  394. </div>
  395. <div>
  396. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  397. </div>
  398. <div>
  399. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  400. </div>
  401. <div>
  402. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  403. </div>
  404. <div>
  405. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AutoSize">View.AutoSize</a>
  406. </div>
  407. <div>
  408. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PreserveTrailingSpaces">View.PreserveTrailingSpaces</a>
  409. </div>
  410. <div>
  411. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">View.TextAlignment</a>
  412. </div>
  413. <div>
  414. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VerticalTextAlignment">View.VerticalTextAlignment</a>
  415. </div>
  416. <div>
  417. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextDirection">View.TextDirection</a>
  418. </div>
  419. <div>
  420. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsInitialized">View.IsInitialized</a>
  421. </div>
  422. <div>
  423. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsAdded">View.IsAdded</a>
  424. </div>
  425. <div>
  426. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enabled">View.Enabled</a>
  427. </div>
  428. <div>
  429. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Visible">View.Visible</a>
  430. </div>
  431. <div>
  432. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Border">View.Border</a>
  433. </div>
  434. <div>
  435. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Added">View.Added</a>
  436. </div>
  437. <div>
  438. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Removed">View.Removed</a>
  439. </div>
  440. <div>
  441. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  442. </div>
  443. <div>
  444. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  445. </div>
  446. <div>
  447. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  448. </div>
  449. <div>
  450. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  451. </div>
  452. <div>
  453. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  454. </div>
  455. <div>
  456. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocusChanged">View.CanFocusChanged</a>
  457. </div>
  458. <div>
  459. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnabledChanged">View.EnabledChanged</a>
  460. </div>
  461. <div>
  462. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VisibleChanged">View.VisibleChanged</a>
  463. </div>
  464. <div>
  465. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeyChanged">View.HotKeyChanged</a>
  466. </div>
  467. <div>
  468. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  469. </div>
  470. <div>
  471. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContentComplete">View.DrawContentComplete</a>
  472. </div>
  473. <div>
  474. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  475. </div>
  476. <div>
  477. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  478. </div>
  479. <div>
  480. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  481. </div>
  482. <div>
  483. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStarted">View.LayoutStarted</a>
  484. </div>
  485. <div>
  486. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  487. </div>
  488. <div>
  489. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Initialized">View.Initialized</a>
  490. </div>
  491. <div>
  492. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
  493. </div>
  494. </div>
  495. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  496. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  497. <h5 id="Terminal_Gui_TextField_syntax">Syntax</h5>
  498. <div class="codewrapper">
  499. <pre><code class="lang-csharp hljs">public class TextField : View</code></pre>
  500. </div>
  501. <h3 id="constructors">Constructors
  502. </h3>
  503. <a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
  504. <h4 id="Terminal_Gui_TextField__ctor" data-uid="Terminal.Gui.TextField.#ctor">TextField()</h4>
  505. <div class="markdown level1 summary">
  506. 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.
  507. </div>
  508. <div class="markdown level1 conceptual"></div>
  509. <h5 class="decalaration">Declaration</h5>
  510. <div class="codewrapper">
  511. <pre><code class="lang-csharp hljs">public TextField()</code></pre>
  512. </div>
  513. <a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
  514. <h4 id="Terminal_Gui_TextField__ctor_NStack_ustring_" data-uid="Terminal.Gui.TextField.#ctor(NStack.ustring)">TextField(ustring)</h4>
  515. <div class="markdown level1 summary">
  516. 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.
  517. </div>
  518. <div class="markdown level1 conceptual"></div>
  519. <h5 class="decalaration">Declaration</h5>
  520. <div class="codewrapper">
  521. <pre><code class="lang-csharp hljs">public TextField(ustring text)</code></pre>
  522. </div>
  523. <h5 class="parameters">Parameters</h5>
  524. <table class="table table-bordered table-striped table-condensed">
  525. <thead>
  526. <tr>
  527. <th>Type</th>
  528. <th>Name</th>
  529. <th>Description</th>
  530. </tr>
  531. </thead>
  532. <tbody>
  533. <tr>
  534. <td><span class="xref">NStack.ustring</span></td>
  535. <td><span class="parametername">text</span></td>
  536. <td>Initial text contents.</td>
  537. </tr>
  538. </tbody>
  539. </table>
  540. <a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
  541. <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>
  542. <div class="markdown level1 summary">
  543. 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.
  544. </div>
  545. <div class="markdown level1 conceptual"></div>
  546. <h5 class="decalaration">Declaration</h5>
  547. <div class="codewrapper">
  548. <pre><code class="lang-csharp hljs">public TextField(int x, int y, int w, ustring text)</code></pre>
  549. </div>
  550. <h5 class="parameters">Parameters</h5>
  551. <table class="table table-bordered table-striped table-condensed">
  552. <thead>
  553. <tr>
  554. <th>Type</th>
  555. <th>Name</th>
  556. <th>Description</th>
  557. </tr>
  558. </thead>
  559. <tbody>
  560. <tr>
  561. <td><span class="xref">System.Int32</span></td>
  562. <td><span class="parametername">x</span></td>
  563. <td>The x coordinate.</td>
  564. </tr>
  565. <tr>
  566. <td><span class="xref">System.Int32</span></td>
  567. <td><span class="parametername">y</span></td>
  568. <td>The y coordinate.</td>
  569. </tr>
  570. <tr>
  571. <td><span class="xref">System.Int32</span></td>
  572. <td><span class="parametername">w</span></td>
  573. <td>The width.</td>
  574. </tr>
  575. <tr>
  576. <td><span class="xref">NStack.ustring</span></td>
  577. <td><span class="parametername">text</span></td>
  578. <td>Initial text contents.</td>
  579. </tr>
  580. </tbody>
  581. </table>
  582. <a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
  583. <h4 id="Terminal_Gui_TextField__ctor_System_String_" data-uid="Terminal.Gui.TextField.#ctor(System.String)">TextField(String)</h4>
  584. <div class="markdown level1 summary">
  585. 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.
  586. </div>
  587. <div class="markdown level1 conceptual"></div>
  588. <h5 class="decalaration">Declaration</h5>
  589. <div class="codewrapper">
  590. <pre><code class="lang-csharp hljs">public TextField(string text)</code></pre>
  591. </div>
  592. <h5 class="parameters">Parameters</h5>
  593. <table class="table table-bordered table-striped table-condensed">
  594. <thead>
  595. <tr>
  596. <th>Type</th>
  597. <th>Name</th>
  598. <th>Description</th>
  599. </tr>
  600. </thead>
  601. <tbody>
  602. <tr>
  603. <td><span class="xref">System.String</span></td>
  604. <td><span class="parametername">text</span></td>
  605. <td>Initial text contents.</td>
  606. </tr>
  607. </tbody>
  608. </table>
  609. <h3 id="properties">Properties
  610. </h3>
  611. <a id="Terminal_Gui_TextField_Autocomplete_" data-uid="Terminal.Gui.TextField.Autocomplete*"></a>
  612. <h4 id="Terminal_Gui_TextField_Autocomplete" data-uid="Terminal.Gui.TextField.Autocomplete">Autocomplete</h4>
  613. <div class="markdown level1 summary">
  614. Provides autocomplete context menu based on suggestions at the current cursor
  615. position. Populate <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_AllSuggestions">AllSuggestions</a> to enable this feature.
  616. </div>
  617. <div class="markdown level1 conceptual"></div>
  618. <h5 class="decalaration">Declaration</h5>
  619. <div class="codewrapper">
  620. <pre><code class="lang-csharp hljs">public IAutocomplete Autocomplete { get; protected set; }</code></pre>
  621. </div>
  622. <h5 class="propertyValue">Property Value</h5>
  623. <table class="table table-bordered table-striped table-condensed">
  624. <thead>
  625. <tr>
  626. <th>Type</th>
  627. <th>Description</th>
  628. </tr>
  629. </thead>
  630. <tbody>
  631. <tr>
  632. <td><a class="xref" href="Terminal.Gui.IAutocomplete.html">IAutocomplete</a></td>
  633. <td></td>
  634. </tr>
  635. </tbody>
  636. </table>
  637. <a id="Terminal_Gui_TextField_CanFocus_" data-uid="Terminal.Gui.TextField.CanFocus*"></a>
  638. <h4 id="Terminal_Gui_TextField_CanFocus" data-uid="Terminal.Gui.TextField.CanFocus">CanFocus</h4>
  639. <div class="markdown level1 summary">
  640. Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.Responder.html">Responder</a> can focus.
  641. </div>
  642. <div class="markdown level1 conceptual"></div>
  643. <h5 class="decalaration">Declaration</h5>
  644. <div class="codewrapper">
  645. <pre><code class="lang-csharp hljs">public override bool CanFocus { get; set; }</code></pre>
  646. </div>
  647. <h5 class="propertyValue">Property Value</h5>
  648. <table class="table table-bordered table-striped table-condensed">
  649. <thead>
  650. <tr>
  651. <th>Type</th>
  652. <th>Description</th>
  653. </tr>
  654. </thead>
  655. <tbody>
  656. <tr>
  657. <td><span class="xref">System.Boolean</span></td>
  658. <td><code>true</code> if can focus; otherwise, <code>false</code>.</td>
  659. </tr>
  660. </tbody>
  661. </table>
  662. <h5 class="overrides">Overrides</h5>
  663. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocus">View.CanFocus</a></div>
  664. <a id="Terminal_Gui_TextField_ContextMenu_" data-uid="Terminal.Gui.TextField.ContextMenu*"></a>
  665. <h4 id="Terminal_Gui_TextField_ContextMenu" data-uid="Terminal.Gui.TextField.ContextMenu">ContextMenu</h4>
  666. <div class="markdown level1 summary">
  667. Get the <a class="xref" href="Terminal.Gui.TextField.html#Terminal_Gui_TextField_ContextMenu">ContextMenu</a> for this view.
  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 ContextMenu ContextMenu { get; }</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><a class="xref" href="Terminal.Gui.ContextMenu.html">ContextMenu</a></td>
  685. <td></td>
  686. </tr>
  687. </tbody>
  688. </table>
  689. <a id="Terminal_Gui_TextField_CursorPosition_" data-uid="Terminal.Gui.TextField.CursorPosition*"></a>
  690. <h4 id="Terminal_Gui_TextField_CursorPosition" data-uid="Terminal.Gui.TextField.CursorPosition">CursorPosition</h4>
  691. <div class="markdown level1 summary">
  692. Sets or gets the current cursor position.
  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 virtual int CursorPosition { 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_DesiredCursorVisibility_" data-uid="Terminal.Gui.TextField.DesiredCursorVisibility*"></a>
  715. <h4 id="Terminal_Gui_TextField_DesiredCursorVisibility" data-uid="Terminal.Gui.TextField.DesiredCursorVisibility">DesiredCursorVisibility</h4>
  716. <div class="markdown level1 summary">
  717. Get / Set the wished cursor when the field is focused
  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 CursorVisibility DesiredCursorVisibility { 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><a class="xref" href="Terminal.Gui.CursorVisibility.html">CursorVisibility</a></td>
  735. <td></td>
  736. </tr>
  737. </tbody>
  738. </table>
  739. <a id="Terminal_Gui_TextField_Frame_" data-uid="Terminal.Gui.TextField.Frame*"></a>
  740. <h4 id="Terminal_Gui_TextField_Frame" data-uid="Terminal.Gui.TextField.Frame">Frame</h4>
  741. <div class="markdown level1 summary">
  742. 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>).
  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 override Rect Frame { 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><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  760. <td>The frame.</td>
  761. </tr>
  762. </tbody>
  763. </table>
  764. <h5 class="overrides">Overrides</h5>
  765. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a></div>
  766. <a id="Terminal_Gui_TextField_HasHistoryChanges_" data-uid="Terminal.Gui.TextField.HasHistoryChanges*"></a>
  767. <h4 id="Terminal_Gui_TextField_HasHistoryChanges" data-uid="Terminal.Gui.TextField.HasHistoryChanges">HasHistoryChanges</h4>
  768. <div class="markdown level1 summary">
  769. Indicates whatever the text has history changes or not.
  770. <span class="xref">true</span> if the text has history changes <span class="xref">false</span> otherwise.
  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 HasHistoryChanges { get; }</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. <a id="Terminal_Gui_TextField_IsDirty_" data-uid="Terminal.Gui.TextField.IsDirty*"></a>
  793. <h4 id="Terminal_Gui_TextField_IsDirty" data-uid="Terminal.Gui.TextField.IsDirty">IsDirty</h4>
  794. <div class="markdown level1 summary">
  795. Indicates whatever the text was changed or not.
  796. <span class="xref">true</span> if the text was changed <span class="xref">false</span> otherwise.
  797. </div>
  798. <div class="markdown level1 conceptual"></div>
  799. <h5 class="decalaration">Declaration</h5>
  800. <div class="codewrapper">
  801. <pre><code class="lang-csharp hljs">public bool IsDirty { get; }</code></pre>
  802. </div>
  803. <h5 class="propertyValue">Property Value</h5>
  804. <table class="table table-bordered table-striped table-condensed">
  805. <thead>
  806. <tr>
  807. <th>Type</th>
  808. <th>Description</th>
  809. </tr>
  810. </thead>
  811. <tbody>
  812. <tr>
  813. <td><span class="xref">System.Boolean</span></td>
  814. <td></td>
  815. </tr>
  816. </tbody>
  817. </table>
  818. <a id="Terminal_Gui_TextField_ReadOnly_" data-uid="Terminal.Gui.TextField.ReadOnly*"></a>
  819. <h4 id="Terminal_Gui_TextField_ReadOnly" data-uid="Terminal.Gui.TextField.ReadOnly">ReadOnly</h4>
  820. <div class="markdown level1 summary">
  821. If set to true its not allow any changes in the text.
  822. </div>
  823. <div class="markdown level1 conceptual"></div>
  824. <h5 class="decalaration">Declaration</h5>
  825. <div class="codewrapper">
  826. <pre><code class="lang-csharp hljs">public bool ReadOnly { get; set; }</code></pre>
  827. </div>
  828. <h5 class="propertyValue">Property Value</h5>
  829. <table class="table table-bordered table-striped table-condensed">
  830. <thead>
  831. <tr>
  832. <th>Type</th>
  833. <th>Description</th>
  834. </tr>
  835. </thead>
  836. <tbody>
  837. <tr>
  838. <td><span class="xref">System.Boolean</span></td>
  839. <td></td>
  840. </tr>
  841. </tbody>
  842. </table>
  843. <a id="Terminal_Gui_TextField_ScrollOffset_" data-uid="Terminal.Gui.TextField.ScrollOffset*"></a>
  844. <h4 id="Terminal_Gui_TextField_ScrollOffset" data-uid="Terminal.Gui.TextField.ScrollOffset">ScrollOffset</h4>
  845. <div class="markdown level1 summary">
  846. Gets the left offset position.
  847. </div>
  848. <div class="markdown level1 conceptual"></div>
  849. <h5 class="decalaration">Declaration</h5>
  850. <div class="codewrapper">
  851. <pre><code class="lang-csharp hljs">public int ScrollOffset { get; }</code></pre>
  852. </div>
  853. <h5 class="propertyValue">Property Value</h5>
  854. <table class="table table-bordered table-striped table-condensed">
  855. <thead>
  856. <tr>
  857. <th>Type</th>
  858. <th>Description</th>
  859. </tr>
  860. </thead>
  861. <tbody>
  862. <tr>
  863. <td><span class="xref">System.Int32</span></td>
  864. <td></td>
  865. </tr>
  866. </tbody>
  867. </table>
  868. <a id="Terminal_Gui_TextField_Secret_" data-uid="Terminal.Gui.TextField.Secret*"></a>
  869. <h4 id="Terminal_Gui_TextField_Secret" data-uid="Terminal.Gui.TextField.Secret">Secret</h4>
  870. <div class="markdown level1 summary">
  871. Sets the secret property.
  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 bool Secret { get; set; }</code></pre>
  877. </div>
  878. <h5 class="propertyValue">Property Value</h5>
  879. <table class="table table-bordered table-striped table-condensed">
  880. <thead>
  881. <tr>
  882. <th>Type</th>
  883. <th>Description</th>
  884. </tr>
  885. </thead>
  886. <tbody>
  887. <tr>
  888. <td><span class="xref">System.Boolean</span></td>
  889. <td></td>
  890. </tr>
  891. </tbody>
  892. </table>
  893. <a id="Terminal_Gui_TextField_SelectedLength_" data-uid="Terminal.Gui.TextField.SelectedLength*"></a>
  894. <h4 id="Terminal_Gui_TextField_SelectedLength" data-uid="Terminal.Gui.TextField.SelectedLength">SelectedLength</h4>
  895. <div class="markdown level1 summary">
  896. Length of the selected text.
  897. </div>
  898. <div class="markdown level1 conceptual"></div>
  899. <h5 class="decalaration">Declaration</h5>
  900. <div class="codewrapper">
  901. <pre><code class="lang-csharp hljs">public int SelectedLength { get; }</code></pre>
  902. </div>
  903. <h5 class="propertyValue">Property Value</h5>
  904. <table class="table table-bordered table-striped table-condensed">
  905. <thead>
  906. <tr>
  907. <th>Type</th>
  908. <th>Description</th>
  909. </tr>
  910. </thead>
  911. <tbody>
  912. <tr>
  913. <td><span class="xref">System.Int32</span></td>
  914. <td></td>
  915. </tr>
  916. </tbody>
  917. </table>
  918. <a id="Terminal_Gui_TextField_SelectedStart_" data-uid="Terminal.Gui.TextField.SelectedStart*"></a>
  919. <h4 id="Terminal_Gui_TextField_SelectedStart" data-uid="Terminal.Gui.TextField.SelectedStart">SelectedStart</h4>
  920. <div class="markdown level1 summary">
  921. Start position of the selected text.
  922. </div>
  923. <div class="markdown level1 conceptual"></div>
  924. <h5 class="decalaration">Declaration</h5>
  925. <div class="codewrapper">
  926. <pre><code class="lang-csharp hljs">public int SelectedStart { get; set; }</code></pre>
  927. </div>
  928. <h5 class="propertyValue">Property Value</h5>
  929. <table class="table table-bordered table-striped table-condensed">
  930. <thead>
  931. <tr>
  932. <th>Type</th>
  933. <th>Description</th>
  934. </tr>
  935. </thead>
  936. <tbody>
  937. <tr>
  938. <td><span class="xref">System.Int32</span></td>
  939. <td></td>
  940. </tr>
  941. </tbody>
  942. </table>
  943. <a id="Terminal_Gui_TextField_SelectedText_" data-uid="Terminal.Gui.TextField.SelectedText*"></a>
  944. <h4 id="Terminal_Gui_TextField_SelectedText" data-uid="Terminal.Gui.TextField.SelectedText">SelectedText</h4>
  945. <div class="markdown level1 summary">
  946. The selected text.
  947. </div>
  948. <div class="markdown level1 conceptual"></div>
  949. <h5 class="decalaration">Declaration</h5>
  950. <div class="codewrapper">
  951. <pre><code class="lang-csharp hljs">public ustring SelectedText { get; }</code></pre>
  952. </div>
  953. <h5 class="propertyValue">Property Value</h5>
  954. <table class="table table-bordered table-striped table-condensed">
  955. <thead>
  956. <tr>
  957. <th>Type</th>
  958. <th>Description</th>
  959. </tr>
  960. </thead>
  961. <tbody>
  962. <tr>
  963. <td><span class="xref">NStack.ustring</span></td>
  964. <td></td>
  965. </tr>
  966. </tbody>
  967. </table>
  968. <a id="Terminal_Gui_TextField_Text_" data-uid="Terminal.Gui.TextField.Text*"></a>
  969. <h4 id="Terminal_Gui_TextField_Text" data-uid="Terminal.Gui.TextField.Text">Text</h4>
  970. <div class="markdown level1 summary">
  971. Sets or gets the text held by the view.
  972. </div>
  973. <div class="markdown level1 conceptual"></div>
  974. <h5 class="decalaration">Declaration</h5>
  975. <div class="codewrapper">
  976. <pre><code class="lang-csharp hljs">public ustring Text { get; set; }</code></pre>
  977. </div>
  978. <h5 class="propertyValue">Property Value</h5>
  979. <table class="table table-bordered table-striped table-condensed">
  980. <thead>
  981. <tr>
  982. <th>Type</th>
  983. <th>Description</th>
  984. </tr>
  985. </thead>
  986. <tbody>
  987. <tr>
  988. <td><span class="xref">NStack.ustring</span></td>
  989. <td></td>
  990. </tr>
  991. </tbody>
  992. </table>
  993. <a id="Terminal_Gui_TextField_Used_" data-uid="Terminal.Gui.TextField.Used*"></a>
  994. <h4 id="Terminal_Gui_TextField_Used" data-uid="Terminal.Gui.TextField.Used">Used</h4>
  995. <div class="markdown level1 summary">
  996. 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
  997. </div>
  998. <div class="markdown level1 conceptual"></div>
  999. <h5 class="decalaration">Declaration</h5>
  1000. <div class="codewrapper">
  1001. <pre><code class="lang-csharp hljs">public bool Used { get; set; }</code></pre>
  1002. </div>
  1003. <h5 class="propertyValue">Property Value</h5>
  1004. <table class="table table-bordered table-striped table-condensed">
  1005. <thead>
  1006. <tr>
  1007. <th>Type</th>
  1008. <th>Description</th>
  1009. </tr>
  1010. </thead>
  1011. <tbody>
  1012. <tr>
  1013. <td><span class="xref">System.Boolean</span></td>
  1014. <td></td>
  1015. </tr>
  1016. </tbody>
  1017. </table>
  1018. <h3 id="methods">Methods
  1019. </h3>
  1020. <a id="Terminal_Gui_TextField_ClearAllSelection_" data-uid="Terminal.Gui.TextField.ClearAllSelection*"></a>
  1021. <h4 id="Terminal_Gui_TextField_ClearAllSelection" data-uid="Terminal.Gui.TextField.ClearAllSelection">ClearAllSelection()</h4>
  1022. <div class="markdown level1 summary">
  1023. Clear the selected text.
  1024. </div>
  1025. <div class="markdown level1 conceptual"></div>
  1026. <h5 class="decalaration">Declaration</h5>
  1027. <div class="codewrapper">
  1028. <pre><code class="lang-csharp hljs">public void ClearAllSelection()</code></pre>
  1029. </div>
  1030. <a id="Terminal_Gui_TextField_ClearHistoryChanges_" data-uid="Terminal.Gui.TextField.ClearHistoryChanges*"></a>
  1031. <h4 id="Terminal_Gui_TextField_ClearHistoryChanges" data-uid="Terminal.Gui.TextField.ClearHistoryChanges">ClearHistoryChanges()</h4>
  1032. <div class="markdown level1 summary">
  1033. Allows clearing the <span class="xref">Terminal.Gui.HistoryText.HistoryTextItem</span> items updating the original text.
  1034. </div>
  1035. <div class="markdown level1 conceptual"></div>
  1036. <h5 class="decalaration">Declaration</h5>
  1037. <div class="codewrapper">
  1038. <pre><code class="lang-csharp hljs">public void ClearHistoryChanges()</code></pre>
  1039. </div>
  1040. <a id="Terminal_Gui_TextField_Copy_" data-uid="Terminal.Gui.TextField.Copy*"></a>
  1041. <h4 id="Terminal_Gui_TextField_Copy" data-uid="Terminal.Gui.TextField.Copy">Copy()</h4>
  1042. <div class="markdown level1 summary">
  1043. Copy the selected text to the clipboard.
  1044. </div>
  1045. <div class="markdown level1 conceptual"></div>
  1046. <h5 class="decalaration">Declaration</h5>
  1047. <div class="codewrapper">
  1048. <pre><code class="lang-csharp hljs">public virtual void Copy()</code></pre>
  1049. </div>
  1050. <a id="Terminal_Gui_TextField_Cut_" data-uid="Terminal.Gui.TextField.Cut*"></a>
  1051. <h4 id="Terminal_Gui_TextField_Cut" data-uid="Terminal.Gui.TextField.Cut">Cut()</h4>
  1052. <div class="markdown level1 summary">
  1053. Cut the selected text to the clipboard.
  1054. </div>
  1055. <div class="markdown level1 conceptual"></div>
  1056. <h5 class="decalaration">Declaration</h5>
  1057. <div class="codewrapper">
  1058. <pre><code class="lang-csharp hljs">public virtual void Cut()</code></pre>
  1059. </div>
  1060. <a id="Terminal_Gui_TextField_DeleteAll_" data-uid="Terminal.Gui.TextField.DeleteAll*"></a>
  1061. <h4 id="Terminal_Gui_TextField_DeleteAll" data-uid="Terminal.Gui.TextField.DeleteAll">DeleteAll()</h4>
  1062. <div class="markdown level1 summary">
  1063. Deletes all text.
  1064. </div>
  1065. <div class="markdown level1 conceptual"></div>
  1066. <h5 class="decalaration">Declaration</h5>
  1067. <div class="codewrapper">
  1068. <pre><code class="lang-csharp hljs">public void DeleteAll()</code></pre>
  1069. </div>
  1070. <a id="Terminal_Gui_TextField_DeleteCharLeft_" data-uid="Terminal.Gui.TextField.DeleteCharLeft*"></a>
  1071. <h4 id="Terminal_Gui_TextField_DeleteCharLeft_System_Boolean_" data-uid="Terminal.Gui.TextField.DeleteCharLeft(System.Boolean)">DeleteCharLeft(Boolean)</h4>
  1072. <div class="markdown level1 summary">
  1073. Deletes the left character.
  1074. </div>
  1075. <div class="markdown level1 conceptual"></div>
  1076. <h5 class="decalaration">Declaration</h5>
  1077. <div class="codewrapper">
  1078. <pre><code class="lang-csharp hljs">public virtual void DeleteCharLeft(bool useOldCursorPos = true)</code></pre>
  1079. </div>
  1080. <h5 class="parameters">Parameters</h5>
  1081. <table class="table table-bordered table-striped table-condensed">
  1082. <thead>
  1083. <tr>
  1084. <th>Type</th>
  1085. <th>Name</th>
  1086. <th>Description</th>
  1087. </tr>
  1088. </thead>
  1089. <tbody>
  1090. <tr>
  1091. <td><span class="xref">System.Boolean</span></td>
  1092. <td><span class="parametername">useOldCursorPos</span></td>
  1093. <td></td>
  1094. </tr>
  1095. </tbody>
  1096. </table>
  1097. <a id="Terminal_Gui_TextField_DeleteCharRight_" data-uid="Terminal.Gui.TextField.DeleteCharRight*"></a>
  1098. <h4 id="Terminal_Gui_TextField_DeleteCharRight" data-uid="Terminal.Gui.TextField.DeleteCharRight">DeleteCharRight()</h4>
  1099. <div class="markdown level1 summary">
  1100. Deletes the right character.
  1101. </div>
  1102. <div class="markdown level1 conceptual"></div>
  1103. <h5 class="decalaration">Declaration</h5>
  1104. <div class="codewrapper">
  1105. <pre><code class="lang-csharp hljs">public virtual void DeleteCharRight()</code></pre>
  1106. </div>
  1107. <a id="Terminal_Gui_TextField_InsertText_" data-uid="Terminal.Gui.TextField.InsertText*"></a>
  1108. <h4 id="Terminal_Gui_TextField_InsertText_System_String_System_Boolean_" data-uid="Terminal.Gui.TextField.InsertText(System.String,System.Boolean)">InsertText(String, Boolean)</h4>
  1109. <div class="markdown level1 summary">
  1110. Inserts the given <code data-dev-comment-type="paramref" class="paramref">toAdd</code> text at the current cursor position
  1111. exactly as if the user had just typed it
  1112. </div>
  1113. <div class="markdown level1 conceptual"></div>
  1114. <h5 class="decalaration">Declaration</h5>
  1115. <div class="codewrapper">
  1116. <pre><code class="lang-csharp hljs">public void InsertText(string toAdd, bool useOldCursorPos = true)</code></pre>
  1117. </div>
  1118. <h5 class="parameters">Parameters</h5>
  1119. <table class="table table-bordered table-striped table-condensed">
  1120. <thead>
  1121. <tr>
  1122. <th>Type</th>
  1123. <th>Name</th>
  1124. <th>Description</th>
  1125. </tr>
  1126. </thead>
  1127. <tbody>
  1128. <tr>
  1129. <td><span class="xref">System.String</span></td>
  1130. <td><span class="parametername">toAdd</span></td>
  1131. <td>Text to add</td>
  1132. </tr>
  1133. <tr>
  1134. <td><span class="xref">System.Boolean</span></td>
  1135. <td><span class="parametername">useOldCursorPos</span></td>
  1136. <td>If uses the <span class="xref">Terminal.Gui.TextField.oldCursorPos</span>.</td>
  1137. </tr>
  1138. </tbody>
  1139. </table>
  1140. <a id="Terminal_Gui_TextField_KillWordBackwards_" data-uid="Terminal.Gui.TextField.KillWordBackwards*"></a>
  1141. <h4 id="Terminal_Gui_TextField_KillWordBackwards" data-uid="Terminal.Gui.TextField.KillWordBackwards">KillWordBackwards()</h4>
  1142. <div class="markdown level1 summary">
  1143. Deletes word backwards.
  1144. </div>
  1145. <div class="markdown level1 conceptual"></div>
  1146. <h5 class="decalaration">Declaration</h5>
  1147. <div class="codewrapper">
  1148. <pre><code class="lang-csharp hljs">public virtual void KillWordBackwards()</code></pre>
  1149. </div>
  1150. <a id="Terminal_Gui_TextField_KillWordForwards_" data-uid="Terminal.Gui.TextField.KillWordForwards*"></a>
  1151. <h4 id="Terminal_Gui_TextField_KillWordForwards" data-uid="Terminal.Gui.TextField.KillWordForwards">KillWordForwards()</h4>
  1152. <div class="markdown level1 summary">
  1153. Deletes word forwards.
  1154. </div>
  1155. <div class="markdown level1 conceptual"></div>
  1156. <h5 class="decalaration">Declaration</h5>
  1157. <div class="codewrapper">
  1158. <pre><code class="lang-csharp hljs">public virtual void KillWordForwards()</code></pre>
  1159. </div>
  1160. <a id="Terminal_Gui_TextField_MouseEvent_" data-uid="Terminal.Gui.TextField.MouseEvent*"></a>
  1161. <h4 id="Terminal_Gui_TextField_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.TextField.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  1162. <div class="markdown level1 summary">
  1163. Method invoked when a mouse event is generated
  1164. </div>
  1165. <div class="markdown level1 conceptual"></div>
  1166. <h5 class="decalaration">Declaration</h5>
  1167. <div class="codewrapper">
  1168. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent ev)</code></pre>
  1169. </div>
  1170. <h5 class="parameters">Parameters</h5>
  1171. <table class="table table-bordered table-striped table-condensed">
  1172. <thead>
  1173. <tr>
  1174. <th>Type</th>
  1175. <th>Name</th>
  1176. <th>Description</th>
  1177. </tr>
  1178. </thead>
  1179. <tbody>
  1180. <tr>
  1181. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  1182. <td><span class="parametername">ev</span></td>
  1183. <td></td>
  1184. </tr>
  1185. </tbody>
  1186. </table>
  1187. <h5 class="returns">Returns</h5>
  1188. <table class="table table-bordered table-striped table-condensed">
  1189. <thead>
  1190. <tr>
  1191. <th>Type</th>
  1192. <th>Description</th>
  1193. </tr>
  1194. </thead>
  1195. <tbody>
  1196. <tr>
  1197. <td><span class="xref">System.Boolean</span></td>
  1198. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  1199. </tr>
  1200. </tbody>
  1201. </table>
  1202. <h5 class="overrides">Overrides</h5>
  1203. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  1204. <a id="Terminal_Gui_TextField_OnEnter_" data-uid="Terminal.Gui.TextField.OnEnter*"></a>
  1205. <h4 id="Terminal_Gui_TextField_OnEnter_Terminal_Gui_View_" data-uid="Terminal.Gui.TextField.OnEnter(Terminal.Gui.View)">OnEnter(View)</h4>
  1206. <div class="markdown level1 summary">
  1207. Method invoked when a view gets focus.
  1208. </div>
  1209. <div class="markdown level1 conceptual"></div>
  1210. <h5 class="decalaration">Declaration</h5>
  1211. <div class="codewrapper">
  1212. <pre><code class="lang-csharp hljs">public override bool OnEnter(View view)</code></pre>
  1213. </div>
  1214. <h5 class="parameters">Parameters</h5>
  1215. <table class="table table-bordered table-striped table-condensed">
  1216. <thead>
  1217. <tr>
  1218. <th>Type</th>
  1219. <th>Name</th>
  1220. <th>Description</th>
  1221. </tr>
  1222. </thead>
  1223. <tbody>
  1224. <tr>
  1225. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  1226. <td><span class="parametername">view</span></td>
  1227. <td>The view that is losing focus.</td>
  1228. </tr>
  1229. </tbody>
  1230. </table>
  1231. <h5 class="returns">Returns</h5>
  1232. <table class="table table-bordered table-striped table-condensed">
  1233. <thead>
  1234. <tr>
  1235. <th>Type</th>
  1236. <th>Description</th>
  1237. </tr>
  1238. </thead>
  1239. <tbody>
  1240. <tr>
  1241. <td><span class="xref">System.Boolean</span></td>
  1242. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  1243. </tr>
  1244. </tbody>
  1245. </table>
  1246. <h5 class="overrides">Overrides</h5>
  1247. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter_Terminal_Gui_View_">View.OnEnter(View)</a></div>
  1248. <a id="Terminal_Gui_TextField_OnLeave_" data-uid="Terminal.Gui.TextField.OnLeave*"></a>
  1249. <h4 id="Terminal_Gui_TextField_OnLeave_Terminal_Gui_View_" data-uid="Terminal.Gui.TextField.OnLeave(Terminal.Gui.View)">OnLeave(View)</h4>
  1250. <div class="markdown level1 summary">
  1251. Method invoked when a view loses focus.
  1252. </div>
  1253. <div class="markdown level1 conceptual"></div>
  1254. <h5 class="decalaration">Declaration</h5>
  1255. <div class="codewrapper">
  1256. <pre><code class="lang-csharp hljs">public override bool OnLeave(View view)</code></pre>
  1257. </div>
  1258. <h5 class="parameters">Parameters</h5>
  1259. <table class="table table-bordered table-striped table-condensed">
  1260. <thead>
  1261. <tr>
  1262. <th>Type</th>
  1263. <th>Name</th>
  1264. <th>Description</th>
  1265. </tr>
  1266. </thead>
  1267. <tbody>
  1268. <tr>
  1269. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  1270. <td><span class="parametername">view</span></td>
  1271. <td>The view that is getting focus.</td>
  1272. </tr>
  1273. </tbody>
  1274. </table>
  1275. <h5 class="returns">Returns</h5>
  1276. <table class="table table-bordered table-striped table-condensed">
  1277. <thead>
  1278. <tr>
  1279. <th>Type</th>
  1280. <th>Description</th>
  1281. </tr>
  1282. </thead>
  1283. <tbody>
  1284. <tr>
  1285. <td><span class="xref">System.Boolean</span></td>
  1286. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  1287. </tr>
  1288. </tbody>
  1289. </table>
  1290. <h5 class="overrides">Overrides</h5>
  1291. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave_Terminal_Gui_View_">View.OnLeave(View)</a></div>
  1292. <a id="Terminal_Gui_TextField_OnTextChanging_" data-uid="Terminal.Gui.TextField.OnTextChanging*"></a>
  1293. <h4 id="Terminal_Gui_TextField_OnTextChanging_NStack_ustring_" data-uid="Terminal.Gui.TextField.OnTextChanging(NStack.ustring)">OnTextChanging(ustring)</h4>
  1294. <div class="markdown level1 summary">
  1295. 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.
  1296. </div>
  1297. <div class="markdown level1 conceptual"></div>
  1298. <h5 class="decalaration">Declaration</h5>
  1299. <div class="codewrapper">
  1300. <pre><code class="lang-csharp hljs">public virtual TextChangingEventArgs OnTextChanging(ustring newText)</code></pre>
  1301. </div>
  1302. <h5 class="parameters">Parameters</h5>
  1303. <table class="table table-bordered table-striped table-condensed">
  1304. <thead>
  1305. <tr>
  1306. <th>Type</th>
  1307. <th>Name</th>
  1308. <th>Description</th>
  1309. </tr>
  1310. </thead>
  1311. <tbody>
  1312. <tr>
  1313. <td><span class="xref">NStack.ustring</span></td>
  1314. <td><span class="parametername">newText</span></td>
  1315. <td>The new text to be replaced.</td>
  1316. </tr>
  1317. </tbody>
  1318. </table>
  1319. <h5 class="returns">Returns</h5>
  1320. <table class="table table-bordered table-striped table-condensed">
  1321. <thead>
  1322. <tr>
  1323. <th>Type</th>
  1324. <th>Description</th>
  1325. </tr>
  1326. </thead>
  1327. <tbody>
  1328. <tr>
  1329. <td><a class="xref" href="Terminal.Gui.TextChangingEventArgs.html">TextChangingEventArgs</a></td>
  1330. <td>Returns the <a class="xref" href="Terminal.Gui.TextChangingEventArgs.html">TextChangingEventArgs</a></td>
  1331. </tr>
  1332. </tbody>
  1333. </table>
  1334. <a id="Terminal_Gui_TextField_Paste_" data-uid="Terminal.Gui.TextField.Paste*"></a>
  1335. <h4 id="Terminal_Gui_TextField_Paste" data-uid="Terminal.Gui.TextField.Paste">Paste()</h4>
  1336. <div class="markdown level1 summary">
  1337. Paste the selected text from the clipboard.
  1338. </div>
  1339. <div class="markdown level1 conceptual"></div>
  1340. <h5 class="decalaration">Declaration</h5>
  1341. <div class="codewrapper">
  1342. <pre><code class="lang-csharp hljs">public virtual void Paste()</code></pre>
  1343. </div>
  1344. <a id="Terminal_Gui_TextField_PositionCursor_" data-uid="Terminal.Gui.TextField.PositionCursor*"></a>
  1345. <h4 id="Terminal_Gui_TextField_PositionCursor" data-uid="Terminal.Gui.TextField.PositionCursor">PositionCursor()</h4>
  1346. <div class="markdown level1 summary">
  1347. Sets the cursor position.
  1348. </div>
  1349. <div class="markdown level1 conceptual"></div>
  1350. <h5 class="decalaration">Declaration</h5>
  1351. <div class="codewrapper">
  1352. <pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
  1353. </div>
  1354. <h5 class="overrides">Overrides</h5>
  1355. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
  1356. <a id="Terminal_Gui_TextField_ProcessKey_" data-uid="Terminal.Gui.TextField.ProcessKey*"></a>
  1357. <h4 id="Terminal_Gui_TextField_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.TextField.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  1358. <div class="markdown level1 summary">
  1359. Processes key presses for the <a class="xref" href="Terminal.Gui.TextField.html">TextField</a>.
  1360. </div>
  1361. <div class="markdown level1 conceptual"></div>
  1362. <h5 class="decalaration">Declaration</h5>
  1363. <div class="codewrapper">
  1364. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent kb)</code></pre>
  1365. </div>
  1366. <h5 class="parameters">Parameters</h5>
  1367. <table class="table table-bordered table-striped table-condensed">
  1368. <thead>
  1369. <tr>
  1370. <th>Type</th>
  1371. <th>Name</th>
  1372. <th>Description</th>
  1373. </tr>
  1374. </thead>
  1375. <tbody>
  1376. <tr>
  1377. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  1378. <td><span class="parametername">kb</span></td>
  1379. <td></td>
  1380. </tr>
  1381. </tbody>
  1382. </table>
  1383. <h5 class="returns">Returns</h5>
  1384. <table class="table table-bordered table-striped table-condensed">
  1385. <thead>
  1386. <tr>
  1387. <th>Type</th>
  1388. <th>Description</th>
  1389. </tr>
  1390. </thead>
  1391. <tbody>
  1392. <tr>
  1393. <td><span class="xref">System.Boolean</span></td>
  1394. <td></td>
  1395. </tr>
  1396. </tbody>
  1397. </table>
  1398. <h5 class="overrides">Overrides</h5>
  1399. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  1400. <a id="Terminal_Gui_TextField_Redraw_" data-uid="Terminal.Gui.TextField.Redraw*"></a>
  1401. <h4 id="Terminal_Gui_TextField_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.TextField.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  1402. <div class="markdown level1 summary">
  1403. Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
  1404. </div>
  1405. <div class="markdown level1 conceptual"></div>
  1406. <h5 class="decalaration">Declaration</h5>
  1407. <div class="codewrapper">
  1408. <pre><code class="lang-csharp hljs">public override void Redraw(Rect bounds)</code></pre>
  1409. </div>
  1410. <h5 class="parameters">Parameters</h5>
  1411. <table class="table table-bordered table-striped table-condensed">
  1412. <thead>
  1413. <tr>
  1414. <th>Type</th>
  1415. <th>Name</th>
  1416. <th>Description</th>
  1417. </tr>
  1418. </thead>
  1419. <tbody>
  1420. <tr>
  1421. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1422. <td><span class="parametername">bounds</span></td>
  1423. <td>The bounds (view-relative region) to redraw.</td>
  1424. </tr>
  1425. </tbody>
  1426. </table>
  1427. <h5 class="overrides">Overrides</h5>
  1428. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  1429. <a id="Terminal_Gui_TextField_SelectAll_" data-uid="Terminal.Gui.TextField.SelectAll*"></a>
  1430. <h4 id="Terminal_Gui_TextField_SelectAll" data-uid="Terminal.Gui.TextField.SelectAll">SelectAll()</h4>
  1431. <div class="markdown level1 summary">
  1432. Selects all text.
  1433. </div>
  1434. <div class="markdown level1 conceptual"></div>
  1435. <h5 class="decalaration">Declaration</h5>
  1436. <div class="codewrapper">
  1437. <pre><code class="lang-csharp hljs">public void SelectAll()</code></pre>
  1438. </div>
  1439. <h3 id="events">Events
  1440. </h3>
  1441. <h4 id="Terminal_Gui_TextField_TextChanged" data-uid="Terminal.Gui.TextField.TextChanged">TextChanged</h4>
  1442. <div class="markdown level1 summary">
  1443. Changed event, raised when the text has changed.
  1444. </div>
  1445. <div class="markdown level1 conceptual"></div>
  1446. <h5 class="decalaration">Declaration</h5>
  1447. <div class="codewrapper">
  1448. <pre><code class="lang-csharp hljs">public event Action&lt;ustring&gt; TextChanged</code></pre>
  1449. </div>
  1450. <h5 class="eventType">Event Type</h5>
  1451. <table class="table table-bordered table-striped table-condensed">
  1452. <thead>
  1453. <tr>
  1454. <th>Type</th>
  1455. <th>Description</th>
  1456. </tr>
  1457. </thead>
  1458. <tbody>
  1459. <tr>
  1460. <td><span class="xref">System.Action</span>&lt;<span class="xref">NStack.ustring</span>&gt;</td>
  1461. <td></td>
  1462. </tr>
  1463. </tbody>
  1464. </table>
  1465. <h4 id="Terminal_Gui_TextField_TextChanging" data-uid="Terminal.Gui.TextField.TextChanging">TextChanging</h4>
  1466. <div class="markdown level1 summary">
  1467. 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.
  1468. </div>
  1469. <div class="markdown level1 conceptual"></div>
  1470. <h5 class="decalaration">Declaration</h5>
  1471. <div class="codewrapper">
  1472. <pre><code class="lang-csharp hljs">public event Action&lt;TextChangingEventArgs&gt; TextChanging</code></pre>
  1473. </div>
  1474. <h5 class="eventType">Event Type</h5>
  1475. <table class="table table-bordered table-striped table-condensed">
  1476. <thead>
  1477. <tr>
  1478. <th>Type</th>
  1479. <th>Description</th>
  1480. </tr>
  1481. </thead>
  1482. <tbody>
  1483. <tr>
  1484. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.TextChangingEventArgs.html">TextChangingEventArgs</a>&gt;</td>
  1485. <td></td>
  1486. </tr>
  1487. </tbody>
  1488. </table>
  1489. <h3 id="implements">Implements</h3>
  1490. <div>
  1491. <span class="xref">System.IDisposable</span>
  1492. </div>
  1493. <div>
  1494. <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
  1495. </div>
  1496. <div>
  1497. <span class="xref">System.ComponentModel.ISupportInitialize</span>
  1498. </div>
  1499. </article>
  1500. </div>
  1501. <div class="hidden-sm col-md-2" role="complementary">
  1502. <div class="sideaffix">
  1503. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  1504. <h5>In This Article</h5>
  1505. <div></div>
  1506. </nav>
  1507. </div>
  1508. </div>
  1509. </div>
  1510. </div>
  1511. <footer>
  1512. <div class="grad-bottom"></div>
  1513. <div class="footer">
  1514. <div class="container">
  1515. <span class="pull-right">
  1516. <a href="#top">Back to top</a>
  1517. </span>
  1518. <span>Generated by <strong>DocFX</strong></span>
  1519. </div>
  1520. </div>
  1521. </footer>
  1522. </div>
  1523. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  1524. <script type="text/javascript" src="../../styles/docfx.js"></script>
  1525. <script type="text/javascript" src="../../styles/main.js"></script>
  1526. </body>
  1527. </html>