Terminal.Gui.TextView.html 36 KB

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