Terminal.Gui.TextView.html 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874
  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 TextView
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class TextView
  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.TextView">
  73. <h1 id="Terminal_Gui_TextView" data-uid="Terminal.Gui.TextView" class="text-break">Class TextView
  74. </h1>
  75. <div class="markdown level0 summary">
  76. Multi-line text editing <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">TextView</span></div>
  85. </div>
  86. <div classs="implements">
  87. <h5>Implements</h5>
  88. <div><span class="xref">System.Collections.IEnumerable</span></div>
  89. </div>
  90. <div class="inheritedMembers">
  91. <h5>Inherited Members</h5>
  92. <div>
  93. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  94. </div>
  95. <div>
  96. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  97. </div>
  98. <div>
  99. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  100. </div>
  101. <div>
  102. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  103. </div>
  104. <div>
  105. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  106. </div>
  107. <div>
  108. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  109. </div>
  110. <div>
  111. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  112. </div>
  113. <div>
  114. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  115. </div>
  116. <div>
  117. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  118. </div>
  119. <div>
  120. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  121. </div>
  122. <div>
  123. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetEnumerator">View.GetEnumerator()</a>
  124. </div>
  125. <div>
  126. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  127. </div>
  128. <div>
  129. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  130. </div>
  131. <div>
  132. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  133. </div>
  134. <div>
  135. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  136. </div>
  137. <div>
  138. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  139. </div>
  140. <div>
  141. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  142. </div>
  143. <div>
  144. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  145. </div>
  146. <div>
  147. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  148. </div>
  149. <div>
  150. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  151. </div>
  152. <div>
  153. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
  154. </div>
  155. <div>
  156. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  157. </div>
  158. <div>
  159. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  160. </div>
  161. <div>
  162. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  163. </div>
  164. <div>
  165. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  166. </div>
  167. <div>
  168. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  169. </div>
  170. <div>
  171. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  172. </div>
  173. <div>
  174. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  175. </div>
  176. <div>
  177. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  178. </div>
  179. <div>
  180. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  181. </div>
  182. <div>
  183. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  184. </div>
  185. <div>
  186. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  187. </div>
  188. <div>
  189. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  190. </div>
  191. <div>
  192. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  193. </div>
  194. <div>
  195. <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>
  196. </div>
  197. <div>
  198. <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>
  199. </div>
  200. <div>
  201. <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>
  202. </div>
  203. <div>
  204. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  205. </div>
  206. <div>
  207. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  208. </div>
  209. <div>
  210. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter">View.OnEnter()</a>
  211. </div>
  212. <div>
  213. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave">View.OnLeave()</a>
  214. </div>
  215. <div>
  216. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  217. </div>
  218. <div>
  219. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  220. </div>
  221. <div>
  222. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  223. </div>
  224. <div>
  225. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  226. </div>
  227. <div>
  228. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  229. </div>
  230. <div>
  231. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus_Terminal_Gui_View_">View.SetFocus(View)</a>
  232. </div>
  233. <div>
  234. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  235. </div>
  236. <div>
  237. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  238. </div>
  239. <div>
  240. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  241. </div>
  242. <div>
  243. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  244. </div>
  245. <div>
  246. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  247. </div>
  248. <div>
  249. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  250. </div>
  251. <div>
  252. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  253. </div>
  254. <div>
  255. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  256. </div>
  257. <div>
  258. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  259. </div>
  260. <div>
  261. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  262. </div>
  263. <div>
  264. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  265. </div>
  266. <div>
  267. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  268. </div>
  269. <div>
  270. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  271. </div>
  272. <div>
  273. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  274. </div>
  275. <div>
  276. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  277. </div>
  278. <div>
  279. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  280. </div>
  281. <div>
  282. <span class="xref">System.Object.Equals(System.Object)</span>
  283. </div>
  284. <div>
  285. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  286. </div>
  287. <div>
  288. <span class="xref">System.Object.GetHashCode()</span>
  289. </div>
  290. <div>
  291. <span class="xref">System.Object.GetType()</span>
  292. </div>
  293. <div>
  294. <span class="xref">System.Object.MemberwiseClone()</span>
  295. </div>
  296. <div>
  297. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  298. </div>
  299. </div>
  300. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  301. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  302. <h5 id="Terminal_Gui_TextView_syntax">Syntax</h5>
  303. <div class="codewrapper">
  304. <pre><code class="lang-csharp hljs">public class TextView : View, IEnumerable</code></pre>
  305. </div>
  306. <h5 id="Terminal_Gui_TextView_remarks"><strong>Remarks</strong></h5>
  307. <div class="markdown level0 remarks">
  308. <p>
  309. <a class="xref" href="Terminal.Gui.TextView.html">TextView</a> provides a multi-line text editor. Users interact
  310. with it with the standard Emacs commands for movement or the arrow
  311. keys.
  312. </p>
  313. <table><thead><tr><th>Shortcut</th><th>Action performed</th></tr></thead><tbody><tr><td>Left cursor, Control-b</td><td>
  314. Moves the editing point left.
  315. </td></tr><tr><td>Right cursor, Control-f</td><td>
  316. Moves the editing point right.
  317. </td></tr><tr><td>Alt-b</td><td>
  318. Moves one word back.
  319. </td></tr><tr><td>Alt-f</td><td>
  320. Moves one word forward.
  321. </td></tr><tr><td>Up cursor, Control-p</td><td>
  322. Moves the editing point one line up.
  323. </td></tr><tr><td>Down cursor, Control-n</td><td>
  324. Moves the editing point one line down
  325. </td></tr><tr><td>Home key, Control-a</td><td>
  326. Moves the cursor to the beginning of the line.
  327. </td></tr><tr><td>End key, Control-e</td><td>
  328. Moves the cursor to the end of the line.
  329. </td></tr><tr><td>Delete, Control-d</td><td>
  330. Deletes the character in front of the cursor.
  331. </td></tr><tr><td>Backspace</td><td>
  332. Deletes the character behind the cursor.
  333. </td></tr><tr><td>Control-k</td><td>
  334. Deletes the text until the end of the line and replaces the kill buffer
  335. with the deleted text. You can paste this text in a different place by
  336. using Control-y.
  337. </td></tr><tr><td>Control-y</td><td>
  338. Pastes the content of the kill ring into the current position.
  339. </td></tr><tr><td>Alt-d</td><td>
  340. Deletes the word above the cursor and adds it to the kill ring. You
  341. can paste the contents of the kill ring with Control-y.
  342. </td></tr><tr><td>Control-q</td><td>
  343. Quotes the next input character, to prevent the normal processing of
  344. key handling to take place.
  345. </td></tr></tbody></table>
  346. </div>
  347. <h3 id="constructors">Constructors
  348. </h3>
  349. <a id="Terminal_Gui_TextView__ctor_" data-uid="Terminal.Gui.TextView.#ctor*"></a>
  350. <h4 id="Terminal_Gui_TextView__ctor" data-uid="Terminal.Gui.TextView.#ctor">TextView()</h4>
  351. <div class="markdown level1 summary">
  352. Initalizes a <a class="xref" href="Terminal.Gui.TextView.html">TextView</a> on the specified area,
  353. with dimensions controlled with the X, Y, Width and Height properties.
  354. </div>
  355. <div class="markdown level1 conceptual"></div>
  356. <h5 class="decalaration">Declaration</h5>
  357. <div class="codewrapper">
  358. <pre><code class="lang-csharp hljs">public TextView()</code></pre>
  359. </div>
  360. <a id="Terminal_Gui_TextView__ctor_" data-uid="Terminal.Gui.TextView.#ctor*"></a>
  361. <h4 id="Terminal_Gui_TextView__ctor_Terminal_Gui_Rect_" data-uid="Terminal.Gui.TextView.#ctor(Terminal.Gui.Rect)">TextView(Rect)</h4>
  362. <div class="markdown level1 summary">
  363. Initalizes a <a class="xref" href="Terminal.Gui.TextView.html">TextView</a> on the specified area, with absolute position and size.
  364. </div>
  365. <div class="markdown level1 conceptual"></div>
  366. <h5 class="decalaration">Declaration</h5>
  367. <div class="codewrapper">
  368. <pre><code class="lang-csharp hljs">public TextView(Rect frame)</code></pre>
  369. </div>
  370. <h5 class="parameters">Parameters</h5>
  371. <table class="table table-bordered table-striped table-condensed">
  372. <thead>
  373. <tr>
  374. <th>Type</th>
  375. <th>Name</th>
  376. <th>Description</th>
  377. </tr>
  378. </thead>
  379. <tbody>
  380. <tr>
  381. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  382. <td><span class="parametername">frame</span></td>
  383. <td></td>
  384. </tr>
  385. </tbody>
  386. </table>
  387. <h5 id="Terminal_Gui_TextView__ctor_Terminal_Gui_Rect__remarks">Remarks</h5>
  388. <div class="markdown level1 remarks">
  389. </div>
  390. <h3 id="properties">Properties
  391. </h3>
  392. <a id="Terminal_Gui_TextView_CanFocus_" data-uid="Terminal.Gui.TextView.CanFocus*"></a>
  393. <h4 id="Terminal_Gui_TextView_CanFocus" data-uid="Terminal.Gui.TextView.CanFocus">CanFocus</h4>
  394. <div class="markdown level1 summary"></div>
  395. <div class="markdown level1 conceptual"></div>
  396. <h5 class="decalaration">Declaration</h5>
  397. <div class="codewrapper">
  398. <pre><code class="lang-csharp hljs">public override bool CanFocus { get; set; }</code></pre>
  399. </div>
  400. <h5 class="propertyValue">Property Value</h5>
  401. <table class="table table-bordered table-striped table-condensed">
  402. <thead>
  403. <tr>
  404. <th>Type</th>
  405. <th>Description</th>
  406. </tr>
  407. </thead>
  408. <tbody>
  409. <tr>
  410. <td><span class="xref">System.Boolean</span></td>
  411. <td></td>
  412. </tr>
  413. </tbody>
  414. </table>
  415. <h5 class="overrides">Overrides</h5>
  416. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_CanFocus">Responder.CanFocus</a></div>
  417. <a id="Terminal_Gui_TextView_CurrentColumn_" data-uid="Terminal.Gui.TextView.CurrentColumn*"></a>
  418. <h4 id="Terminal_Gui_TextView_CurrentColumn" data-uid="Terminal.Gui.TextView.CurrentColumn">CurrentColumn</h4>
  419. <div class="markdown level1 summary">
  420. Gets the cursor column.
  421. </div>
  422. <div class="markdown level1 conceptual"></div>
  423. <h5 class="decalaration">Declaration</h5>
  424. <div class="codewrapper">
  425. <pre><code class="lang-csharp hljs">public int CurrentColumn { get; }</code></pre>
  426. </div>
  427. <h5 class="propertyValue">Property Value</h5>
  428. <table class="table table-bordered table-striped table-condensed">
  429. <thead>
  430. <tr>
  431. <th>Type</th>
  432. <th>Description</th>
  433. </tr>
  434. </thead>
  435. <tbody>
  436. <tr>
  437. <td><span class="xref">System.Int32</span></td>
  438. <td>The cursor column.</td>
  439. </tr>
  440. </tbody>
  441. </table>
  442. <a id="Terminal_Gui_TextView_CurrentRow_" data-uid="Terminal.Gui.TextView.CurrentRow*"></a>
  443. <h4 id="Terminal_Gui_TextView_CurrentRow" data-uid="Terminal.Gui.TextView.CurrentRow">CurrentRow</h4>
  444. <div class="markdown level1 summary">
  445. Gets the current cursor row.
  446. </div>
  447. <div class="markdown level1 conceptual"></div>
  448. <h5 class="decalaration">Declaration</h5>
  449. <div class="codewrapper">
  450. <pre><code class="lang-csharp hljs">public int CurrentRow { get; }</code></pre>
  451. </div>
  452. <h5 class="propertyValue">Property Value</h5>
  453. <table class="table table-bordered table-striped table-condensed">
  454. <thead>
  455. <tr>
  456. <th>Type</th>
  457. <th>Description</th>
  458. </tr>
  459. </thead>
  460. <tbody>
  461. <tr>
  462. <td><span class="xref">System.Int32</span></td>
  463. <td></td>
  464. </tr>
  465. </tbody>
  466. </table>
  467. <a id="Terminal_Gui_TextView_ReadOnly_" data-uid="Terminal.Gui.TextView.ReadOnly*"></a>
  468. <h4 id="Terminal_Gui_TextView_ReadOnly" data-uid="Terminal.Gui.TextView.ReadOnly">ReadOnly</h4>
  469. <div class="markdown level1 summary">
  470. Gets or sets whether the <a class="xref" href="Terminal.Gui.TextView.html">TextView</a> is in read-only mode or not
  471. </div>
  472. <div class="markdown level1 conceptual"></div>
  473. <h5 class="decalaration">Declaration</h5>
  474. <div class="codewrapper">
  475. <pre><code class="lang-csharp hljs">public bool ReadOnly { get; set; }</code></pre>
  476. </div>
  477. <h5 class="propertyValue">Property Value</h5>
  478. <table class="table table-bordered table-striped table-condensed">
  479. <thead>
  480. <tr>
  481. <th>Type</th>
  482. <th>Description</th>
  483. </tr>
  484. </thead>
  485. <tbody>
  486. <tr>
  487. <td><span class="xref">System.Boolean</span></td>
  488. <td>Boolean value(Default false)</td>
  489. </tr>
  490. </tbody>
  491. </table>
  492. <a id="Terminal_Gui_TextView_Text_" data-uid="Terminal.Gui.TextView.Text*"></a>
  493. <h4 id="Terminal_Gui_TextView_Text" data-uid="Terminal.Gui.TextView.Text">Text</h4>
  494. <div class="markdown level1 summary">
  495. Sets or gets the text in the <a class="xref" href="Terminal.Gui.TextView.html">TextView</a>.
  496. </div>
  497. <div class="markdown level1 conceptual"></div>
  498. <h5 class="decalaration">Declaration</h5>
  499. <div class="codewrapper">
  500. <pre><code class="lang-csharp hljs">public ustring Text { get; set; }</code></pre>
  501. </div>
  502. <h5 class="propertyValue">Property Value</h5>
  503. <table class="table table-bordered table-striped table-condensed">
  504. <thead>
  505. <tr>
  506. <th>Type</th>
  507. <th>Description</th>
  508. </tr>
  509. </thead>
  510. <tbody>
  511. <tr>
  512. <td><span class="xref">NStack.ustring</span></td>
  513. <td></td>
  514. </tr>
  515. </tbody>
  516. </table>
  517. <h5 id="Terminal_Gui_TextView_Text_remarks">Remarks</h5>
  518. <div class="markdown level1 remarks">
  519. </div>
  520. <h3 id="methods">Methods
  521. </h3>
  522. <a id="Terminal_Gui_TextView_CloseFile_" data-uid="Terminal.Gui.TextView.CloseFile*"></a>
  523. <h4 id="Terminal_Gui_TextView_CloseFile" data-uid="Terminal.Gui.TextView.CloseFile">CloseFile()</h4>
  524. <div class="markdown level1 summary">
  525. Closes the contents of the stream into the <a class="xref" href="Terminal.Gui.TextView.html">TextView</a>.
  526. </div>
  527. <div class="markdown level1 conceptual"></div>
  528. <h5 class="decalaration">Declaration</h5>
  529. <div class="codewrapper">
  530. <pre><code class="lang-csharp hljs">public bool CloseFile()</code></pre>
  531. </div>
  532. <h5 class="returns">Returns</h5>
  533. <table class="table table-bordered table-striped table-condensed">
  534. <thead>
  535. <tr>
  536. <th>Type</th>
  537. <th>Description</th>
  538. </tr>
  539. </thead>
  540. <tbody>
  541. <tr>
  542. <td><span class="xref">System.Boolean</span></td>
  543. <td><code>true</code>, if stream was closed, <code>false</code> otherwise.</td>
  544. </tr>
  545. </tbody>
  546. </table>
  547. <a id="Terminal_Gui_TextView_LoadFile_" data-uid="Terminal.Gui.TextView.LoadFile*"></a>
  548. <h4 id="Terminal_Gui_TextView_LoadFile_System_String_" data-uid="Terminal.Gui.TextView.LoadFile(System.String)">LoadFile(String)</h4>
  549. <div class="markdown level1 summary">
  550. Loads the contents of the file into the <a class="xref" href="Terminal.Gui.TextView.html">TextView</a>.
  551. </div>
  552. <div class="markdown level1 conceptual"></div>
  553. <h5 class="decalaration">Declaration</h5>
  554. <div class="codewrapper">
  555. <pre><code class="lang-csharp hljs">public bool LoadFile(string path)</code></pre>
  556. </div>
  557. <h5 class="parameters">Parameters</h5>
  558. <table class="table table-bordered table-striped table-condensed">
  559. <thead>
  560. <tr>
  561. <th>Type</th>
  562. <th>Name</th>
  563. <th>Description</th>
  564. </tr>
  565. </thead>
  566. <tbody>
  567. <tr>
  568. <td><span class="xref">System.String</span></td>
  569. <td><span class="parametername">path</span></td>
  570. <td>Path to the file to load.</td>
  571. </tr>
  572. </tbody>
  573. </table>
  574. <h5 class="returns">Returns</h5>
  575. <table class="table table-bordered table-striped table-condensed">
  576. <thead>
  577. <tr>
  578. <th>Type</th>
  579. <th>Description</th>
  580. </tr>
  581. </thead>
  582. <tbody>
  583. <tr>
  584. <td><span class="xref">System.Boolean</span></td>
  585. <td><code>true</code>, if file was loaded, <code>false</code> otherwise.</td>
  586. </tr>
  587. </tbody>
  588. </table>
  589. <a id="Terminal_Gui_TextView_LoadStream_" data-uid="Terminal.Gui.TextView.LoadStream*"></a>
  590. <h4 id="Terminal_Gui_TextView_LoadStream_System_IO_Stream_" data-uid="Terminal.Gui.TextView.LoadStream(System.IO.Stream)">LoadStream(Stream)</h4>
  591. <div class="markdown level1 summary">
  592. Loads the contents of the stream into the <a class="xref" href="Terminal.Gui.TextView.html">TextView</a>.
  593. </div>
  594. <div class="markdown level1 conceptual"></div>
  595. <h5 class="decalaration">Declaration</h5>
  596. <div class="codewrapper">
  597. <pre><code class="lang-csharp hljs">public void LoadStream(Stream stream)</code></pre>
  598. </div>
  599. <h5 class="parameters">Parameters</h5>
  600. <table class="table table-bordered table-striped table-condensed">
  601. <thead>
  602. <tr>
  603. <th>Type</th>
  604. <th>Name</th>
  605. <th>Description</th>
  606. </tr>
  607. </thead>
  608. <tbody>
  609. <tr>
  610. <td><span class="xref">System.IO.Stream</span></td>
  611. <td><span class="parametername">stream</span></td>
  612. <td>Stream to load the contents from.</td>
  613. </tr>
  614. </tbody>
  615. </table>
  616. <a id="Terminal_Gui_TextView_MouseEvent_" data-uid="Terminal.Gui.TextView.MouseEvent*"></a>
  617. <h4 id="Terminal_Gui_TextView_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.TextView.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  618. <div class="markdown level1 summary"></div>
  619. <div class="markdown level1 conceptual"></div>
  620. <h5 class="decalaration">Declaration</h5>
  621. <div class="codewrapper">
  622. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent ev)</code></pre>
  623. </div>
  624. <h5 class="parameters">Parameters</h5>
  625. <table class="table table-bordered table-striped table-condensed">
  626. <thead>
  627. <tr>
  628. <th>Type</th>
  629. <th>Name</th>
  630. <th>Description</th>
  631. </tr>
  632. </thead>
  633. <tbody>
  634. <tr>
  635. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  636. <td><span class="parametername">ev</span></td>
  637. <td></td>
  638. </tr>
  639. </tbody>
  640. </table>
  641. <h5 class="returns">Returns</h5>
  642. <table class="table table-bordered table-striped table-condensed">
  643. <thead>
  644. <tr>
  645. <th>Type</th>
  646. <th>Description</th>
  647. </tr>
  648. </thead>
  649. <tbody>
  650. <tr>
  651. <td><span class="xref">System.Boolean</span></td>
  652. <td></td>
  653. </tr>
  654. </tbody>
  655. </table>
  656. <h5 class="overrides">Overrides</h5>
  657. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  658. <a id="Terminal_Gui_TextView_PositionCursor_" data-uid="Terminal.Gui.TextView.PositionCursor*"></a>
  659. <h4 id="Terminal_Gui_TextView_PositionCursor" data-uid="Terminal.Gui.TextView.PositionCursor">PositionCursor()</h4>
  660. <div class="markdown level1 summary">
  661. Positions the cursor on the current row and column
  662. </div>
  663. <div class="markdown level1 conceptual"></div>
  664. <h5 class="decalaration">Declaration</h5>
  665. <div class="codewrapper">
  666. <pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
  667. </div>
  668. <h5 class="overrides">Overrides</h5>
  669. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
  670. <a id="Terminal_Gui_TextView_ProcessKey_" data-uid="Terminal.Gui.TextView.ProcessKey*"></a>
  671. <h4 id="Terminal_Gui_TextView_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.TextView.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  672. <div class="markdown level1 summary"></div>
  673. <div class="markdown level1 conceptual"></div>
  674. <h5 class="decalaration">Declaration</h5>
  675. <div class="codewrapper">
  676. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent kb)</code></pre>
  677. </div>
  678. <h5 class="parameters">Parameters</h5>
  679. <table class="table table-bordered table-striped table-condensed">
  680. <thead>
  681. <tr>
  682. <th>Type</th>
  683. <th>Name</th>
  684. <th>Description</th>
  685. </tr>
  686. </thead>
  687. <tbody>
  688. <tr>
  689. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  690. <td><span class="parametername">kb</span></td>
  691. <td></td>
  692. </tr>
  693. </tbody>
  694. </table>
  695. <h5 class="returns">Returns</h5>
  696. <table class="table table-bordered table-striped table-condensed">
  697. <thead>
  698. <tr>
  699. <th>Type</th>
  700. <th>Description</th>
  701. </tr>
  702. </thead>
  703. <tbody>
  704. <tr>
  705. <td><span class="xref">System.Boolean</span></td>
  706. <td></td>
  707. </tr>
  708. </tbody>
  709. </table>
  710. <h5 class="overrides">Overrides</h5>
  711. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  712. <a id="Terminal_Gui_TextView_Redraw_" data-uid="Terminal.Gui.TextView.Redraw*"></a>
  713. <h4 id="Terminal_Gui_TextView_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.TextView.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  714. <div class="markdown level1 summary"></div>
  715. <div class="markdown level1 conceptual"></div>
  716. <h5 class="decalaration">Declaration</h5>
  717. <div class="codewrapper">
  718. <pre><code class="lang-csharp hljs">public override void Redraw(Rect region)</code></pre>
  719. </div>
  720. <h5 class="parameters">Parameters</h5>
  721. <table class="table table-bordered table-striped table-condensed">
  722. <thead>
  723. <tr>
  724. <th>Type</th>
  725. <th>Name</th>
  726. <th>Description</th>
  727. </tr>
  728. </thead>
  729. <tbody>
  730. <tr>
  731. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  732. <td><span class="parametername">region</span></td>
  733. <td></td>
  734. </tr>
  735. </tbody>
  736. </table>
  737. <h5 class="overrides">Overrides</h5>
  738. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  739. <a id="Terminal_Gui_TextView_ScrollTo_" data-uid="Terminal.Gui.TextView.ScrollTo*"></a>
  740. <h4 id="Terminal_Gui_TextView_ScrollTo_System_Int32_" data-uid="Terminal.Gui.TextView.ScrollTo(System.Int32)">ScrollTo(Int32)</h4>
  741. <div class="markdown level1 summary">
  742. Will scroll the <a class="xref" href="Terminal.Gui.TextView.html">TextView</a> to display the specified row at the top
  743. </div>
  744. <div class="markdown level1 conceptual"></div>
  745. <h5 class="decalaration">Declaration</h5>
  746. <div class="codewrapper">
  747. <pre><code class="lang-csharp hljs">public void ScrollTo(int row)</code></pre>
  748. </div>
  749. <h5 class="parameters">Parameters</h5>
  750. <table class="table table-bordered table-striped table-condensed">
  751. <thead>
  752. <tr>
  753. <th>Type</th>
  754. <th>Name</th>
  755. <th>Description</th>
  756. </tr>
  757. </thead>
  758. <tbody>
  759. <tr>
  760. <td><span class="xref">System.Int32</span></td>
  761. <td><span class="parametername">row</span></td>
  762. <td>Row that should be displayed at the top, if the value is negative it will be reset to zero</td>
  763. </tr>
  764. </tbody>
  765. </table>
  766. <h3 id="events">Events
  767. </h3>
  768. <h4 id="Terminal_Gui_TextView_TextChanged" data-uid="Terminal.Gui.TextView.TextChanged">TextChanged</h4>
  769. <div class="markdown level1 summary">
  770. Raised when the <a class="xref" href="Terminal.Gui.TextView.html#Terminal_Gui_TextView_Text">Text</a> of the <a class="xref" href="Terminal.Gui.TextView.html">TextView</a> changes.
  771. </div>
  772. <div class="markdown level1 conceptual"></div>
  773. <h5 class="decalaration">Declaration</h5>
  774. <div class="codewrapper">
  775. <pre><code class="lang-csharp hljs">public event EventHandler TextChanged</code></pre>
  776. </div>
  777. <h5 class="eventType">Event Type</h5>
  778. <table class="table table-bordered table-striped table-condensed">
  779. <thead>
  780. <tr>
  781. <th>Type</th>
  782. <th>Description</th>
  783. </tr>
  784. </thead>
  785. <tbody>
  786. <tr>
  787. <td><span class="xref">System.EventHandler</span></td>
  788. <td></td>
  789. </tr>
  790. </tbody>
  791. </table>
  792. <h3 id="implements">Implements</h3>
  793. <div>
  794. <span class="xref">System.Collections.IEnumerable</span>
  795. </div>
  796. </article>
  797. </div>
  798. <div class="hidden-sm col-md-2" role="complementary">
  799. <div class="sideaffix">
  800. <div class="contribution">
  801. <ul class="nav">
  802. </ul>
  803. </div>
  804. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  805. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  806. </nav>
  807. </div>
  808. </div>
  809. </div>
  810. </div>
  811. <footer>
  812. <div class="grad-bottom"></div>
  813. <div class="footer">
  814. <div class="container">
  815. <span class="pull-right">
  816. <a href="#top">Back to top</a>
  817. </span>
  818. <span>Generated by <strong>DocFX</strong></span>
  819. </div>
  820. </div>
  821. </footer>
  822. </div>
  823. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  824. <script type="text/javascript" src="../../styles/docfx.js"></script>
  825. <script type="text/javascript" src="../../styles/main.js"></script>
  826. </body>
  827. </html>