Terminal.Gui.TextField.html 63 KB

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