Terminal.Gui.TextField.html 89 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845
  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.4.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_Added">View.Added</a>
  103. </div>
  104. <div>
  105. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Removed">View.Removed</a>
  106. </div>
  107. <div>
  108. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  109. </div>
  110. <div>
  111. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  112. </div>
  113. <div>
  114. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  115. </div>
  116. <div>
  117. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  118. </div>
  119. <div>
  120. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  121. </div>
  122. <div>
  123. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocusChanged">View.CanFocusChanged</a>
  124. </div>
  125. <div>
  126. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnabledChanged">View.EnabledChanged</a>
  127. </div>
  128. <div>
  129. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VisibleChanged">View.VisibleChanged</a>
  130. </div>
  131. <div>
  132. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeyChanged">View.HotKeyChanged</a>
  133. </div>
  134. <div>
  135. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKey">View.HotKey</a>
  136. </div>
  137. <div>
  138. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">View.HotKeySpecifier</a>
  139. </div>
  140. <div>
  141. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Shortcut">View.Shortcut</a>
  142. </div>
  143. <div>
  144. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutTag">View.ShortcutTag</a>
  145. </div>
  146. <div>
  147. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutAction">View.ShortcutAction</a>
  148. </div>
  149. <div>
  150. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Data">View.Data</a>
  151. </div>
  152. <div>
  153. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  154. </div>
  155. <div>
  156. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  157. </div>
  158. <div>
  159. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">View.TabIndexes</a>
  160. </div>
  161. <div>
  162. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndex">View.TabIndex</a>
  163. </div>
  164. <div>
  165. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabStop">View.TabStop</a>
  166. </div>
  167. <div>
  168. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  169. </div>
  170. <div>
  171. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  172. </div>
  173. <div>
  174. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  175. </div>
  176. <div>
  177. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  178. </div>
  179. <div>
  180. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  181. </div>
  182. <div>
  183. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  184. </div>
  185. <div>
  186. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  187. </div>
  188. <div>
  189. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  190. </div>
  191. <div>
  192. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  193. </div>
  194. <div>
  195. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  196. </div>
  197. <div>
  198. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ForceValidatePosDim">View.ForceValidatePosDim</a>
  199. </div>
  200. <div>
  201. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetMinWidthHeight_Terminal_Gui_Size__">View.GetMinWidthHeight(Size)</a>
  202. </div>
  203. <div>
  204. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetMinWidthHeight">View.SetMinWidthHeight()</a>
  205. </div>
  206. <div>
  207. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextFormatter">View.TextFormatter</a>
  208. </div>
  209. <div>
  210. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  211. </div>
  212. <div>
  213. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_UpdateTextFormatterText">View.UpdateTextFormatterText()</a>
  214. </div>
  215. <div>
  216. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessResizeView">View.ProcessResizeView()</a>
  217. </div>
  218. <div>
  219. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  220. </div>
  221. <div>
  222. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearLayoutNeeded">View.ClearLayoutNeeded()</a>
  223. </div>
  224. <div>
  225. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  226. </div>
  227. <div>
  228. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetChildNeedsDisplay">View.SetChildNeedsDisplay()</a>
  229. </div>
  230. <div>
  231. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  232. </div>
  233. <div>
  234. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  235. </div>
  236. <div>
  237. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  238. </div>
  239. <div>
  240. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  241. </div>
  242. <div>
  243. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  244. </div>
  245. <div>
  246. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  247. </div>
  248. <div>
  249. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  250. </div>
  251. <div>
  252. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  253. </div>
  254. <div>
  255. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  256. </div>
  257. <div>
  258. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  259. </div>
  260. <div>
  261. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  262. </div>
  263. <div>
  264. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  265. </div>
  266. <div>
  267. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  268. </div>
  269. <div>
  270. <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>
  271. </div>
  272. <div>
  273. <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>
  274. </div>
  275. <div>
  276. <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>
  277. </div>
  278. <div>
  279. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_System_Boolean_">View.Move(Int32, Int32, Boolean)</a>
  280. </div>
  281. <div>
  282. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  283. </div>
  284. <div>
  285. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnAdded_Terminal_Gui_View_">View.OnAdded(View)</a>
  286. </div>
  287. <div>
  288. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnRemoved_Terminal_Gui_View_">View.OnRemoved(View)</a>
  289. </div>
  290. <div>
  291. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  292. </div>
  293. <div>
  294. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  295. </div>
  296. <div>
  297. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  298. </div>
  299. <div>
  300. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  301. </div>
  302. <div>
  303. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  304. </div>
  305. <div>
  306. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  307. </div>
  308. <div>
  309. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  310. </div>
  311. <div>
  312. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContentComplete">View.DrawContentComplete</a>
  313. </div>
  314. <div>
  315. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContentComplete_Terminal_Gui_Rect_">View.OnDrawContentComplete(Rect)</a>
  316. </div>
  317. <div>
  318. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus">View.SetFocus()</a>
  319. </div>
  320. <div>
  321. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  322. </div>
  323. <div>
  324. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_InvokeKeybindings_Terminal_Gui_KeyEvent_">View.InvokeKeybindings(KeyEvent)</a>
  325. </div>
  326. <div>
  327. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddKeyBinding_Terminal_Gui_Key_Terminal_Gui_Command_">View.AddKeyBinding(Key, Command)</a>
  328. </div>
  329. <div>
  330. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ReplaceKeyBinding_Terminal_Gui_Key_Terminal_Gui_Key_">View.ReplaceKeyBinding(Key, Key)</a>
  331. </div>
  332. <div>
  333. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ContainsKeyBinding_Terminal_Gui_Key_">View.ContainsKeyBinding(Key)</a>
  334. </div>
  335. <div>
  336. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybindings">View.ClearKeybindings()</a>
  337. </div>
  338. <div>
  339. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Key_">View.ClearKeybinding(Key)</a>
  340. </div>
  341. <div>
  342. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Command_">View.ClearKeybinding(Command)</a>
  343. </div>
  344. <div>
  345. <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>
  346. </div>
  347. <div>
  348. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetSupportedCommands">View.GetSupportedCommands()</a>
  349. </div>
  350. <div>
  351. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetKeyFromCommand_Terminal_Gui_Command_">View.GetKeyFromCommand(Command)</a>
  352. </div>
  353. <div>
  354. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  355. </div>
  356. <div>
  357. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  358. </div>
  359. <div>
  360. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  361. </div>
  362. <div>
  363. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  364. </div>
  365. <div>
  366. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  367. </div>
  368. <div>
  369. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  370. </div>
  371. <div>
  372. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  373. </div>
  374. <div>
  375. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  376. </div>
  377. <div>
  378. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  379. </div>
  380. <div>
  381. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  382. </div>
  383. <div>
  384. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  385. </div>
  386. <div>
  387. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStarted">View.LayoutStarted</a>
  388. </div>
  389. <div>
  390. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  391. </div>
  392. <div>
  393. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Initialized">View.Initialized</a>
  394. </div>
  395. <div>
  396. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  397. </div>
  398. <div>
  399. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AutoSize">View.AutoSize</a>
  400. </div>
  401. <div>
  402. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PreserveTrailingSpaces">View.PreserveTrailingSpaces</a>
  403. </div>
  404. <div>
  405. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">View.TextAlignment</a>
  406. </div>
  407. <div>
  408. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VerticalTextAlignment">View.VerticalTextAlignment</a>
  409. </div>
  410. <div>
  411. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextDirection">View.TextDirection</a>
  412. </div>
  413. <div>
  414. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsInitialized">View.IsInitialized</a>
  415. </div>
  416. <div>
  417. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsAdded">View.IsAdded</a>
  418. </div>
  419. <div>
  420. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enabled">View.Enabled</a>
  421. </div>
  422. <div>
  423. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Visible">View.Visible</a>
  424. </div>
  425. <div>
  426. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Border">View.Border</a>
  427. </div>
  428. <div>
  429. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  430. </div>
  431. <div>
  432. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetAutoSize">View.GetAutoSize()</a>
  433. </div>
  434. <div>
  435. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetHotKeySpecifierLength_System_Boolean_">View.GetHotKeySpecifierLength(Boolean)</a>
  436. </div>
  437. <div>
  438. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTextFormatterBoundsSize">View.GetTextFormatterBoundsSize()</a>
  439. </div>
  440. <div>
  441. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetBoundsTextFormatterSize">View.GetBoundsTextFormatterSize()</a>
  442. </div>
  443. <div>
  444. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  445. </div>
  446. <div>
  447. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  448. </div>
  449. <div>
  450. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  451. </div>
  452. <div>
  453. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseClick_Terminal_Gui_View_MouseEventArgs_">View.OnMouseClick(View.MouseEventArgs)</a>
  454. </div>
  455. <div>
  456. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnCanFocusChanged">View.OnCanFocusChanged()</a>
  457. </div>
  458. <div>
  459. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnabledChanged">View.OnEnabledChanged()</a>
  460. </div>
  461. <div>
  462. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnVisibleChanged">View.OnVisibleChanged()</a>
  463. </div>
  464. <div>
  465. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Dispose_System_Boolean_">View.Dispose(Boolean)</a>
  466. </div>
  467. <div>
  468. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BeginInit">View.BeginInit()</a>
  469. </div>
  470. <div>
  471. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EndInit">View.EndInit()</a>
  472. </div>
  473. <div>
  474. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetWidth_System_Int32_System_Int32__">View.SetWidth(Int32, Int32)</a>
  475. </div>
  476. <div>
  477. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetHeight_System_Int32_System_Int32__">View.SetHeight(Int32, Int32)</a>
  478. </div>
  479. <div>
  480. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentWidth_System_Int32__">View.GetCurrentWidth(Int32)</a>
  481. </div>
  482. <div>
  483. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentHeight_System_Int32__">View.GetCurrentHeight(Int32)</a>
  484. </div>
  485. <div>
  486. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetNormalColor">View.GetNormalColor()</a>
  487. </div>
  488. <div>
  489. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTopSuperView">View.GetTopSuperView()</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. <span class="xref">System.Object.Equals(System.Object)</span>
  496. </div>
  497. <div>
  498. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  499. </div>
  500. <div>
  501. <span class="xref">System.Object.GetHashCode()</span>
  502. </div>
  503. <div>
  504. <span class="xref">System.Object.GetType()</span>
  505. </div>
  506. <div>
  507. <span class="xref">System.Object.MemberwiseClone()</span>
  508. </div>
  509. <div>
  510. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  511. </div>
  512. </div>
  513. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  514. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  515. <h5 id="Terminal_Gui_TextField_syntax">Syntax</h5>
  516. <div class="codewrapper">
  517. <pre><code class="lang-csharp hljs">public class TextField : View, IDisposable, ISupportInitializeNotification, ISupportInitialize</code></pre>
  518. </div>
  519. <h3 id="constructors">Constructors
  520. </h3>
  521. <span class="small pull-right mobile-hide">
  522. <span class="divider">|</span>
  523. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField__ctor.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.%23ctor%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  524. </span>
  525. <span class="small pull-right mobile-hide">
  526. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L67">View Source</a>
  527. </span>
  528. <a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
  529. <h4 id="Terminal_Gui_TextField__ctor" data-uid="Terminal.Gui.TextField.#ctor">TextField()</h4>
  530. <div class="markdown level1 summary">
  531. 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.
  532. </div>
  533. <div class="markdown level1 conceptual"></div>
  534. <h5 class="decalaration">Declaration</h5>
  535. <div class="codewrapper">
  536. <pre><code class="lang-csharp hljs">public TextField()</code></pre>
  537. </div>
  538. <span class="small pull-right mobile-hide">
  539. <span class="divider">|</span>
  540. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField__ctor_NStack_ustring_.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.%23ctor(NStack.ustring)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  541. </span>
  542. <span class="small pull-right mobile-hide">
  543. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L73">View Source</a>
  544. </span>
  545. <a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
  546. <h4 id="Terminal_Gui_TextField__ctor_NStack_ustring_" data-uid="Terminal.Gui.TextField.#ctor(NStack.ustring)">TextField(ustring)</h4>
  547. <div class="markdown level1 summary">
  548. 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.
  549. </div>
  550. <div class="markdown level1 conceptual"></div>
  551. <h5 class="decalaration">Declaration</h5>
  552. <div class="codewrapper">
  553. <pre><code class="lang-csharp hljs">public TextField(ustring text)</code></pre>
  554. </div>
  555. <h5 class="parameters">Parameters</h5>
  556. <table class="table table-bordered table-striped table-condensed">
  557. <thead>
  558. <tr>
  559. <th>Type</th>
  560. <th>Name</th>
  561. <th>Description</th>
  562. </tr>
  563. </thead>
  564. <tbody>
  565. <tr>
  566. <td><span class="xref">NStack.ustring</span></td>
  567. <td><span class="parametername">text</span></td>
  568. <td>Initial text contents.</td>
  569. </tr>
  570. </tbody>
  571. </table>
  572. <span class="small pull-right mobile-hide">
  573. <span class="divider">|</span>
  574. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField__ctor_System_Int32_System_Int32_System_Int32_NStack_ustring_.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.%23ctor(System.Int32%2CSystem.Int32%2CSystem.Int32%2CNStack.ustring)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  575. </span>
  576. <span class="small pull-right mobile-hide">
  577. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L85">View Source</a>
  578. </span>
  579. <a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
  580. <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>
  581. <div class="markdown level1 summary">
  582. 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.
  583. </div>
  584. <div class="markdown level1 conceptual"></div>
  585. <h5 class="decalaration">Declaration</h5>
  586. <div class="codewrapper">
  587. <pre><code class="lang-csharp hljs">public TextField(int x, int y, int w, ustring text)</code></pre>
  588. </div>
  589. <h5 class="parameters">Parameters</h5>
  590. <table class="table table-bordered table-striped table-condensed">
  591. <thead>
  592. <tr>
  593. <th>Type</th>
  594. <th>Name</th>
  595. <th>Description</th>
  596. </tr>
  597. </thead>
  598. <tbody>
  599. <tr>
  600. <td><span class="xref">System.Int32</span></td>
  601. <td><span class="parametername">x</span></td>
  602. <td>The x coordinate.</td>
  603. </tr>
  604. <tr>
  605. <td><span class="xref">System.Int32</span></td>
  606. <td><span class="parametername">y</span></td>
  607. <td>The y coordinate.</td>
  608. </tr>
  609. <tr>
  610. <td><span class="xref">System.Int32</span></td>
  611. <td><span class="parametername">w</span></td>
  612. <td>The width.</td>
  613. </tr>
  614. <tr>
  615. <td><span class="xref">NStack.ustring</span></td>
  616. <td><span class="parametername">text</span></td>
  617. <td>Initial text contents.</td>
  618. </tr>
  619. </tbody>
  620. </table>
  621. <span class="small pull-right mobile-hide">
  622. <span class="divider">|</span>
  623. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField__ctor_System_String_.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.%23ctor(System.String)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  624. </span>
  625. <span class="small pull-right mobile-hide">
  626. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L62">View Source</a>
  627. </span>
  628. <a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
  629. <h4 id="Terminal_Gui_TextField__ctor_System_String_" data-uid="Terminal.Gui.TextField.#ctor(System.String)">TextField(String)</h4>
  630. <div class="markdown level1 summary">
  631. 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.
  632. </div>
  633. <div class="markdown level1 conceptual"></div>
  634. <h5 class="decalaration">Declaration</h5>
  635. <div class="codewrapper">
  636. <pre><code class="lang-csharp hljs">public TextField(string text)</code></pre>
  637. </div>
  638. <h5 class="parameters">Parameters</h5>
  639. <table class="table table-bordered table-striped table-condensed">
  640. <thead>
  641. <tr>
  642. <th>Type</th>
  643. <th>Name</th>
  644. <th>Description</th>
  645. </tr>
  646. </thead>
  647. <tbody>
  648. <tr>
  649. <td><span class="xref">System.String</span></td>
  650. <td><span class="parametername">text</span></td>
  651. <td>Initial text contents.</td>
  652. </tr>
  653. </tbody>
  654. </table>
  655. <h3 id="properties">Properties
  656. </h3>
  657. <span class="small pull-right mobile-hide">
  658. <span class="divider">|</span>
  659. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_Autocomplete.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.Autocomplete%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  660. </span>
  661. <span class="small pull-right mobile-hide">
  662. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L262">View Source</a>
  663. </span>
  664. <a id="Terminal_Gui_TextField_Autocomplete_" data-uid="Terminal.Gui.TextField.Autocomplete*"></a>
  665. <h4 id="Terminal_Gui_TextField_Autocomplete" data-uid="Terminal.Gui.TextField.Autocomplete">Autocomplete</h4>
  666. <div class="markdown level1 summary">
  667. Provides autocomplete context menu based on suggestions at the current cursor
  668. position. Populate <a class="xref" href="Terminal.Gui.Autocomplete.html#Terminal_Gui_Autocomplete_AllSuggestions">AllSuggestions</a> to enable this feature.
  669. </div>
  670. <div class="markdown level1 conceptual"></div>
  671. <h5 class="decalaration">Declaration</h5>
  672. <div class="codewrapper">
  673. <pre><code class="lang-csharp hljs">public IAutocomplete Autocomplete { get; protected set; }</code></pre>
  674. </div>
  675. <h5 class="propertyValue">Property Value</h5>
  676. <table class="table table-bordered table-striped table-condensed">
  677. <thead>
  678. <tr>
  679. <th>Type</th>
  680. <th>Description</th>
  681. </tr>
  682. </thead>
  683. <tbody>
  684. <tr>
  685. <td><a class="xref" href="Terminal.Gui.IAutocomplete.html">IAutocomplete</a></td>
  686. <td></td>
  687. </tr>
  688. </tbody>
  689. </table>
  690. <span class="small pull-right mobile-hide">
  691. <span class="divider">|</span>
  692. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_CanFocus.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.CanFocus%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  693. </span>
  694. <span class="small pull-right mobile-hide">
  695. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L513">View Source</a>
  696. </span>
  697. <a id="Terminal_Gui_TextField_CanFocus_" data-uid="Terminal.Gui.TextField.CanFocus*"></a>
  698. <h4 id="Terminal_Gui_TextField_CanFocus" data-uid="Terminal.Gui.TextField.CanFocus">CanFocus</h4>
  699. <div class="markdown level1 summary"></div>
  700. <div class="markdown level1 conceptual"></div>
  701. <h5 class="decalaration">Declaration</h5>
  702. <div class="codewrapper">
  703. <pre><code class="lang-csharp hljs">public override bool CanFocus { get; set; }</code></pre>
  704. </div>
  705. <h5 class="propertyValue">Property Value</h5>
  706. <table class="table table-bordered table-striped table-condensed">
  707. <thead>
  708. <tr>
  709. <th>Type</th>
  710. <th>Description</th>
  711. </tr>
  712. </thead>
  713. <tbody>
  714. <tr>
  715. <td><span class="xref">System.Boolean</span></td>
  716. <td></td>
  717. </tr>
  718. </tbody>
  719. </table>
  720. <h5 class="overrides">Overrides</h5>
  721. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocus">View.CanFocus</a></div>
  722. <span class="small pull-right mobile-hide">
  723. <span class="divider">|</span>
  724. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_ContextMenu.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.ContextMenu%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  725. </span>
  726. <span class="small pull-right mobile-hide">
  727. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L361">View Source</a>
  728. </span>
  729. <a id="Terminal_Gui_TextField_ContextMenu_" data-uid="Terminal.Gui.TextField.ContextMenu*"></a>
  730. <h4 id="Terminal_Gui_TextField_ContextMenu" data-uid="Terminal.Gui.TextField.ContextMenu">ContextMenu</h4>
  731. <div class="markdown level1 summary">
  732. Get the <a class="xref" href="Terminal.Gui.TextField.html#Terminal_Gui_TextField_ContextMenu">ContextMenu</a> for this view.
  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 ContextMenu ContextMenu { get; }</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.ContextMenu.html">ContextMenu</a></td>
  750. <td></td>
  751. </tr>
  752. </tbody>
  753. </table>
  754. <span class="small pull-right mobile-hide">
  755. <span class="divider">|</span>
  756. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_CursorPosition.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.CursorPosition%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  757. </span>
  758. <span class="small pull-right mobile-hide">
  759. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L327">View Source</a>
  760. </span>
  761. <a id="Terminal_Gui_TextField_CursorPosition_" data-uid="Terminal.Gui.TextField.CursorPosition*"></a>
  762. <h4 id="Terminal_Gui_TextField_CursorPosition" data-uid="Terminal.Gui.TextField.CursorPosition">CursorPosition</h4>
  763. <div class="markdown level1 summary">
  764. Sets or gets the current cursor position.
  765. </div>
  766. <div class="markdown level1 conceptual"></div>
  767. <h5 class="decalaration">Declaration</h5>
  768. <div class="codewrapper">
  769. <pre><code class="lang-csharp hljs">public virtual int CursorPosition { get; set; }</code></pre>
  770. </div>
  771. <h5 class="propertyValue">Property Value</h5>
  772. <table class="table table-bordered table-striped table-condensed">
  773. <thead>
  774. <tr>
  775. <th>Type</th>
  776. <th>Description</th>
  777. </tr>
  778. </thead>
  779. <tbody>
  780. <tr>
  781. <td><span class="xref">System.Int32</span></td>
  782. <td></td>
  783. </tr>
  784. </tbody>
  785. </table>
  786. <span class="small pull-right mobile-hide">
  787. <span class="divider">|</span>
  788. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_DesiredCursorVisibility.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.DesiredCursorVisibility%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  789. </span>
  790. <span class="small pull-right mobile-hide">
  791. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L1249">View Source</a>
  792. </span>
  793. <a id="Terminal_Gui_TextField_DesiredCursorVisibility_" data-uid="Terminal.Gui.TextField.DesiredCursorVisibility*"></a>
  794. <h4 id="Terminal_Gui_TextField_DesiredCursorVisibility" data-uid="Terminal.Gui.TextField.DesiredCursorVisibility">DesiredCursorVisibility</h4>
  795. <div class="markdown level1 summary">
  796. Get / Set the wished cursor when the field is focused
  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 CursorVisibility DesiredCursorVisibility { get; set; }</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><a class="xref" href="Terminal.Gui.CursorVisibility.html">CursorVisibility</a></td>
  814. <td></td>
  815. </tr>
  816. </tbody>
  817. </table>
  818. <span class="small pull-right mobile-hide">
  819. <span class="divider">|</span>
  820. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_Frame.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.Frame%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  821. </span>
  822. <span class="small pull-right mobile-hide">
  823. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L265">View Source</a>
  824. </span>
  825. <a id="Terminal_Gui_TextField_Frame_" data-uid="Terminal.Gui.TextField.Frame*"></a>
  826. <h4 id="Terminal_Gui_TextField_Frame" data-uid="Terminal.Gui.TextField.Frame">Frame</h4>
  827. <div class="markdown level1 summary"></div>
  828. <div class="markdown level1 conceptual"></div>
  829. <h5 class="decalaration">Declaration</h5>
  830. <div class="codewrapper">
  831. <pre><code class="lang-csharp hljs">public override Rect Frame { get; set; }</code></pre>
  832. </div>
  833. <h5 class="propertyValue">Property Value</h5>
  834. <table class="table table-bordered table-striped table-condensed">
  835. <thead>
  836. <tr>
  837. <th>Type</th>
  838. <th>Description</th>
  839. </tr>
  840. </thead>
  841. <tbody>
  842. <tr>
  843. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  844. <td></td>
  845. </tr>
  846. </tbody>
  847. </table>
  848. <h5 class="overrides">Overrides</h5>
  849. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a></div>
  850. <span class="small pull-right mobile-hide">
  851. <span class="divider">|</span>
  852. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_HasHistoryChanges.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.HasHistoryChanges%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  853. </span>
  854. <span class="small pull-right mobile-hide">
  855. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L356">View Source</a>
  856. </span>
  857. <a id="Terminal_Gui_TextField_HasHistoryChanges_" data-uid="Terminal.Gui.TextField.HasHistoryChanges*"></a>
  858. <h4 id="Terminal_Gui_TextField_HasHistoryChanges" data-uid="Terminal.Gui.TextField.HasHistoryChanges">HasHistoryChanges</h4>
  859. <div class="markdown level1 summary">
  860. Indicates whatever the text has history changes or not.
  861. <span class="xref">true</span> if the text has history changes <span class="xref">false</span> otherwise.
  862. </div>
  863. <div class="markdown level1 conceptual"></div>
  864. <h5 class="decalaration">Declaration</h5>
  865. <div class="codewrapper">
  866. <pre><code class="lang-csharp hljs">public bool HasHistoryChanges { get; }</code></pre>
  867. </div>
  868. <h5 class="propertyValue">Property Value</h5>
  869. <table class="table table-bordered table-striped table-condensed">
  870. <thead>
  871. <tr>
  872. <th>Type</th>
  873. <th>Description</th>
  874. </tr>
  875. </thead>
  876. <tbody>
  877. <tr>
  878. <td><span class="xref">System.Boolean</span></td>
  879. <td></td>
  880. </tr>
  881. </tbody>
  882. </table>
  883. <span class="small pull-right mobile-hide">
  884. <span class="divider">|</span>
  885. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_IsDirty.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.IsDirty%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  886. </span>
  887. <span class="small pull-right mobile-hide">
  888. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L350">View Source</a>
  889. </span>
  890. <a id="Terminal_Gui_TextField_IsDirty_" data-uid="Terminal.Gui.TextField.IsDirty*"></a>
  891. <h4 id="Terminal_Gui_TextField_IsDirty" data-uid="Terminal.Gui.TextField.IsDirty">IsDirty</h4>
  892. <div class="markdown level1 summary">
  893. Indicates whatever the text was changed or not.
  894. <span class="xref">true</span> if the text was changed <span class="xref">false</span> otherwise.
  895. </div>
  896. <div class="markdown level1 conceptual"></div>
  897. <h5 class="decalaration">Declaration</h5>
  898. <div class="codewrapper">
  899. <pre><code class="lang-csharp hljs">public bool IsDirty { get; }</code></pre>
  900. </div>
  901. <h5 class="propertyValue">Property Value</h5>
  902. <table class="table table-bordered table-striped table-condensed">
  903. <thead>
  904. <tr>
  905. <th>Type</th>
  906. <th>Description</th>
  907. </tr>
  908. </thead>
  909. <tbody>
  910. <tr>
  911. <td><span class="xref">System.Boolean</span></td>
  912. <td></td>
  913. </tr>
  914. </tbody>
  915. </table>
  916. <span class="small pull-right mobile-hide">
  917. <span class="divider">|</span>
  918. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_ReadOnly.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.ReadOnly%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  919. </span>
  920. <span class="small pull-right mobile-hide">
  921. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L40">View Source</a>
  922. </span>
  923. <a id="Terminal_Gui_TextField_ReadOnly_" data-uid="Terminal.Gui.TextField.ReadOnly*"></a>
  924. <h4 id="Terminal_Gui_TextField_ReadOnly" data-uid="Terminal.Gui.TextField.ReadOnly">ReadOnly</h4>
  925. <div class="markdown level1 summary">
  926. If set to true its not allow any changes in the text.
  927. </div>
  928. <div class="markdown level1 conceptual"></div>
  929. <h5 class="decalaration">Declaration</h5>
  930. <div class="codewrapper">
  931. <pre><code class="lang-csharp hljs">public bool ReadOnly { get; set; }</code></pre>
  932. </div>
  933. <h5 class="propertyValue">Property Value</h5>
  934. <table class="table table-bordered table-striped table-condensed">
  935. <thead>
  936. <tr>
  937. <th>Type</th>
  938. <th>Description</th>
  939. </tr>
  940. </thead>
  941. <tbody>
  942. <tr>
  943. <td><span class="xref">System.Boolean</span></td>
  944. <td></td>
  945. </tr>
  946. </tbody>
  947. </table>
  948. <span class="small pull-right mobile-hide">
  949. <span class="divider">|</span>
  950. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_ScrollOffset.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.ScrollOffset%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  951. </span>
  952. <span class="small pull-right mobile-hide">
  953. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L344">View Source</a>
  954. </span>
  955. <a id="Terminal_Gui_TextField_ScrollOffset_" data-uid="Terminal.Gui.TextField.ScrollOffset*"></a>
  956. <h4 id="Terminal_Gui_TextField_ScrollOffset" data-uid="Terminal.Gui.TextField.ScrollOffset">ScrollOffset</h4>
  957. <div class="markdown level1 summary">
  958. Gets the left offset position.
  959. </div>
  960. <div class="markdown level1 conceptual"></div>
  961. <h5 class="decalaration">Declaration</h5>
  962. <div class="codewrapper">
  963. <pre><code class="lang-csharp hljs">public int ScrollOffset { get; }</code></pre>
  964. </div>
  965. <h5 class="propertyValue">Property Value</h5>
  966. <table class="table table-bordered table-striped table-condensed">
  967. <thead>
  968. <tr>
  969. <th>Type</th>
  970. <th>Description</th>
  971. </tr>
  972. </thead>
  973. <tbody>
  974. <tr>
  975. <td><span class="xref">System.Int32</span></td>
  976. <td></td>
  977. </tr>
  978. </tbody>
  979. </table>
  980. <span class="small pull-right mobile-hide">
  981. <span class="divider">|</span>
  982. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_Secret.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.Secret%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  983. </span>
  984. <span class="small pull-right mobile-hide">
  985. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L322">View Source</a>
  986. </span>
  987. <a id="Terminal_Gui_TextField_Secret_" data-uid="Terminal.Gui.TextField.Secret*"></a>
  988. <h4 id="Terminal_Gui_TextField_Secret" data-uid="Terminal.Gui.TextField.Secret">Secret</h4>
  989. <div class="markdown level1 summary">
  990. Sets the secret property.
  991. </div>
  992. <div class="markdown level1 conceptual"></div>
  993. <h5 class="decalaration">Declaration</h5>
  994. <div class="codewrapper">
  995. <pre><code class="lang-csharp hljs">public bool Secret { get; set; }</code></pre>
  996. </div>
  997. <h5 class="propertyValue">Property Value</h5>
  998. <table class="table table-bordered table-striped table-condensed">
  999. <thead>
  1000. <tr>
  1001. <th>Type</th>
  1002. <th>Description</th>
  1003. </tr>
  1004. </thead>
  1005. <tbody>
  1006. <tr>
  1007. <td><span class="xref">System.Boolean</span></td>
  1008. <td></td>
  1009. </tr>
  1010. </tbody>
  1011. </table>
  1012. <span class="small pull-right mobile-hide">
  1013. <span class="divider">|</span>
  1014. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_SelectedLength.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.SelectedLength%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1015. </span>
  1016. <span class="small pull-right mobile-hide">
  1017. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L996">View Source</a>
  1018. </span>
  1019. <a id="Terminal_Gui_TextField_SelectedLength_" data-uid="Terminal.Gui.TextField.SelectedLength*"></a>
  1020. <h4 id="Terminal_Gui_TextField_SelectedLength" data-uid="Terminal.Gui.TextField.SelectedLength">SelectedLength</h4>
  1021. <div class="markdown level1 summary">
  1022. Length of the selected text.
  1023. </div>
  1024. <div class="markdown level1 conceptual"></div>
  1025. <h5 class="decalaration">Declaration</h5>
  1026. <div class="codewrapper">
  1027. <pre><code class="lang-csharp hljs">public int SelectedLength { get; }</code></pre>
  1028. </div>
  1029. <h5 class="propertyValue">Property Value</h5>
  1030. <table class="table table-bordered table-striped table-condensed">
  1031. <thead>
  1032. <tr>
  1033. <th>Type</th>
  1034. <th>Description</th>
  1035. </tr>
  1036. </thead>
  1037. <tbody>
  1038. <tr>
  1039. <td><span class="xref">System.Int32</span></td>
  1040. <td></td>
  1041. </tr>
  1042. </tbody>
  1043. </table>
  1044. <span class="small pull-right mobile-hide">
  1045. <span class="divider">|</span>
  1046. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_SelectedStart.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.SelectedStart%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1047. </span>
  1048. <span class="small pull-right mobile-hide">
  1049. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L979">View Source</a>
  1050. </span>
  1051. <a id="Terminal_Gui_TextField_SelectedStart_" data-uid="Terminal.Gui.TextField.SelectedStart*"></a>
  1052. <h4 id="Terminal_Gui_TextField_SelectedStart" data-uid="Terminal.Gui.TextField.SelectedStart">SelectedStart</h4>
  1053. <div class="markdown level1 summary">
  1054. Start position of the selected text.
  1055. </div>
  1056. <div class="markdown level1 conceptual"></div>
  1057. <h5 class="decalaration">Declaration</h5>
  1058. <div class="codewrapper">
  1059. <pre><code class="lang-csharp hljs">public int SelectedStart { get; set; }</code></pre>
  1060. </div>
  1061. <h5 class="propertyValue">Property Value</h5>
  1062. <table class="table table-bordered table-striped table-condensed">
  1063. <thead>
  1064. <tr>
  1065. <th>Type</th>
  1066. <th>Description</th>
  1067. </tr>
  1068. </thead>
  1069. <tbody>
  1070. <tr>
  1071. <td><span class="xref">System.Int32</span></td>
  1072. <td></td>
  1073. </tr>
  1074. </tbody>
  1075. </table>
  1076. <span class="small pull-right mobile-hide">
  1077. <span class="divider">|</span>
  1078. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_SelectedText.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.SelectedText%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1079. </span>
  1080. <span class="small pull-right mobile-hide">
  1081. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L1001">View Source</a>
  1082. </span>
  1083. <a id="Terminal_Gui_TextField_SelectedText_" data-uid="Terminal.Gui.TextField.SelectedText*"></a>
  1084. <h4 id="Terminal_Gui_TextField_SelectedText" data-uid="Terminal.Gui.TextField.SelectedText">SelectedText</h4>
  1085. <div class="markdown level1 summary">
  1086. The selected text.
  1087. </div>
  1088. <div class="markdown level1 conceptual"></div>
  1089. <h5 class="decalaration">Declaration</h5>
  1090. <div class="codewrapper">
  1091. <pre><code class="lang-csharp hljs">public ustring SelectedText { get; }</code></pre>
  1092. </div>
  1093. <h5 class="propertyValue">Property Value</h5>
  1094. <table class="table table-bordered table-striped table-condensed">
  1095. <thead>
  1096. <tr>
  1097. <th>Type</th>
  1098. <th>Description</th>
  1099. </tr>
  1100. </thead>
  1101. <tbody>
  1102. <tr>
  1103. <td><span class="xref">NStack.ustring</span></td>
  1104. <td></td>
  1105. </tr>
  1106. </tbody>
  1107. </table>
  1108. <span class="small pull-right mobile-hide">
  1109. <span class="divider">|</span>
  1110. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_Text.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.Text%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1111. </span>
  1112. <span class="small pull-right mobile-hide">
  1113. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L278">View Source</a>
  1114. </span>
  1115. <a id="Terminal_Gui_TextField_Text_" data-uid="Terminal.Gui.TextField.Text*"></a>
  1116. <h4 id="Terminal_Gui_TextField_Text" data-uid="Terminal.Gui.TextField.Text">Text</h4>
  1117. <div class="markdown level1 summary">
  1118. Sets or gets the text held by the view.
  1119. </div>
  1120. <div class="markdown level1 conceptual"></div>
  1121. <h5 class="decalaration">Declaration</h5>
  1122. <div class="codewrapper">
  1123. <pre><code class="lang-csharp hljs">public ustring Text { get; set; }</code></pre>
  1124. </div>
  1125. <h5 class="propertyValue">Property Value</h5>
  1126. <table class="table table-bordered table-striped table-condensed">
  1127. <thead>
  1128. <tr>
  1129. <th>Type</th>
  1130. <th>Description</th>
  1131. </tr>
  1132. </thead>
  1133. <tbody>
  1134. <tr>
  1135. <td><span class="xref">NStack.ustring</span></td>
  1136. <td></td>
  1137. </tr>
  1138. </tbody>
  1139. </table>
  1140. <span class="small pull-right mobile-hide">
  1141. <span class="divider">|</span>
  1142. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_Used.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.Used%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1143. </span>
  1144. <span class="small pull-right mobile-hide">
  1145. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L35">View Source</a>
  1146. </span>
  1147. <a id="Terminal_Gui_TextField_Used_" data-uid="Terminal.Gui.TextField.Used*"></a>
  1148. <h4 id="Terminal_Gui_TextField_Used" data-uid="Terminal.Gui.TextField.Used">Used</h4>
  1149. <div class="markdown level1 summary">
  1150. 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
  1151. </div>
  1152. <div class="markdown level1 conceptual"></div>
  1153. <h5 class="decalaration">Declaration</h5>
  1154. <div class="codewrapper">
  1155. <pre><code class="lang-csharp hljs">public bool Used { get; set; }</code></pre>
  1156. </div>
  1157. <h5 class="propertyValue">Property Value</h5>
  1158. <table class="table table-bordered table-striped table-condensed">
  1159. <thead>
  1160. <tr>
  1161. <th>Type</th>
  1162. <th>Description</th>
  1163. </tr>
  1164. </thead>
  1165. <tbody>
  1166. <tr>
  1167. <td><span class="xref">System.Boolean</span></td>
  1168. <td></td>
  1169. </tr>
  1170. </tbody>
  1171. </table>
  1172. <h3 id="methods">Methods
  1173. </h3>
  1174. <span class="small pull-right mobile-hide">
  1175. <span class="divider">|</span>
  1176. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_ClearAllSelection.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.ClearAllSelection%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1177. </span>
  1178. <span class="small pull-right mobile-hide">
  1179. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L1145">View Source</a>
  1180. </span>
  1181. <a id="Terminal_Gui_TextField_ClearAllSelection_" data-uid="Terminal.Gui.TextField.ClearAllSelection*"></a>
  1182. <h4 id="Terminal_Gui_TextField_ClearAllSelection" data-uid="Terminal.Gui.TextField.ClearAllSelection">ClearAllSelection()</h4>
  1183. <div class="markdown level1 summary">
  1184. Clear the selected text.
  1185. </div>
  1186. <div class="markdown level1 conceptual"></div>
  1187. <h5 class="decalaration">Declaration</h5>
  1188. <div class="codewrapper">
  1189. <pre><code class="lang-csharp hljs">public void ClearAllSelection()</code></pre>
  1190. </div>
  1191. <span class="small pull-right mobile-hide">
  1192. <span class="divider">|</span>
  1193. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_ClearHistoryChanges.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.ClearHistoryChanges%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1194. </span>
  1195. <span class="small pull-right mobile-hide">
  1196. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L1294">View Source</a>
  1197. </span>
  1198. <a id="Terminal_Gui_TextField_ClearHistoryChanges_" data-uid="Terminal.Gui.TextField.ClearHistoryChanges*"></a>
  1199. <h4 id="Terminal_Gui_TextField_ClearHistoryChanges" data-uid="Terminal.Gui.TextField.ClearHistoryChanges">ClearHistoryChanges()</h4>
  1200. <div class="markdown level1 summary">
  1201. Allows clearing the <span class="xref">Terminal.Gui.HistoryText.HistoryTextItem</span> items updating the original text.
  1202. </div>
  1203. <div class="markdown level1 conceptual"></div>
  1204. <h5 class="decalaration">Declaration</h5>
  1205. <div class="codewrapper">
  1206. <pre><code class="lang-csharp hljs">public void ClearHistoryChanges()</code></pre>
  1207. </div>
  1208. <span class="small pull-right mobile-hide">
  1209. <span class="divider">|</span>
  1210. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_Copy.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.Copy%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1211. </span>
  1212. <span class="small pull-right mobile-hide">
  1213. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L1170">View Source</a>
  1214. </span>
  1215. <a id="Terminal_Gui_TextField_Copy_" data-uid="Terminal.Gui.TextField.Copy*"></a>
  1216. <h4 id="Terminal_Gui_TextField_Copy" data-uid="Terminal.Gui.TextField.Copy">Copy()</h4>
  1217. <div class="markdown level1 summary">
  1218. Copy the selected text to the clipboard.
  1219. </div>
  1220. <div class="markdown level1 conceptual"></div>
  1221. <h5 class="decalaration">Declaration</h5>
  1222. <div class="codewrapper">
  1223. <pre><code class="lang-csharp hljs">public virtual void Copy()</code></pre>
  1224. </div>
  1225. <span class="small pull-right mobile-hide">
  1226. <span class="divider">|</span>
  1227. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_Cut.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.Cut%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1228. </span>
  1229. <span class="small pull-right mobile-hide">
  1230. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L1181">View Source</a>
  1231. </span>
  1232. <a id="Terminal_Gui_TextField_Cut_" data-uid="Terminal.Gui.TextField.Cut*"></a>
  1233. <h4 id="Terminal_Gui_TextField_Cut" data-uid="Terminal.Gui.TextField.Cut">Cut()</h4>
  1234. <div class="markdown level1 summary">
  1235. Cut the selected text to the clipboard.
  1236. </div>
  1237. <div class="markdown level1 conceptual"></div>
  1238. <h5 class="decalaration">Declaration</h5>
  1239. <div class="codewrapper">
  1240. <pre><code class="lang-csharp hljs">public virtual void Cut()</code></pre>
  1241. </div>
  1242. <span class="small pull-right mobile-hide">
  1243. <span class="divider">|</span>
  1244. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_DeleteAll.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.DeleteAll%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1245. </span>
  1246. <span class="small pull-right mobile-hide">
  1247. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L964">View Source</a>
  1248. </span>
  1249. <a id="Terminal_Gui_TextField_DeleteAll_" data-uid="Terminal.Gui.TextField.DeleteAll*"></a>
  1250. <h4 id="Terminal_Gui_TextField_DeleteAll" data-uid="Terminal.Gui.TextField.DeleteAll">DeleteAll()</h4>
  1251. <div class="markdown level1 summary">
  1252. Deletes all text.
  1253. </div>
  1254. <div class="markdown level1 conceptual"></div>
  1255. <h5 class="decalaration">Declaration</h5>
  1256. <div class="codewrapper">
  1257. <pre><code class="lang-csharp hljs">public void DeleteAll()</code></pre>
  1258. </div>
  1259. <span class="small pull-right mobile-hide">
  1260. <span class="divider">|</span>
  1261. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_DeleteCharLeft_System_Boolean_.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.DeleteCharLeft(System.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1262. </span>
  1263. <span class="small pull-right mobile-hide">
  1264. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L803">View Source</a>
  1265. </span>
  1266. <a id="Terminal_Gui_TextField_DeleteCharLeft_" data-uid="Terminal.Gui.TextField.DeleteCharLeft*"></a>
  1267. <h4 id="Terminal_Gui_TextField_DeleteCharLeft_System_Boolean_" data-uid="Terminal.Gui.TextField.DeleteCharLeft(System.Boolean)">DeleteCharLeft(Boolean)</h4>
  1268. <div class="markdown level1 summary">
  1269. Deletes the left character.
  1270. </div>
  1271. <div class="markdown level1 conceptual"></div>
  1272. <h5 class="decalaration">Declaration</h5>
  1273. <div class="codewrapper">
  1274. <pre><code class="lang-csharp hljs">public virtual void DeleteCharLeft(bool useOldCursorPos = true)</code></pre>
  1275. </div>
  1276. <h5 class="parameters">Parameters</h5>
  1277. <table class="table table-bordered table-striped table-condensed">
  1278. <thead>
  1279. <tr>
  1280. <th>Type</th>
  1281. <th>Name</th>
  1282. <th>Description</th>
  1283. </tr>
  1284. </thead>
  1285. <tbody>
  1286. <tr>
  1287. <td><span class="xref">System.Boolean</span></td>
  1288. <td><span class="parametername">useOldCursorPos</span></td>
  1289. <td></td>
  1290. </tr>
  1291. </tbody>
  1292. </table>
  1293. <span class="small pull-right mobile-hide">
  1294. <span class="divider">|</span>
  1295. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_DeleteCharRight.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.DeleteCharRight%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1296. </span>
  1297. <span class="small pull-right mobile-hide">
  1298. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L834">View Source</a>
  1299. </span>
  1300. <a id="Terminal_Gui_TextField_DeleteCharRight_" data-uid="Terminal.Gui.TextField.DeleteCharRight*"></a>
  1301. <h4 id="Terminal_Gui_TextField_DeleteCharRight" data-uid="Terminal.Gui.TextField.DeleteCharRight">DeleteCharRight()</h4>
  1302. <div class="markdown level1 summary">
  1303. Deletes the right character.
  1304. </div>
  1305. <div class="markdown level1 conceptual"></div>
  1306. <h5 class="decalaration">Declaration</h5>
  1307. <div class="codewrapper">
  1308. <pre><code class="lang-csharp hljs">public virtual void DeleteCharRight()</code></pre>
  1309. </div>
  1310. <span class="small pull-right mobile-hide">
  1311. <span class="divider">|</span>
  1312. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_InsertText_System_String_System_Boolean_.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.InsertText(System.String%2CSystem.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1313. </span>
  1314. <span class="small pull-right mobile-hide">
  1315. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L1274">View Source</a>
  1316. </span>
  1317. <a id="Terminal_Gui_TextField_InsertText_" data-uid="Terminal.Gui.TextField.InsertText*"></a>
  1318. <h4 id="Terminal_Gui_TextField_InsertText_System_String_System_Boolean_" data-uid="Terminal.Gui.TextField.InsertText(System.String,System.Boolean)">InsertText(String, Boolean)</h4>
  1319. <div class="markdown level1 summary">
  1320. Inserts the given <code data-dev-comment-type="paramref" class="paramref">toAdd</code> text at the current cursor position
  1321. exactly as if the user had just typed it
  1322. </div>
  1323. <div class="markdown level1 conceptual"></div>
  1324. <h5 class="decalaration">Declaration</h5>
  1325. <div class="codewrapper">
  1326. <pre><code class="lang-csharp hljs">public void InsertText(string toAdd, bool useOldCursorPos = true)</code></pre>
  1327. </div>
  1328. <h5 class="parameters">Parameters</h5>
  1329. <table class="table table-bordered table-striped table-condensed">
  1330. <thead>
  1331. <tr>
  1332. <th>Type</th>
  1333. <th>Name</th>
  1334. <th>Description</th>
  1335. </tr>
  1336. </thead>
  1337. <tbody>
  1338. <tr>
  1339. <td><span class="xref">System.String</span></td>
  1340. <td><span class="parametername">toAdd</span></td>
  1341. <td>Text to add</td>
  1342. </tr>
  1343. <tr>
  1344. <td><span class="xref">System.Boolean</span></td>
  1345. <td><span class="parametername">useOldCursorPos</span></td>
  1346. <td>If uses the <span class="xref">Terminal.Gui.TextField.oldCursorPos</span>.</td>
  1347. </tr>
  1348. </tbody>
  1349. </table>
  1350. <span class="small pull-right mobile-hide">
  1351. <span class="divider">|</span>
  1352. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_KillWordBackwards.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.KillWordBackwards%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1353. </span>
  1354. <span class="small pull-right mobile-hide">
  1355. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L612">View Source</a>
  1356. </span>
  1357. <a id="Terminal_Gui_TextField_KillWordBackwards_" data-uid="Terminal.Gui.TextField.KillWordBackwards*"></a>
  1358. <h4 id="Terminal_Gui_TextField_KillWordBackwards" data-uid="Terminal.Gui.TextField.KillWordBackwards">KillWordBackwards()</h4>
  1359. <div class="markdown level1 summary">
  1360. Deletes word backwards.
  1361. </div>
  1362. <div class="markdown level1 conceptual"></div>
  1363. <h5 class="decalaration">Declaration</h5>
  1364. <div class="codewrapper">
  1365. <pre><code class="lang-csharp hljs">public virtual void KillWordBackwards()</code></pre>
  1366. </div>
  1367. <span class="small pull-right mobile-hide">
  1368. <span class="divider">|</span>
  1369. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_KillWordForwards.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.KillWordForwards%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1370. </span>
  1371. <span class="small pull-right mobile-hide">
  1372. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L626">View Source</a>
  1373. </span>
  1374. <a id="Terminal_Gui_TextField_KillWordForwards_" data-uid="Terminal.Gui.TextField.KillWordForwards*"></a>
  1375. <h4 id="Terminal_Gui_TextField_KillWordForwards" data-uid="Terminal.Gui.TextField.KillWordForwards">KillWordForwards()</h4>
  1376. <div class="markdown level1 summary">
  1377. Deletes word forwards.
  1378. </div>
  1379. <div class="markdown level1 conceptual"></div>
  1380. <h5 class="decalaration">Declaration</h5>
  1381. <div class="codewrapper">
  1382. <pre><code class="lang-csharp hljs">public virtual void KillWordForwards()</code></pre>
  1383. </div>
  1384. <span class="small pull-right mobile-hide">
  1385. <span class="divider">|</span>
  1386. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_MouseEvent_Terminal_Gui_MouseEvent_.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.MouseEvent(Terminal.Gui.MouseEvent)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1387. </span>
  1388. <span class="small pull-right mobile-hide">
  1389. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L1011">View Source</a>
  1390. </span>
  1391. <a id="Terminal_Gui_TextField_MouseEvent_" data-uid="Terminal.Gui.TextField.MouseEvent*"></a>
  1392. <h4 id="Terminal_Gui_TextField_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.TextField.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  1393. <div class="markdown level1 summary"></div>
  1394. <div class="markdown level1 conceptual"></div>
  1395. <h5 class="decalaration">Declaration</h5>
  1396. <div class="codewrapper">
  1397. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent ev)</code></pre>
  1398. </div>
  1399. <h5 class="parameters">Parameters</h5>
  1400. <table class="table table-bordered table-striped table-condensed">
  1401. <thead>
  1402. <tr>
  1403. <th>Type</th>
  1404. <th>Name</th>
  1405. <th>Description</th>
  1406. </tr>
  1407. </thead>
  1408. <tbody>
  1409. <tr>
  1410. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  1411. <td><span class="parametername">ev</span></td>
  1412. <td></td>
  1413. </tr>
  1414. </tbody>
  1415. </table>
  1416. <h5 class="returns">Returns</h5>
  1417. <table class="table table-bordered table-striped table-condensed">
  1418. <thead>
  1419. <tr>
  1420. <th>Type</th>
  1421. <th>Description</th>
  1422. </tr>
  1423. </thead>
  1424. <tbody>
  1425. <tr>
  1426. <td><span class="xref">System.Boolean</span></td>
  1427. <td></td>
  1428. </tr>
  1429. </tbody>
  1430. </table>
  1431. <h5 class="overrides">Overrides</h5>
  1432. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  1433. <span class="small pull-right mobile-hide">
  1434. <span class="divider">|</span>
  1435. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_OnEnter_Terminal_Gui_View_.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.OnEnter(Terminal.Gui.View)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1436. </span>
  1437. <span class="small pull-right mobile-hide">
  1438. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L1261">View Source</a>
  1439. </span>
  1440. <a id="Terminal_Gui_TextField_OnEnter_" data-uid="Terminal.Gui.TextField.OnEnter*"></a>
  1441. <h4 id="Terminal_Gui_TextField_OnEnter_Terminal_Gui_View_" data-uid="Terminal.Gui.TextField.OnEnter(Terminal.Gui.View)">OnEnter(View)</h4>
  1442. <div class="markdown level1 summary"></div>
  1443. <div class="markdown level1 conceptual"></div>
  1444. <h5 class="decalaration">Declaration</h5>
  1445. <div class="codewrapper">
  1446. <pre><code class="lang-csharp hljs">public override bool OnEnter(View view)</code></pre>
  1447. </div>
  1448. <h5 class="parameters">Parameters</h5>
  1449. <table class="table table-bordered table-striped table-condensed">
  1450. <thead>
  1451. <tr>
  1452. <th>Type</th>
  1453. <th>Name</th>
  1454. <th>Description</th>
  1455. </tr>
  1456. </thead>
  1457. <tbody>
  1458. <tr>
  1459. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  1460. <td><span class="parametername">view</span></td>
  1461. <td></td>
  1462. </tr>
  1463. </tbody>
  1464. </table>
  1465. <h5 class="returns">Returns</h5>
  1466. <table class="table table-bordered table-striped table-condensed">
  1467. <thead>
  1468. <tr>
  1469. <th>Type</th>
  1470. <th>Description</th>
  1471. </tr>
  1472. </thead>
  1473. <tbody>
  1474. <tr>
  1475. <td><span class="xref">System.Boolean</span></td>
  1476. <td></td>
  1477. </tr>
  1478. </tbody>
  1479. </table>
  1480. <h5 class="overrides">Overrides</h5>
  1481. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter_Terminal_Gui_View_">View.OnEnter(View)</a></div>
  1482. <span class="small pull-right mobile-hide">
  1483. <span class="divider">|</span>
  1484. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_OnLeave_Terminal_Gui_View_.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.OnLeave(Terminal.Gui.View)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1485. </span>
  1486. <span class="small pull-right mobile-hide">
  1487. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L248">View Source</a>
  1488. </span>
  1489. <a id="Terminal_Gui_TextField_OnLeave_" data-uid="Terminal.Gui.TextField.OnLeave*"></a>
  1490. <h4 id="Terminal_Gui_TextField_OnLeave_Terminal_Gui_View_" data-uid="Terminal.Gui.TextField.OnLeave(Terminal.Gui.View)">OnLeave(View)</h4>
  1491. <div class="markdown level1 summary"></div>
  1492. <div class="markdown level1 conceptual"></div>
  1493. <h5 class="decalaration">Declaration</h5>
  1494. <div class="codewrapper">
  1495. <pre><code class="lang-csharp hljs">public override bool OnLeave(View view)</code></pre>
  1496. </div>
  1497. <h5 class="parameters">Parameters</h5>
  1498. <table class="table table-bordered table-striped table-condensed">
  1499. <thead>
  1500. <tr>
  1501. <th>Type</th>
  1502. <th>Name</th>
  1503. <th>Description</th>
  1504. </tr>
  1505. </thead>
  1506. <tbody>
  1507. <tr>
  1508. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  1509. <td><span class="parametername">view</span></td>
  1510. <td></td>
  1511. </tr>
  1512. </tbody>
  1513. </table>
  1514. <h5 class="returns">Returns</h5>
  1515. <table class="table table-bordered table-striped table-condensed">
  1516. <thead>
  1517. <tr>
  1518. <th>Type</th>
  1519. <th>Description</th>
  1520. </tr>
  1521. </thead>
  1522. <tbody>
  1523. <tr>
  1524. <td><span class="xref">System.Boolean</span></td>
  1525. <td></td>
  1526. </tr>
  1527. </tbody>
  1528. </table>
  1529. <h5 class="overrides">Overrides</h5>
  1530. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave_Terminal_Gui_View_">View.OnLeave(View)</a></div>
  1531. <span class="small pull-right mobile-hide">
  1532. <span class="divider">|</span>
  1533. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_OnTextChanging_NStack_ustring_.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.OnTextChanging(NStack.ustring)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1534. </span>
  1535. <span class="small pull-right mobile-hide">
  1536. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L1237">View Source</a>
  1537. </span>
  1538. <a id="Terminal_Gui_TextField_OnTextChanging_" data-uid="Terminal.Gui.TextField.OnTextChanging*"></a>
  1539. <h4 id="Terminal_Gui_TextField_OnTextChanging_NStack_ustring_" data-uid="Terminal.Gui.TextField.OnTextChanging(NStack.ustring)">OnTextChanging(ustring)</h4>
  1540. <div class="markdown level1 summary">
  1541. 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.
  1542. </div>
  1543. <div class="markdown level1 conceptual"></div>
  1544. <h5 class="decalaration">Declaration</h5>
  1545. <div class="codewrapper">
  1546. <pre><code class="lang-csharp hljs">public virtual TextChangingEventArgs OnTextChanging(ustring newText)</code></pre>
  1547. </div>
  1548. <h5 class="parameters">Parameters</h5>
  1549. <table class="table table-bordered table-striped table-condensed">
  1550. <thead>
  1551. <tr>
  1552. <th>Type</th>
  1553. <th>Name</th>
  1554. <th>Description</th>
  1555. </tr>
  1556. </thead>
  1557. <tbody>
  1558. <tr>
  1559. <td><span class="xref">NStack.ustring</span></td>
  1560. <td><span class="parametername">newText</span></td>
  1561. <td>The new text to be replaced.</td>
  1562. </tr>
  1563. </tbody>
  1564. </table>
  1565. <h5 class="returns">Returns</h5>
  1566. <table class="table table-bordered table-striped table-condensed">
  1567. <thead>
  1568. <tr>
  1569. <th>Type</th>
  1570. <th>Description</th>
  1571. </tr>
  1572. </thead>
  1573. <tbody>
  1574. <tr>
  1575. <td><a class="xref" href="Terminal.Gui.TextChangingEventArgs.html">TextChangingEventArgs</a></td>
  1576. <td>Returns the <a class="xref" href="Terminal.Gui.TextChangingEventArgs.html">TextChangingEventArgs</a></td>
  1577. </tr>
  1578. </tbody>
  1579. </table>
  1580. <span class="small pull-right mobile-hide">
  1581. <span class="divider">|</span>
  1582. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_Paste.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.Paste%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1583. </span>
  1584. <span class="small pull-right mobile-hide">
  1585. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L1210">View Source</a>
  1586. </span>
  1587. <a id="Terminal_Gui_TextField_Paste_" data-uid="Terminal.Gui.TextField.Paste*"></a>
  1588. <h4 id="Terminal_Gui_TextField_Paste" data-uid="Terminal.Gui.TextField.Paste">Paste()</h4>
  1589. <div class="markdown level1 summary">
  1590. Paste the selected text from the clipboard.
  1591. </div>
  1592. <div class="markdown level1 conceptual"></div>
  1593. <h5 class="decalaration">Declaration</h5>
  1594. <div class="codewrapper">
  1595. <pre><code class="lang-csharp hljs">public virtual void Paste()</code></pre>
  1596. </div>
  1597. <span class="small pull-right mobile-hide">
  1598. <span class="divider">|</span>
  1599. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_PositionCursor.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.PositionCursor%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1600. </span>
  1601. <span class="small pull-right mobile-hide">
  1602. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L366">View Source</a>
  1603. </span>
  1604. <a id="Terminal_Gui_TextField_PositionCursor_" data-uid="Terminal.Gui.TextField.PositionCursor*"></a>
  1605. <h4 id="Terminal_Gui_TextField_PositionCursor" data-uid="Terminal.Gui.TextField.PositionCursor">PositionCursor()</h4>
  1606. <div class="markdown level1 summary">
  1607. Sets the cursor position.
  1608. </div>
  1609. <div class="markdown level1 conceptual"></div>
  1610. <h5 class="decalaration">Declaration</h5>
  1611. <div class="codewrapper">
  1612. <pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
  1613. </div>
  1614. <h5 class="overrides">Overrides</h5>
  1615. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
  1616. <span class="small pull-right mobile-hide">
  1617. <span class="divider">|</span>
  1618. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_ProcessKey_Terminal_Gui_KeyEvent_.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.ProcessKey(Terminal.Gui.KeyEvent)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1619. </span>
  1620. <span class="small pull-right mobile-hide">
  1621. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L544">View Source</a>
  1622. </span>
  1623. <a id="Terminal_Gui_TextField_ProcessKey_" data-uid="Terminal.Gui.TextField.ProcessKey*"></a>
  1624. <h4 id="Terminal_Gui_TextField_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.TextField.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  1625. <div class="markdown level1 summary">
  1626. Processes key presses for the <a class="xref" href="Terminal.Gui.TextField.html">TextField</a>.
  1627. </div>
  1628. <div class="markdown level1 conceptual"></div>
  1629. <h5 class="decalaration">Declaration</h5>
  1630. <div class="codewrapper">
  1631. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent kb)</code></pre>
  1632. </div>
  1633. <h5 class="parameters">Parameters</h5>
  1634. <table class="table table-bordered table-striped table-condensed">
  1635. <thead>
  1636. <tr>
  1637. <th>Type</th>
  1638. <th>Name</th>
  1639. <th>Description</th>
  1640. </tr>
  1641. </thead>
  1642. <tbody>
  1643. <tr>
  1644. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  1645. <td><span class="parametername">kb</span></td>
  1646. <td></td>
  1647. </tr>
  1648. </tbody>
  1649. </table>
  1650. <h5 class="returns">Returns</h5>
  1651. <table class="table table-bordered table-striped table-condensed">
  1652. <thead>
  1653. <tr>
  1654. <th>Type</th>
  1655. <th>Description</th>
  1656. </tr>
  1657. </thead>
  1658. <tbody>
  1659. <tr>
  1660. <td><span class="xref">System.Boolean</span></td>
  1661. <td></td>
  1662. </tr>
  1663. </tbody>
  1664. </table>
  1665. <h5 class="overrides">Overrides</h5>
  1666. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  1667. <span class="small pull-right mobile-hide">
  1668. <span class="divider">|</span>
  1669. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_Redraw_Terminal_Gui_Rect_.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.Redraw(Terminal.Gui.Rect)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1670. </span>
  1671. <span class="small pull-right mobile-hide">
  1672. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L410">View Source</a>
  1673. </span>
  1674. <a id="Terminal_Gui_TextField_Redraw_" data-uid="Terminal.Gui.TextField.Redraw*"></a>
  1675. <h4 id="Terminal_Gui_TextField_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.TextField.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  1676. <div class="markdown level1 summary"></div>
  1677. <div class="markdown level1 conceptual"></div>
  1678. <h5 class="decalaration">Declaration</h5>
  1679. <div class="codewrapper">
  1680. <pre><code class="lang-csharp hljs">public override void Redraw(Rect bounds)</code></pre>
  1681. </div>
  1682. <h5 class="parameters">Parameters</h5>
  1683. <table class="table table-bordered table-striped table-condensed">
  1684. <thead>
  1685. <tr>
  1686. <th>Type</th>
  1687. <th>Name</th>
  1688. <th>Description</th>
  1689. </tr>
  1690. </thead>
  1691. <tbody>
  1692. <tr>
  1693. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1694. <td><span class="parametername">bounds</span></td>
  1695. <td></td>
  1696. </tr>
  1697. </tbody>
  1698. </table>
  1699. <h5 class="overrides">Overrides</h5>
  1700. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  1701. <span class="small pull-right mobile-hide">
  1702. <span class="divider">|</span>
  1703. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_SelectAll.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.SelectAll%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1704. </span>
  1705. <span class="small pull-right mobile-hide">
  1706. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L950">View Source</a>
  1707. </span>
  1708. <a id="Terminal_Gui_TextField_SelectAll_" data-uid="Terminal.Gui.TextField.SelectAll*"></a>
  1709. <h4 id="Terminal_Gui_TextField_SelectAll" data-uid="Terminal.Gui.TextField.SelectAll">SelectAll()</h4>
  1710. <div class="markdown level1 summary">
  1711. Selects all text.
  1712. </div>
  1713. <div class="markdown level1 conceptual"></div>
  1714. <h5 class="decalaration">Declaration</h5>
  1715. <div class="codewrapper">
  1716. <pre><code class="lang-csharp hljs">public void SelectAll()</code></pre>
  1717. </div>
  1718. <h3 id="events">Events
  1719. </h3>
  1720. <span class="small pull-right mobile-hide">
  1721. <span class="divider">|</span>
  1722. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_TextChanged.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.TextChanged%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1723. </span>
  1724. <span class="small pull-right mobile-hide">
  1725. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L56">View Source</a>
  1726. </span>
  1727. <h4 id="Terminal_Gui_TextField_TextChanged" data-uid="Terminal.Gui.TextField.TextChanged">TextChanged</h4>
  1728. <div class="markdown level1 summary">
  1729. Changed event, raised when the text has changed.
  1730. </div>
  1731. <div class="markdown level1 conceptual"></div>
  1732. <h5 class="decalaration">Declaration</h5>
  1733. <div class="codewrapper">
  1734. <pre><code class="lang-csharp hljs">public event Action&lt;ustring&gt; TextChanged</code></pre>
  1735. </div>
  1736. <h5 class="eventType">Event Type</h5>
  1737. <table class="table table-bordered table-striped table-condensed">
  1738. <thead>
  1739. <tr>
  1740. <th>Type</th>
  1741. <th>Description</th>
  1742. </tr>
  1743. </thead>
  1744. <tbody>
  1745. <tr>
  1746. <td><span class="xref">System.Action</span>&lt;<span class="xref">NStack.ustring</span>&gt;</td>
  1747. <td></td>
  1748. </tr>
  1749. </tbody>
  1750. </table>
  1751. <span class="small pull-right mobile-hide">
  1752. <span class="divider">|</span>
  1753. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField_TextChanging.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField.TextChanging%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  1754. </span>
  1755. <span class="small pull-right mobile-hide">
  1756. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L45">View Source</a>
  1757. </span>
  1758. <h4 id="Terminal_Gui_TextField_TextChanging" data-uid="Terminal.Gui.TextField.TextChanging">TextChanging</h4>
  1759. <div class="markdown level1 summary">
  1760. 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.
  1761. </div>
  1762. <div class="markdown level1 conceptual"></div>
  1763. <h5 class="decalaration">Declaration</h5>
  1764. <div class="codewrapper">
  1765. <pre><code class="lang-csharp hljs">public event Action&lt;TextChangingEventArgs&gt; TextChanging</code></pre>
  1766. </div>
  1767. <h5 class="eventType">Event Type</h5>
  1768. <table class="table table-bordered table-striped table-condensed">
  1769. <thead>
  1770. <tr>
  1771. <th>Type</th>
  1772. <th>Description</th>
  1773. </tr>
  1774. </thead>
  1775. <tbody>
  1776. <tr>
  1777. <td><span class="xref">System.Action</span>&lt;<a class="xref" href="Terminal.Gui.TextChangingEventArgs.html">TextChangingEventArgs</a>&gt;</td>
  1778. <td></td>
  1779. </tr>
  1780. </tbody>
  1781. </table>
  1782. <h3 id="implements">Implements</h3>
  1783. <div>
  1784. <span class="xref">System.IDisposable</span>
  1785. </div>
  1786. <div>
  1787. <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
  1788. </div>
  1789. <div>
  1790. <span class="xref">System.ComponentModel.ISupportInitialize</span>
  1791. </div>
  1792. </article>
  1793. </div>
  1794. <div class="hidden-sm col-md-2" role="complementary">
  1795. <div class="sideaffix">
  1796. <div class="contribution">
  1797. <ul class="nav">
  1798. <li>
  1799. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_TextField.md&amp;value=---%0Auid%3A%20Terminal.Gui.TextField%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
  1800. </li>
  1801. <li>
  1802. <a href="tig:tig/Terminal.Gui/blob/main/Terminal.Gui/Views/TextField.cs/#L24" class="contribution-link">View Source</a>
  1803. </li>
  1804. </ul>
  1805. </div>
  1806. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  1807. <h5>In This Article</h5>
  1808. <div></div>
  1809. </nav>
  1810. </div>
  1811. </div>
  1812. </div>
  1813. </div>
  1814. <footer>
  1815. <div class="grad-bottom"></div>
  1816. <div class="footer">
  1817. <div class="container">
  1818. <span class="pull-right">
  1819. <a href="#top">Back to top</a>
  1820. </span>
  1821. <span>Generated by <strong>DocFX</strong></span>
  1822. </div>
  1823. </div>
  1824. </footer>
  1825. </div>
  1826. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  1827. <script type="text/javascript" src="../../styles/docfx.js"></script>
  1828. <script type="text/javascript" src="../../styles/main.js"></script>
  1829. </body>
  1830. </html>