Terminal.Gui.TextView.html 33 KB

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