Terminal.Gui.TextField.html 38 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987
  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.53.1.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=Roboto" rel="stylesheet">
  18. <meta property="docfx:navrel" content="">
  19. <meta property="docfx:tocrel" content="toc.html">
  20. <meta property="docfx:rel" content="../../">
  21. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Terminal.Gui.TextField">
  73. <h1 id="Terminal_Gui_TextField" data-uid="Terminal.Gui.TextField" class="text-break">Class TextField
  74. </h1>
  75. <div class="markdown level0 summary">
  76. Single-line text entry <a class="xref" href="Terminal.Gui.View.html">View</a>
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritance">
  80. <h5>Inheritance</h5>
  81. <div class="level0"><span class="xref">System.Object</span></div>
  82. <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
  83. <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
  84. <div class="level3"><span class="xref">TextField</span></div>
  85. <div class="level4"><a class="xref" href="Terminal.Gui.DateField.html">DateField</a></div>
  86. <div class="level4"><a class="xref" href="Terminal.Gui.TimeField.html">TimeField</a></div>
  87. </div>
  88. <div classs="implements">
  89. <h5>Implements</h5>
  90. <div><span class="xref">System.Collections.IEnumerable</span></div>
  91. </div>
  92. <div class="inheritedMembers">
  93. <h5>Inherited Members</h5>
  94. <div>
  95. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  96. </div>
  97. <div>
  98. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  99. </div>
  100. <div>
  101. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  102. </div>
  103. <div>
  104. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  105. </div>
  106. <div>
  107. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  108. </div>
  109. <div>
  110. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  111. </div>
  112. <div>
  113. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  114. </div>
  115. <div>
  116. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  117. </div>
  118. <div>
  119. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  120. </div>
  121. <div>
  122. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetEnumerator">View.GetEnumerator()</a>
  123. </div>
  124. <div>
  125. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  126. </div>
  127. <div>
  128. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  129. </div>
  130. <div>
  131. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  132. </div>
  133. <div>
  134. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  135. </div>
  136. <div>
  137. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  138. </div>
  139. <div>
  140. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  141. </div>
  142. <div>
  143. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  144. </div>
  145. <div>
  146. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  147. </div>
  148. <div>
  149. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  150. </div>
  151. <div>
  152. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
  153. </div>
  154. <div>
  155. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  156. </div>
  157. <div>
  158. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  159. </div>
  160. <div>
  161. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  162. </div>
  163. <div>
  164. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  165. </div>
  166. <div>
  167. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  168. </div>
  169. <div>
  170. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  171. </div>
  172. <div>
  173. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  174. </div>
  175. <div>
  176. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  177. </div>
  178. <div>
  179. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  180. </div>
  181. <div>
  182. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  183. </div>
  184. <div>
  185. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  186. </div>
  187. <div>
  188. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  189. </div>
  190. <div>
  191. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  192. </div>
  193. <div>
  194. <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>
  195. </div>
  196. <div>
  197. <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>
  198. </div>
  199. <div>
  200. <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>
  201. </div>
  202. <div>
  203. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  204. </div>
  205. <div>
  206. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  207. </div>
  208. <div>
  209. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter">View.OnEnter()</a>
  210. </div>
  211. <div>
  212. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  213. </div>
  214. <div>
  215. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  216. </div>
  217. <div>
  218. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  219. </div>
  220. <div>
  221. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  222. </div>
  223. <div>
  224. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  225. </div>
  226. <div>
  227. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus_Terminal_Gui_View_">View.SetFocus(View)</a>
  228. </div>
  229. <div>
  230. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  231. </div>
  232. <div>
  233. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  234. </div>
  235. <div>
  236. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  237. </div>
  238. <div>
  239. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  240. </div>
  241. <div>
  242. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  243. </div>
  244. <div>
  245. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  246. </div>
  247. <div>
  248. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  249. </div>
  250. <div>
  251. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  252. </div>
  253. <div>
  254. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  255. </div>
  256. <div>
  257. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  258. </div>
  259. <div>
  260. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  261. </div>
  262. <div>
  263. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  264. </div>
  265. <div>
  266. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  267. </div>
  268. <div>
  269. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  270. </div>
  271. <div>
  272. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  273. </div>
  274. <div>
  275. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  276. </div>
  277. <div>
  278. <span class="xref">System.Object.Equals(System.Object)</span>
  279. </div>
  280. <div>
  281. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  282. </div>
  283. <div>
  284. <span class="xref">System.Object.GetHashCode()</span>
  285. </div>
  286. <div>
  287. <span class="xref">System.Object.GetType()</span>
  288. </div>
  289. <div>
  290. <span class="xref">System.Object.MemberwiseClone()</span>
  291. </div>
  292. <div>
  293. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  294. </div>
  295. </div>
  296. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  297. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  298. <h5 id="Terminal_Gui_TextField_syntax">Syntax</h5>
  299. <div class="codewrapper">
  300. <pre><code class="lang-csharp hljs">public class TextField : View, IEnumerable</code></pre>
  301. </div>
  302. <h5 id="Terminal_Gui_TextField_remarks"><strong>Remarks</strong></h5>
  303. <div class="markdown level0 remarks">
  304. 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.
  305. </div>
  306. <h3 id="constructors">Constructors
  307. </h3>
  308. <a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
  309. <h4 id="Terminal_Gui_TextField__ctor_NStack_ustring_" data-uid="Terminal.Gui.TextField.#ctor(NStack.ustring)">TextField(ustring)</h4>
  310. <div class="markdown level1 summary">
  311. Public constructor that creates a text field, with layout controlled with X, Y, Width and Height.
  312. </div>
  313. <div class="markdown level1 conceptual"></div>
  314. <h5 class="decalaration">Declaration</h5>
  315. <div class="codewrapper">
  316. <pre><code class="lang-csharp hljs">public TextField(ustring text)</code></pre>
  317. </div>
  318. <h5 class="parameters">Parameters</h5>
  319. <table class="table table-bordered table-striped table-condensed">
  320. <thead>
  321. <tr>
  322. <th>Type</th>
  323. <th>Name</th>
  324. <th>Description</th>
  325. </tr>
  326. </thead>
  327. <tbody>
  328. <tr>
  329. <td><span class="xref">NStack.ustring</span></td>
  330. <td><span class="parametername">text</span></td>
  331. <td>Initial text contents.</td>
  332. </tr>
  333. </tbody>
  334. </table>
  335. <a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
  336. <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>
  337. <div class="markdown level1 summary">
  338. Public constructor that creates a text field at an absolute position and size.
  339. </div>
  340. <div class="markdown level1 conceptual"></div>
  341. <h5 class="decalaration">Declaration</h5>
  342. <div class="codewrapper">
  343. <pre><code class="lang-csharp hljs">public TextField(int x, int y, int w, ustring text)</code></pre>
  344. </div>
  345. <h5 class="parameters">Parameters</h5>
  346. <table class="table table-bordered table-striped table-condensed">
  347. <thead>
  348. <tr>
  349. <th>Type</th>
  350. <th>Name</th>
  351. <th>Description</th>
  352. </tr>
  353. </thead>
  354. <tbody>
  355. <tr>
  356. <td><span class="xref">System.Int32</span></td>
  357. <td><span class="parametername">x</span></td>
  358. <td>The x coordinate.</td>
  359. </tr>
  360. <tr>
  361. <td><span class="xref">System.Int32</span></td>
  362. <td><span class="parametername">y</span></td>
  363. <td>The y coordinate.</td>
  364. </tr>
  365. <tr>
  366. <td><span class="xref">System.Int32</span></td>
  367. <td><span class="parametername">w</span></td>
  368. <td>The width.</td>
  369. </tr>
  370. <tr>
  371. <td><span class="xref">NStack.ustring</span></td>
  372. <td><span class="parametername">text</span></td>
  373. <td>Initial text contents.</td>
  374. </tr>
  375. </tbody>
  376. </table>
  377. <a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
  378. <h4 id="Terminal_Gui_TextField__ctor_System_String_" data-uid="Terminal.Gui.TextField.#ctor(System.String)">TextField(String)</h4>
  379. <div class="markdown level1 summary">
  380. Public constructor that creates a text field, with layout controlled with X, Y, Width and Height.
  381. </div>
  382. <div class="markdown level1 conceptual"></div>
  383. <h5 class="decalaration">Declaration</h5>
  384. <div class="codewrapper">
  385. <pre><code class="lang-csharp hljs">public TextField(string text)</code></pre>
  386. </div>
  387. <h5 class="parameters">Parameters</h5>
  388. <table class="table table-bordered table-striped table-condensed">
  389. <thead>
  390. <tr>
  391. <th>Type</th>
  392. <th>Name</th>
  393. <th>Description</th>
  394. </tr>
  395. </thead>
  396. <tbody>
  397. <tr>
  398. <td><span class="xref">System.String</span></td>
  399. <td><span class="parametername">text</span></td>
  400. <td>Initial text contents.</td>
  401. </tr>
  402. </tbody>
  403. </table>
  404. <h3 id="properties">Properties
  405. </h3>
  406. <a id="Terminal_Gui_TextField_CanFocus_" data-uid="Terminal.Gui.TextField.CanFocus*"></a>
  407. <h4 id="Terminal_Gui_TextField_CanFocus" data-uid="Terminal.Gui.TextField.CanFocus">CanFocus</h4>
  408. <div class="markdown level1 summary"></div>
  409. <div class="markdown level1 conceptual"></div>
  410. <h5 class="decalaration">Declaration</h5>
  411. <div class="codewrapper">
  412. <pre><code class="lang-csharp hljs">public override bool CanFocus { get; set; }</code></pre>
  413. </div>
  414. <h5 class="propertyValue">Property Value</h5>
  415. <table class="table table-bordered table-striped table-condensed">
  416. <thead>
  417. <tr>
  418. <th>Type</th>
  419. <th>Description</th>
  420. </tr>
  421. </thead>
  422. <tbody>
  423. <tr>
  424. <td><span class="xref">System.Boolean</span></td>
  425. <td></td>
  426. </tr>
  427. </tbody>
  428. </table>
  429. <h5 class="overrides">Overrides</h5>
  430. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_CanFocus">Responder.CanFocus</a></div>
  431. <a id="Terminal_Gui_TextField_CursorPosition_" data-uid="Terminal.Gui.TextField.CursorPosition*"></a>
  432. <h4 id="Terminal_Gui_TextField_CursorPosition" data-uid="Terminal.Gui.TextField.CursorPosition">CursorPosition</h4>
  433. <div class="markdown level1 summary">
  434. Sets or gets the current cursor position.
  435. </div>
  436. <div class="markdown level1 conceptual"></div>
  437. <h5 class="decalaration">Declaration</h5>
  438. <div class="codewrapper">
  439. <pre><code class="lang-csharp hljs">public int CursorPosition { get; set; }</code></pre>
  440. </div>
  441. <h5 class="propertyValue">Property Value</h5>
  442. <table class="table table-bordered table-striped table-condensed">
  443. <thead>
  444. <tr>
  445. <th>Type</th>
  446. <th>Description</th>
  447. </tr>
  448. </thead>
  449. <tbody>
  450. <tr>
  451. <td><span class="xref">System.Int32</span></td>
  452. <td></td>
  453. </tr>
  454. </tbody>
  455. </table>
  456. <a id="Terminal_Gui_TextField_Frame_" data-uid="Terminal.Gui.TextField.Frame*"></a>
  457. <h4 id="Terminal_Gui_TextField_Frame" data-uid="Terminal.Gui.TextField.Frame">Frame</h4>
  458. <div class="markdown level1 summary"></div>
  459. <div class="markdown level1 conceptual"></div>
  460. <h5 class="decalaration">Declaration</h5>
  461. <div class="codewrapper">
  462. <pre><code class="lang-csharp hljs">public override Rect Frame { get; set; }</code></pre>
  463. </div>
  464. <h5 class="propertyValue">Property Value</h5>
  465. <table class="table table-bordered table-striped table-condensed">
  466. <thead>
  467. <tr>
  468. <th>Type</th>
  469. <th>Description</th>
  470. </tr>
  471. </thead>
  472. <tbody>
  473. <tr>
  474. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  475. <td></td>
  476. </tr>
  477. </tbody>
  478. </table>
  479. <h5 class="overrides">Overrides</h5>
  480. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a></div>
  481. <a id="Terminal_Gui_TextField_ReadOnly_" data-uid="Terminal.Gui.TextField.ReadOnly*"></a>
  482. <h4 id="Terminal_Gui_TextField_ReadOnly" data-uid="Terminal.Gui.TextField.ReadOnly">ReadOnly</h4>
  483. <div class="markdown level1 summary">
  484. If set to true its not allow any changes in the text.
  485. </div>
  486. <div class="markdown level1 conceptual"></div>
  487. <h5 class="decalaration">Declaration</h5>
  488. <div class="codewrapper">
  489. <pre><code class="lang-csharp hljs">public bool ReadOnly { get; set; }</code></pre>
  490. </div>
  491. <h5 class="propertyValue">Property Value</h5>
  492. <table class="table table-bordered table-striped table-condensed">
  493. <thead>
  494. <tr>
  495. <th>Type</th>
  496. <th>Description</th>
  497. </tr>
  498. </thead>
  499. <tbody>
  500. <tr>
  501. <td><span class="xref">System.Boolean</span></td>
  502. <td></td>
  503. </tr>
  504. </tbody>
  505. </table>
  506. <a id="Terminal_Gui_TextField_Secret_" data-uid="Terminal.Gui.TextField.Secret*"></a>
  507. <h4 id="Terminal_Gui_TextField_Secret" data-uid="Terminal.Gui.TextField.Secret">Secret</h4>
  508. <div class="markdown level1 summary">
  509. Sets the secret property.
  510. </div>
  511. <div class="markdown level1 conceptual"></div>
  512. <h5 class="decalaration">Declaration</h5>
  513. <div class="codewrapper">
  514. <pre><code class="lang-csharp hljs">public bool Secret { get; set; }</code></pre>
  515. </div>
  516. <h5 class="propertyValue">Property Value</h5>
  517. <table class="table table-bordered table-striped table-condensed">
  518. <thead>
  519. <tr>
  520. <th>Type</th>
  521. <th>Description</th>
  522. </tr>
  523. </thead>
  524. <tbody>
  525. <tr>
  526. <td><span class="xref">System.Boolean</span></td>
  527. <td></td>
  528. </tr>
  529. </tbody>
  530. </table>
  531. <h5 id="Terminal_Gui_TextField_Secret_remarks">Remarks</h5>
  532. <div class="markdown level1 remarks">
  533. This makes the text entry suitable for entering passwords.
  534. </div>
  535. <a id="Terminal_Gui_TextField_SelectedLength_" data-uid="Terminal.Gui.TextField.SelectedLength*"></a>
  536. <h4 id="Terminal_Gui_TextField_SelectedLength" data-uid="Terminal.Gui.TextField.SelectedLength">SelectedLength</h4>
  537. <div class="markdown level1 summary">
  538. Length of the selected text.
  539. </div>
  540. <div class="markdown level1 conceptual"></div>
  541. <h5 class="decalaration">Declaration</h5>
  542. <div class="codewrapper">
  543. <pre><code class="lang-csharp hljs">public int SelectedLength { get; set; }</code></pre>
  544. </div>
  545. <h5 class="propertyValue">Property Value</h5>
  546. <table class="table table-bordered table-striped table-condensed">
  547. <thead>
  548. <tr>
  549. <th>Type</th>
  550. <th>Description</th>
  551. </tr>
  552. </thead>
  553. <tbody>
  554. <tr>
  555. <td><span class="xref">System.Int32</span></td>
  556. <td></td>
  557. </tr>
  558. </tbody>
  559. </table>
  560. <a id="Terminal_Gui_TextField_SelectedStart_" data-uid="Terminal.Gui.TextField.SelectedStart*"></a>
  561. <h4 id="Terminal_Gui_TextField_SelectedStart" data-uid="Terminal.Gui.TextField.SelectedStart">SelectedStart</h4>
  562. <div class="markdown level1 summary">
  563. Start position of the selected text.
  564. </div>
  565. <div class="markdown level1 conceptual"></div>
  566. <h5 class="decalaration">Declaration</h5>
  567. <div class="codewrapper">
  568. <pre><code class="lang-csharp hljs">public int SelectedStart { get; set; }</code></pre>
  569. </div>
  570. <h5 class="propertyValue">Property Value</h5>
  571. <table class="table table-bordered table-striped table-condensed">
  572. <thead>
  573. <tr>
  574. <th>Type</th>
  575. <th>Description</th>
  576. </tr>
  577. </thead>
  578. <tbody>
  579. <tr>
  580. <td><span class="xref">System.Int32</span></td>
  581. <td></td>
  582. </tr>
  583. </tbody>
  584. </table>
  585. <a id="Terminal_Gui_TextField_SelectedText_" data-uid="Terminal.Gui.TextField.SelectedText*"></a>
  586. <h4 id="Terminal_Gui_TextField_SelectedText" data-uid="Terminal.Gui.TextField.SelectedText">SelectedText</h4>
  587. <div class="markdown level1 summary">
  588. The selected text.
  589. </div>
  590. <div class="markdown level1 conceptual"></div>
  591. <h5 class="decalaration">Declaration</h5>
  592. <div class="codewrapper">
  593. <pre><code class="lang-csharp hljs">public ustring SelectedText { get; set; }</code></pre>
  594. </div>
  595. <h5 class="propertyValue">Property Value</h5>
  596. <table class="table table-bordered table-striped table-condensed">
  597. <thead>
  598. <tr>
  599. <th>Type</th>
  600. <th>Description</th>
  601. </tr>
  602. </thead>
  603. <tbody>
  604. <tr>
  605. <td><span class="xref">NStack.ustring</span></td>
  606. <td></td>
  607. </tr>
  608. </tbody>
  609. </table>
  610. <a id="Terminal_Gui_TextField_Text_" data-uid="Terminal.Gui.TextField.Text*"></a>
  611. <h4 id="Terminal_Gui_TextField_Text" data-uid="Terminal.Gui.TextField.Text">Text</h4>
  612. <div class="markdown level1 summary">
  613. Sets or gets the text held by the view.
  614. </div>
  615. <div class="markdown level1 conceptual"></div>
  616. <h5 class="decalaration">Declaration</h5>
  617. <div class="codewrapper">
  618. <pre><code class="lang-csharp hljs">public ustring Text { get; set; }</code></pre>
  619. </div>
  620. <h5 class="propertyValue">Property Value</h5>
  621. <table class="table table-bordered table-striped table-condensed">
  622. <thead>
  623. <tr>
  624. <th>Type</th>
  625. <th>Description</th>
  626. </tr>
  627. </thead>
  628. <tbody>
  629. <tr>
  630. <td><span class="xref">NStack.ustring</span></td>
  631. <td></td>
  632. </tr>
  633. </tbody>
  634. </table>
  635. <h5 id="Terminal_Gui_TextField_Text_remarks">Remarks</h5>
  636. <div class="markdown level1 remarks">
  637. </div>
  638. <a id="Terminal_Gui_TextField_Used_" data-uid="Terminal.Gui.TextField.Used*"></a>
  639. <h4 id="Terminal_Gui_TextField_Used" data-uid="Terminal.Gui.TextField.Used">Used</h4>
  640. <div class="markdown level1 summary">
  641. 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
  642. </div>
  643. <div class="markdown level1 conceptual"></div>
  644. <h5 class="decalaration">Declaration</h5>
  645. <div class="codewrapper">
  646. <pre><code class="lang-csharp hljs">public bool Used { get; set; }</code></pre>
  647. </div>
  648. <h5 class="propertyValue">Property Value</h5>
  649. <table class="table table-bordered table-striped table-condensed">
  650. <thead>
  651. <tr>
  652. <th>Type</th>
  653. <th>Description</th>
  654. </tr>
  655. </thead>
  656. <tbody>
  657. <tr>
  658. <td><span class="xref">System.Boolean</span></td>
  659. <td></td>
  660. </tr>
  661. </tbody>
  662. </table>
  663. <h3 id="methods">Methods
  664. </h3>
  665. <a id="Terminal_Gui_TextField_ClearAllSelection_" data-uid="Terminal.Gui.TextField.ClearAllSelection*"></a>
  666. <h4 id="Terminal_Gui_TextField_ClearAllSelection" data-uid="Terminal.Gui.TextField.ClearAllSelection">ClearAllSelection()</h4>
  667. <div class="markdown level1 summary">
  668. Clear the selected text.
  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 void ClearAllSelection()</code></pre>
  674. </div>
  675. <a id="Terminal_Gui_TextField_Copy_" data-uid="Terminal.Gui.TextField.Copy*"></a>
  676. <h4 id="Terminal_Gui_TextField_Copy" data-uid="Terminal.Gui.TextField.Copy">Copy()</h4>
  677. <div class="markdown level1 summary">
  678. Copy the selected text to the clipboard.
  679. </div>
  680. <div class="markdown level1 conceptual"></div>
  681. <h5 class="decalaration">Declaration</h5>
  682. <div class="codewrapper">
  683. <pre><code class="lang-csharp hljs">public virtual void Copy()</code></pre>
  684. </div>
  685. <a id="Terminal_Gui_TextField_Cut_" data-uid="Terminal.Gui.TextField.Cut*"></a>
  686. <h4 id="Terminal_Gui_TextField_Cut" data-uid="Terminal.Gui.TextField.Cut">Cut()</h4>
  687. <div class="markdown level1 summary">
  688. Cut the selected text to the clipboard.
  689. </div>
  690. <div class="markdown level1 conceptual"></div>
  691. <h5 class="decalaration">Declaration</h5>
  692. <div class="codewrapper">
  693. <pre><code class="lang-csharp hljs">public virtual void Cut()</code></pre>
  694. </div>
  695. <a id="Terminal_Gui_TextField_MouseEvent_" data-uid="Terminal.Gui.TextField.MouseEvent*"></a>
  696. <h4 id="Terminal_Gui_TextField_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.TextField.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  697. <div class="markdown level1 summary"></div>
  698. <div class="markdown level1 conceptual"></div>
  699. <h5 class="decalaration">Declaration</h5>
  700. <div class="codewrapper">
  701. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent ev)</code></pre>
  702. </div>
  703. <h5 class="parameters">Parameters</h5>
  704. <table class="table table-bordered table-striped table-condensed">
  705. <thead>
  706. <tr>
  707. <th>Type</th>
  708. <th>Name</th>
  709. <th>Description</th>
  710. </tr>
  711. </thead>
  712. <tbody>
  713. <tr>
  714. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  715. <td><span class="parametername">ev</span></td>
  716. <td></td>
  717. </tr>
  718. </tbody>
  719. </table>
  720. <h5 class="returns">Returns</h5>
  721. <table class="table table-bordered table-striped table-condensed">
  722. <thead>
  723. <tr>
  724. <th>Type</th>
  725. <th>Description</th>
  726. </tr>
  727. </thead>
  728. <tbody>
  729. <tr>
  730. <td><span class="xref">System.Boolean</span></td>
  731. <td></td>
  732. </tr>
  733. </tbody>
  734. </table>
  735. <h5 class="overrides">Overrides</h5>
  736. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  737. <a id="Terminal_Gui_TextField_OnLeave_" data-uid="Terminal.Gui.TextField.OnLeave*"></a>
  738. <h4 id="Terminal_Gui_TextField_OnLeave" data-uid="Terminal.Gui.TextField.OnLeave">OnLeave()</h4>
  739. <div class="markdown level1 summary"></div>
  740. <div class="markdown level1 conceptual"></div>
  741. <h5 class="decalaration">Declaration</h5>
  742. <div class="codewrapper">
  743. <pre><code class="lang-csharp hljs">public override bool OnLeave()</code></pre>
  744. </div>
  745. <h5 class="returns">Returns</h5>
  746. <table class="table table-bordered table-striped table-condensed">
  747. <thead>
  748. <tr>
  749. <th>Type</th>
  750. <th>Description</th>
  751. </tr>
  752. </thead>
  753. <tbody>
  754. <tr>
  755. <td><span class="xref">System.Boolean</span></td>
  756. <td></td>
  757. </tr>
  758. </tbody>
  759. </table>
  760. <h5 class="overrides">Overrides</h5>
  761. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave">View.OnLeave()</a></div>
  762. <a id="Terminal_Gui_TextField_Paste_" data-uid="Terminal.Gui.TextField.Paste*"></a>
  763. <h4 id="Terminal_Gui_TextField_Paste" data-uid="Terminal.Gui.TextField.Paste">Paste()</h4>
  764. <div class="markdown level1 summary">
  765. Paste the selected text from the clipboard.
  766. </div>
  767. <div class="markdown level1 conceptual"></div>
  768. <h5 class="decalaration">Declaration</h5>
  769. <div class="codewrapper">
  770. <pre><code class="lang-csharp hljs">public virtual void Paste()</code></pre>
  771. </div>
  772. <a id="Terminal_Gui_TextField_PositionCursor_" data-uid="Terminal.Gui.TextField.PositionCursor*"></a>
  773. <h4 id="Terminal_Gui_TextField_PositionCursor" data-uid="Terminal.Gui.TextField.PositionCursor">PositionCursor()</h4>
  774. <div class="markdown level1 summary">
  775. Sets the cursor position.
  776. </div>
  777. <div class="markdown level1 conceptual"></div>
  778. <h5 class="decalaration">Declaration</h5>
  779. <div class="codewrapper">
  780. <pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
  781. </div>
  782. <h5 class="overrides">Overrides</h5>
  783. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
  784. <a id="Terminal_Gui_TextField_ProcessKey_" data-uid="Terminal.Gui.TextField.ProcessKey*"></a>
  785. <h4 id="Terminal_Gui_TextField_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.TextField.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  786. <div class="markdown level1 summary">
  787. Processes key presses for the <a class="xref" href="Terminal.Gui.TextField.html">TextField</a>.
  788. </div>
  789. <div class="markdown level1 conceptual"></div>
  790. <h5 class="decalaration">Declaration</h5>
  791. <div class="codewrapper">
  792. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent kb)</code></pre>
  793. </div>
  794. <h5 class="parameters">Parameters</h5>
  795. <table class="table table-bordered table-striped table-condensed">
  796. <thead>
  797. <tr>
  798. <th>Type</th>
  799. <th>Name</th>
  800. <th>Description</th>
  801. </tr>
  802. </thead>
  803. <tbody>
  804. <tr>
  805. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  806. <td><span class="parametername">kb</span></td>
  807. <td></td>
  808. </tr>
  809. </tbody>
  810. </table>
  811. <h5 class="returns">Returns</h5>
  812. <table class="table table-bordered table-striped table-condensed">
  813. <thead>
  814. <tr>
  815. <th>Type</th>
  816. <th>Description</th>
  817. </tr>
  818. </thead>
  819. <tbody>
  820. <tr>
  821. <td><span class="xref">System.Boolean</span></td>
  822. <td></td>
  823. </tr>
  824. </tbody>
  825. </table>
  826. <h5 class="overrides">Overrides</h5>
  827. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  828. <h5 id="Terminal_Gui_TextField_ProcessKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
  829. <div class="markdown level1 remarks">
  830. The <a class="xref" href="Terminal.Gui.TextField.html">TextField</a> control responds to the following keys:
  831. <table><thead><tr><th>Keys</th><th>Function</th></tr></thead><tbody><tr><td><a class="xref" href="Terminal.Gui.Key.html#Terminal_Gui_Key_Delete">Delete</a>, <a class="xref" href="Terminal.Gui.Key.html#Terminal_Gui_Key_Backspace">Backspace</a></td><td>Deletes the character before cursor.</td></tr></tbody></table>
  832. </div>
  833. <a id="Terminal_Gui_TextField_Redraw_" data-uid="Terminal.Gui.TextField.Redraw*"></a>
  834. <h4 id="Terminal_Gui_TextField_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.TextField.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  835. <div class="markdown level1 summary"></div>
  836. <div class="markdown level1 conceptual"></div>
  837. <h5 class="decalaration">Declaration</h5>
  838. <div class="codewrapper">
  839. <pre><code class="lang-csharp hljs">public override void Redraw(Rect region)</code></pre>
  840. </div>
  841. <h5 class="parameters">Parameters</h5>
  842. <table class="table table-bordered table-striped table-condensed">
  843. <thead>
  844. <tr>
  845. <th>Type</th>
  846. <th>Name</th>
  847. <th>Description</th>
  848. </tr>
  849. </thead>
  850. <tbody>
  851. <tr>
  852. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  853. <td><span class="parametername">region</span></td>
  854. <td></td>
  855. </tr>
  856. </tbody>
  857. </table>
  858. <h5 class="overrides">Overrides</h5>
  859. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  860. <h3 id="events">Events
  861. </h3>
  862. <h4 id="Terminal_Gui_TextField_Changed" data-uid="Terminal.Gui.TextField.Changed">Changed</h4>
  863. <div class="markdown level1 summary">
  864. Changed event, raised when the text has clicked.
  865. </div>
  866. <div class="markdown level1 conceptual"></div>
  867. <h5 class="decalaration">Declaration</h5>
  868. <div class="codewrapper">
  869. <pre><code class="lang-csharp hljs">public event EventHandler&lt;ustring&gt; Changed</code></pre>
  870. </div>
  871. <h5 class="eventType">Event Type</h5>
  872. <table class="table table-bordered table-striped table-condensed">
  873. <thead>
  874. <tr>
  875. <th>Type</th>
  876. <th>Description</th>
  877. </tr>
  878. </thead>
  879. <tbody>
  880. <tr>
  881. <td><span class="xref">System.EventHandler</span>&lt;<span class="xref">NStack.ustring</span>&gt;</td>
  882. <td></td>
  883. </tr>
  884. </tbody>
  885. </table>
  886. <h5 id="Terminal_Gui_TextField_Changed_remarks">Remarks</h5>
  887. <div class="markdown level1 remarks">
  888. Client code can hook up to this event, it is
  889. raised when the text in the entry changes.
  890. </div>
  891. <h3 id="implements">Implements</h3>
  892. <div>
  893. <span class="xref">System.Collections.IEnumerable</span>
  894. </div>
  895. </article>
  896. </div>
  897. <div class="hidden-sm col-md-2" role="complementary">
  898. <div class="sideaffix">
  899. <div class="contribution">
  900. <ul class="nav">
  901. </ul>
  902. </div>
  903. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  904. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  905. </nav>
  906. </div>
  907. </div>
  908. </div>
  909. </div>
  910. <footer>
  911. <div class="grad-bottom"></div>
  912. <div class="footer">
  913. <div class="container">
  914. <span class="pull-right">
  915. <a href="#top">Back to top</a>
  916. </span>
  917. <span>Generated by <strong>DocFX</strong></span>
  918. </div>
  919. </div>
  920. </footer>
  921. </div>
  922. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  923. <script type="text/javascript" src="../../styles/docfx.js"></script>
  924. <script type="text/javascript" src="../../styles/main.js"></script>
  925. </body>
  926. </html>