Terminal.Gui.TextField.html 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699
  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.18.2.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <meta property="docfx:navrel" content="">
  18. <meta property="docfx:tocrel" content="../toc.html">
  19. </head>
  20. <body data-spy="scroll" data-target="#affix">
  21. <div id="wrapper">
  22. <header>
  23. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  24. <div class="container">
  25. <div class="navbar-header">
  26. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  27. <span class="sr-only">Toggle navigation</span>
  28. <span class="icon-bar"></span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. </button>
  32. <a class="navbar-brand" href="../../index.html">
  33. <img id="logo" class="svg" src="../../logo.svg" alt="">
  34. </a>
  35. </div>
  36. <div class="collapse navbar-collapse" id="navbar">
  37. <form class="navbar-form navbar-right" role="search" id="search">
  38. <div class="form-group">
  39. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  40. </div>
  41. </form>
  42. </div>
  43. </div>
  44. </nav>
  45. <div class="subnav navbar navbar-default">
  46. <div class="container hide-when-search" id="breadcrumb">
  47. <ul class="breadcrumb">
  48. <li></li>
  49. </ul>
  50. </div>
  51. </div>
  52. </header>
  53. <div role="main" class="container body-content hide-when-search">
  54. <div class="sidenav hide-when-search">
  55. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  56. <div class="sidetoggle collapse" id="sidetoggle">
  57. <div id="sidetoc"></div>
  58. </div>
  59. </div>
  60. <div class="article row grid-right">
  61. <div class="col-md-10">
  62. <article class="content wrap" id="_content" data-uid="Terminal.Gui.TextField">
  63. <h1 id="Terminal_Gui_TextField" data-uid="Terminal.Gui.TextField">Class TextField
  64. </h1>
  65. <div class="markdown level0 summary"><p>Text data entry widget</p>
  66. </div>
  67. <div class="markdown level0 conceptual"></div>
  68. <div class="inheritance">
  69. <h5>Inheritance</h5>
  70. <div class="level0"><span class="xref">System.Object</span></div>
  71. <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
  72. <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
  73. <div class="level3"><span class="xref">TextField</span></div>
  74. </div>
  75. <div class="level4"><a class="xref" href="Terminal.Gui.TimeField.html">TimeField</a></div>
  76. <div class="inheritedMembers">
  77. <h5>Inherited Members</h5>
  78. <div>
  79. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  80. </div>
  81. <div>
  82. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  83. </div>
  84. <div>
  85. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  86. </div>
  87. <div>
  88. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  89. </div>
  90. <div>
  91. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
  92. </div>
  93. <div>
  94. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  95. </div>
  96. <div>
  97. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  98. </div>
  99. <div>
  100. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  101. </div>
  102. <div>
  103. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  104. </div>
  105. <div>
  106. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  107. </div>
  108. <div>
  109. <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>
  110. </div>
  111. <div>
  112. <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>
  113. </div>
  114. <div>
  115. <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>
  116. </div>
  117. <div>
  118. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  119. </div>
  120. <div>
  121. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  122. </div>
  123. <div>
  124. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  125. </div>
  126. <div>
  127. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  128. </div>
  129. <div>
  130. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  131. </div>
  132. <div>
  133. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  134. </div>
  135. <div>
  136. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  137. </div>
  138. <div>
  139. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetEnumerator">View.GetEnumerator()</a>
  140. </div>
  141. <div>
  142. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  143. </div>
  144. <div>
  145. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  146. </div>
  147. <div>
  148. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  149. </div>
  150. <div>
  151. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  152. </div>
  153. <div>
  154. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  155. </div>
  156. <div>
  157. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  158. </div>
  159. <div>
  160. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  161. </div>
  162. <div>
  163. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  164. </div>
  165. <div>
  166. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  167. </div>
  168. <div>
  169. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  170. </div>
  171. <div>
  172. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  173. </div>
  174. <div>
  175. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  176. </div>
  177. <div>
  178. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  179. </div>
  180. <div>
  181. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus_Terminal_Gui_View_">View.SetFocus(View)</a>
  182. </div>
  183. <div>
  184. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  185. </div>
  186. <div>
  187. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  188. </div>
  189. <div>
  190. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  191. </div>
  192. <div>
  193. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  194. </div>
  195. <div>
  196. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  197. </div>
  198. <div>
  199. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  200. </div>
  201. <div>
  202. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  203. </div>
  204. <div>
  205. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  206. </div>
  207. <div>
  208. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  209. </div>
  210. </div>
  211. <h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.Gui.html">Terminal.Gui</a></h6>
  212. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  213. <h5 id="Terminal_Gui_TextField_syntax">Syntax</h5>
  214. <div class="codewrapper">
  215. <pre><code class="lang-csharp hljs">public class TextField : Terminal.Gui.View</code></pre>
  216. </div>
  217. <h5 id="Terminal_Gui_TextField_remarks"><strong>Remarks</strong></h5>
  218. <div class="markdown level0 remarks"><p>The Entry widget provides Emacs-like editing
  219. functionality, and mouse support.</p>
  220. </div>
  221. <h3 id="constructors">Constructors
  222. </h3>
  223. <a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
  224. <h4 id="Terminal_Gui_TextField__ctor_NStack_ustring_" data-uid="Terminal.Gui.TextField.#ctor(NStack.ustring)">TextField(ustring)</h4>
  225. <div class="markdown level1 summary"><p>Public constructor that creates a text field, with layout controlled with X, Y, Width and Height.</p>
  226. </div>
  227. <div class="markdown level1 conceptual"></div>
  228. <h5 class="decalaration">Declaration</h5>
  229. <div class="codewrapper">
  230. <pre><code class="lang-csharp hljs">public TextField (NStack.ustring text);</code></pre>
  231. </div>
  232. <h5 class="parameters">Parameters</h5>
  233. <table class="table table-bordered table-striped table-condensed">
  234. <thead>
  235. <tr>
  236. <th>Type</th>
  237. <th>Name</th>
  238. <th>Description</th>
  239. </tr>
  240. </thead>
  241. <tbody>
  242. <tr>
  243. <td><span class="xref">NStack.ustring</span></td>
  244. <td><span class="parametername">text</span></td>
  245. <td><p>Initial text contents.</p>
  246. </td>
  247. </tr>
  248. </tbody>
  249. </table>
  250. <a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
  251. <h4 id="Terminal_Gui_TextField__ctor_System_String_" data-uid="Terminal.Gui.TextField.#ctor(System.String)">TextField(String)</h4>
  252. <div class="markdown level1 summary"><p>Public constructor that creates a text field, with layout controlled with X, Y, Width and Height.</p>
  253. </div>
  254. <div class="markdown level1 conceptual"></div>
  255. <h5 class="decalaration">Declaration</h5>
  256. <div class="codewrapper">
  257. <pre><code class="lang-csharp hljs">public TextField (string text);</code></pre>
  258. </div>
  259. <h5 class="parameters">Parameters</h5>
  260. <table class="table table-bordered table-striped table-condensed">
  261. <thead>
  262. <tr>
  263. <th>Type</th>
  264. <th>Name</th>
  265. <th>Description</th>
  266. </tr>
  267. </thead>
  268. <tbody>
  269. <tr>
  270. <td><span class="xref">System.String</span></td>
  271. <td><span class="parametername">text</span></td>
  272. <td><p>Initial text contents.</p>
  273. </td>
  274. </tr>
  275. </tbody>
  276. </table>
  277. <a id="Terminal_Gui_TextField__ctor_" data-uid="Terminal.Gui.TextField.#ctor*"></a>
  278. <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>
  279. <div class="markdown level1 summary"><p>Public constructor that creates a text field at an absolute position and size.</p>
  280. </div>
  281. <div class="markdown level1 conceptual"></div>
  282. <h5 class="decalaration">Declaration</h5>
  283. <div class="codewrapper">
  284. <pre><code class="lang-csharp hljs">public TextField (int x, int y, int w, NStack.ustring text);</code></pre>
  285. </div>
  286. <h5 class="parameters">Parameters</h5>
  287. <table class="table table-bordered table-striped table-condensed">
  288. <thead>
  289. <tr>
  290. <th>Type</th>
  291. <th>Name</th>
  292. <th>Description</th>
  293. </tr>
  294. </thead>
  295. <tbody>
  296. <tr>
  297. <td><span class="xref">System.Int32</span></td>
  298. <td><span class="parametername">x</span></td>
  299. <td><p>The x coordinate.</p>
  300. </td>
  301. </tr>
  302. <tr>
  303. <td><span class="xref">System.Int32</span></td>
  304. <td><span class="parametername">y</span></td>
  305. <td><p>The y coordinate.</p>
  306. </td>
  307. </tr>
  308. <tr>
  309. <td><span class="xref">System.Int32</span></td>
  310. <td><span class="parametername">w</span></td>
  311. <td><p>The width.</p>
  312. </td>
  313. </tr>
  314. <tr>
  315. <td><span class="xref">NStack.ustring</span></td>
  316. <td><span class="parametername">text</span></td>
  317. <td><p>Initial text contents.</p>
  318. </td>
  319. </tr>
  320. </tbody>
  321. </table>
  322. <h3 id="properties">Properties
  323. </h3>
  324. <a id="Terminal_Gui_TextField_CanFocus_" data-uid="Terminal.Gui.TextField.CanFocus*"></a>
  325. <h4 id="Terminal_Gui_TextField_CanFocus" data-uid="Terminal.Gui.TextField.CanFocus">CanFocus</h4>
  326. <div class="markdown level1 summary"></div>
  327. <div class="markdown level1 conceptual"></div>
  328. <h5 class="decalaration">Declaration</h5>
  329. <div class="codewrapper">
  330. <pre><code class="lang-csharp hljs">public override bool CanFocus { get; set; }</code></pre>
  331. </div>
  332. <h5 class="propertyValue">Property Value</h5>
  333. <table class="table table-bordered table-striped table-condensed">
  334. <thead>
  335. <tr>
  336. <th>Type</th>
  337. <th>Description</th>
  338. </tr>
  339. </thead>
  340. <tbody>
  341. <tr>
  342. <td><span class="xref">System.Boolean</span></td>
  343. <td><p>To be added.</p>
  344. </td>
  345. </tr>
  346. </tbody>
  347. </table>
  348. <a id="Terminal_Gui_TextField_CursorPosition_" data-uid="Terminal.Gui.TextField.CursorPosition*"></a>
  349. <h4 id="Terminal_Gui_TextField_CursorPosition" data-uid="Terminal.Gui.TextField.CursorPosition">CursorPosition</h4>
  350. <div class="markdown level1 summary"><p>Sets or gets the current cursor position.</p>
  351. </div>
  352. <div class="markdown level1 conceptual"></div>
  353. <h5 class="decalaration">Declaration</h5>
  354. <div class="codewrapper">
  355. <pre><code class="lang-csharp hljs">public int CursorPosition { get; set; }</code></pre>
  356. </div>
  357. <h5 class="propertyValue">Property Value</h5>
  358. <table class="table table-bordered table-striped table-condensed">
  359. <thead>
  360. <tr>
  361. <th>Type</th>
  362. <th>Description</th>
  363. </tr>
  364. </thead>
  365. <tbody>
  366. <tr>
  367. <td><span class="xref">System.Int32</span></td>
  368. <td><p>To be added.</p>
  369. </td>
  370. </tr>
  371. </tbody>
  372. </table>
  373. <a id="Terminal_Gui_TextField_Frame_" data-uid="Terminal.Gui.TextField.Frame*"></a>
  374. <h4 id="Terminal_Gui_TextField_Frame" data-uid="Terminal.Gui.TextField.Frame">Frame</h4>
  375. <div class="markdown level1 summary"></div>
  376. <div class="markdown level1 conceptual"></div>
  377. <h5 class="decalaration">Declaration</h5>
  378. <div class="codewrapper">
  379. <pre><code class="lang-csharp hljs">public override Terminal.Gui.Rect Frame { get; set; }</code></pre>
  380. </div>
  381. <h5 class="propertyValue">Property Value</h5>
  382. <table class="table table-bordered table-striped table-condensed">
  383. <thead>
  384. <tr>
  385. <th>Type</th>
  386. <th>Description</th>
  387. </tr>
  388. </thead>
  389. <tbody>
  390. <tr>
  391. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  392. <td><p>To be added.</p>
  393. </td>
  394. </tr>
  395. </tbody>
  396. </table>
  397. <a id="Terminal_Gui_TextField_Secret_" data-uid="Terminal.Gui.TextField.Secret*"></a>
  398. <h4 id="Terminal_Gui_TextField_Secret" data-uid="Terminal.Gui.TextField.Secret">Secret</h4>
  399. <div class="markdown level1 summary"><p>Sets the secret property.</p>
  400. </div>
  401. <div class="markdown level1 conceptual"></div>
  402. <h5 class="decalaration">Declaration</h5>
  403. <div class="codewrapper">
  404. <pre><code class="lang-csharp hljs">public bool Secret { get; set; }</code></pre>
  405. </div>
  406. <h5 class="propertyValue">Property Value</h5>
  407. <table class="table table-bordered table-striped table-condensed">
  408. <thead>
  409. <tr>
  410. <th>Type</th>
  411. <th>Description</th>
  412. </tr>
  413. </thead>
  414. <tbody>
  415. <tr>
  416. <td><span class="xref">System.Boolean</span></td>
  417. <td><p>To be added.</p>
  418. </td>
  419. </tr>
  420. </tbody>
  421. </table>
  422. <h5 id="Terminal_Gui_TextField_Secret_remarks">Remarks</h5>
  423. <div class="markdown level1 remarks"><p>This makes the text entry suitable for entering passwords.</p>
  424. </div>
  425. <a id="Terminal_Gui_TextField_Text_" data-uid="Terminal.Gui.TextField.Text*"></a>
  426. <h4 id="Terminal_Gui_TextField_Text" data-uid="Terminal.Gui.TextField.Text">Text</h4>
  427. <div class="markdown level1 summary"><p>Sets or gets the text in the entry.</p>
  428. </div>
  429. <div class="markdown level1 conceptual"></div>
  430. <h5 class="decalaration">Declaration</h5>
  431. <div class="codewrapper">
  432. <pre><code class="lang-csharp hljs">public NStack.ustring Text { get; set; }</code></pre>
  433. </div>
  434. <h5 class="propertyValue">Property Value</h5>
  435. <table class="table table-bordered table-striped table-condensed">
  436. <thead>
  437. <tr>
  438. <th>Type</th>
  439. <th>Description</th>
  440. </tr>
  441. </thead>
  442. <tbody>
  443. <tr>
  444. <td><span class="xref">NStack.ustring</span></td>
  445. <td><p>To be added.</p>
  446. </td>
  447. </tr>
  448. </tbody>
  449. </table>
  450. <a id="Terminal_Gui_TextField_Used_" data-uid="Terminal.Gui.TextField.Used*"></a>
  451. <h4 id="Terminal_Gui_TextField_Used" data-uid="Terminal.Gui.TextField.Used">Used</h4>
  452. <div class="markdown level1 summary"><p>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</p>
  453. </div>
  454. <div class="markdown level1 conceptual"></div>
  455. <h5 class="decalaration">Declaration</h5>
  456. <div class="codewrapper">
  457. <pre><code class="lang-csharp hljs">public bool Used { get; set; }</code></pre>
  458. </div>
  459. <h5 class="propertyValue">Property Value</h5>
  460. <table class="table table-bordered table-striped table-condensed">
  461. <thead>
  462. <tr>
  463. <th>Type</th>
  464. <th>Description</th>
  465. </tr>
  466. </thead>
  467. <tbody>
  468. <tr>
  469. <td><span class="xref">System.Boolean</span></td>
  470. <td><p>To be added.</p>
  471. </td>
  472. </tr>
  473. </tbody>
  474. </table>
  475. <h3 id="methods">Methods
  476. </h3>
  477. <a id="Terminal_Gui_TextField_MouseEvent_" data-uid="Terminal.Gui.TextField.MouseEvent*"></a>
  478. <h4 id="Terminal_Gui_TextField_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.TextField.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  479. <div class="markdown level1 summary"></div>
  480. <div class="markdown level1 conceptual"></div>
  481. <h5 class="decalaration">Declaration</h5>
  482. <div class="codewrapper">
  483. <pre><code class="lang-csharp hljs">public override bool MouseEvent (Terminal.Gui.MouseEvent ev);</code></pre>
  484. </div>
  485. <h5 class="parameters">Parameters</h5>
  486. <table class="table table-bordered table-striped table-condensed">
  487. <thead>
  488. <tr>
  489. <th>Type</th>
  490. <th>Name</th>
  491. <th>Description</th>
  492. </tr>
  493. </thead>
  494. <tbody>
  495. <tr>
  496. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  497. <td><span class="parametername">ev</span></td>
  498. <td><p>To be added.</p>
  499. </td>
  500. </tr>
  501. </tbody>
  502. </table>
  503. <h5 class="returns">Returns</h5>
  504. <table class="table table-bordered table-striped table-condensed">
  505. <thead>
  506. <tr>
  507. <th>Type</th>
  508. <th>Description</th>
  509. </tr>
  510. </thead>
  511. <tbody>
  512. <tr>
  513. <td><span class="xref">System.Boolean</span></td>
  514. <td><p>To be added.</p>
  515. </td>
  516. </tr>
  517. </tbody>
  518. </table>
  519. <a id="Terminal_Gui_TextField_PositionCursor_" data-uid="Terminal.Gui.TextField.PositionCursor*"></a>
  520. <h4 id="Terminal_Gui_TextField_PositionCursor" data-uid="Terminal.Gui.TextField.PositionCursor">PositionCursor()</h4>
  521. <div class="markdown level1 summary"><p>Sets the cursor position.</p>
  522. </div>
  523. <div class="markdown level1 conceptual"></div>
  524. <h5 class="decalaration">Declaration</h5>
  525. <div class="codewrapper">
  526. <pre><code class="lang-csharp hljs">public override void PositionCursor ();</code></pre>
  527. </div>
  528. <a id="Terminal_Gui_TextField_ProcessKey_" data-uid="Terminal.Gui.TextField.ProcessKey*"></a>
  529. <h4 id="Terminal_Gui_TextField_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.TextField.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  530. <div class="markdown level1 summary"></div>
  531. <div class="markdown level1 conceptual"></div>
  532. <h5 class="decalaration">Declaration</h5>
  533. <div class="codewrapper">
  534. <pre><code class="lang-csharp hljs">public override bool ProcessKey (Terminal.Gui.KeyEvent kb);</code></pre>
  535. </div>
  536. <h5 class="parameters">Parameters</h5>
  537. <table class="table table-bordered table-striped table-condensed">
  538. <thead>
  539. <tr>
  540. <th>Type</th>
  541. <th>Name</th>
  542. <th>Description</th>
  543. </tr>
  544. </thead>
  545. <tbody>
  546. <tr>
  547. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  548. <td><span class="parametername">kb</span></td>
  549. <td><p>To be added.</p>
  550. </td>
  551. </tr>
  552. </tbody>
  553. </table>
  554. <h5 class="returns">Returns</h5>
  555. <table class="table table-bordered table-striped table-condensed">
  556. <thead>
  557. <tr>
  558. <th>Type</th>
  559. <th>Description</th>
  560. </tr>
  561. </thead>
  562. <tbody>
  563. <tr>
  564. <td><span class="xref">System.Boolean</span></td>
  565. <td><p>To be added.</p>
  566. </td>
  567. </tr>
  568. </tbody>
  569. </table>
  570. <a id="Terminal_Gui_TextField_Redraw_" data-uid="Terminal.Gui.TextField.Redraw*"></a>
  571. <h4 id="Terminal_Gui_TextField_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.TextField.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  572. <div class="markdown level1 summary"></div>
  573. <div class="markdown level1 conceptual"></div>
  574. <h5 class="decalaration">Declaration</h5>
  575. <div class="codewrapper">
  576. <pre><code class="lang-csharp hljs">public override void Redraw (Terminal.Gui.Rect region);</code></pre>
  577. </div>
  578. <h5 class="parameters">Parameters</h5>
  579. <table class="table table-bordered table-striped table-condensed">
  580. <thead>
  581. <tr>
  582. <th>Type</th>
  583. <th>Name</th>
  584. <th>Description</th>
  585. </tr>
  586. </thead>
  587. <tbody>
  588. <tr>
  589. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  590. <td><span class="parametername">region</span></td>
  591. <td><p>To be added.</p>
  592. </td>
  593. </tr>
  594. </tbody>
  595. </table>
  596. <h3 id="events">Events
  597. </h3>
  598. <h4 id="Terminal_Gui_TextField_Changed" data-uid="Terminal.Gui.TextField.Changed">Changed</h4>
  599. <div class="markdown level1 summary"><p>Changed event, raised when the text has clicked.</p>
  600. </div>
  601. <div class="markdown level1 conceptual"></div>
  602. <h5 class="decalaration">Declaration</h5>
  603. <div class="codewrapper">
  604. <pre><code class="lang-csharp hljs">public event EventHandler Changed;</code></pre>
  605. </div>
  606. <h5 class="eventType">Event Type</h5>
  607. <table class="table table-bordered table-striped table-condensed">
  608. <thead>
  609. <tr>
  610. <th>Type</th>
  611. <th>Description</th>
  612. </tr>
  613. </thead>
  614. <tbody>
  615. <tr>
  616. <td><span class="xref">System.EventHandler</span></td>
  617. <td><p>To be added.</p>
  618. </td>
  619. </tr>
  620. </tbody>
  621. </table>
  622. <h5 id="Terminal_Gui_TextField_Changed_remarks">Remarks</h5>
  623. <div class="markdown level1 remarks"><p>Client code can hook up to this event, it is
  624. raised when the text in the entry changes.</p>
  625. </div>
  626. </article>
  627. </div>
  628. <div class="hidden-sm col-md-2" role="complementary">
  629. <div class="sideaffix">
  630. <div class="contribution">
  631. <ul class="nav">
  632. </ul>
  633. </div>
  634. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  635. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  636. </nav>
  637. </div>
  638. </div>
  639. </div>
  640. </div>
  641. <footer>
  642. <div class="grad-bottom"></div>
  643. <div class="footer">
  644. <div class="container">
  645. <span class="pull-right">
  646. <a href="#top">Back to top</a>
  647. </span>
  648. <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
  649. </div>
  650. </div>
  651. </footer>
  652. </div>
  653. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  654. <script type="text/javascript" src="../../styles/docfx.js"></script>
  655. <script type="text/javascript" src="../../styles/main.js"></script>
  656. </body>
  657. </html>