Terminal.Gui.TextView.html 49 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272
  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.7.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">Search Results for <span></span></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></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.ComponentModel.ISupportInitializeNotification</span></div>
  90. <div><span class="xref">System.ComponentModel.ISupportInitialize</span></div>
  91. </div>
  92. <div class="inheritedMembers">
  93. <h5>Inherited Members</h5>
  94. <div>
  95. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Added">View.Added</a>
  96. </div>
  97. <div>
  98. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Removed">View.Removed</a>
  99. </div>
  100. <div>
  101. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  102. </div>
  103. <div>
  104. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  105. </div>
  106. <div>
  107. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  108. </div>
  109. <div>
  110. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  111. </div>
  112. <div>
  113. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  114. </div>
  115. <div>
  116. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKey">View.HotKey</a>
  117. </div>
  118. <div>
  119. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">View.HotKeySpecifier</a>
  120. </div>
  121. <div>
  122. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Shortcut">View.Shortcut</a>
  123. </div>
  124. <div>
  125. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutTag">View.ShortcutTag</a>
  126. </div>
  127. <div>
  128. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutAction">View.ShortcutAction</a>
  129. </div>
  130. <div>
  131. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Data">View.Data</a>
  132. </div>
  133. <div>
  134. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  135. </div>
  136. <div>
  137. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  138. </div>
  139. <div>
  140. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">View.TabIndexes</a>
  141. </div>
  142. <div>
  143. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndex">View.TabIndex</a>
  144. </div>
  145. <div>
  146. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabStop">View.TabStop</a>
  147. </div>
  148. <div>
  149. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  150. </div>
  151. <div>
  152. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  153. </div>
  154. <div>
  155. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  156. </div>
  157. <div>
  158. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  159. </div>
  160. <div>
  161. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  162. </div>
  163. <div>
  164. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  165. </div>
  166. <div>
  167. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  168. </div>
  169. <div>
  170. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  171. </div>
  172. <div>
  173. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  174. </div>
  175. <div>
  176. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  177. </div>
  178. <div>
  179. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  180. </div>
  181. <div>
  182. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  183. </div>
  184. <div>
  185. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearLayoutNeeded">View.ClearLayoutNeeded()</a>
  186. </div>
  187. <div>
  188. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  189. </div>
  190. <div>
  191. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetChildNeedsDisplay">View.SetChildNeedsDisplay()</a>
  192. </div>
  193. <div>
  194. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  195. </div>
  196. <div>
  197. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  198. </div>
  199. <div>
  200. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  201. </div>
  202. <div>
  203. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  204. </div>
  205. <div>
  206. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  207. </div>
  208. <div>
  209. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  210. </div>
  211. <div>
  212. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  213. </div>
  214. <div>
  215. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  216. </div>
  217. <div>
  218. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  219. </div>
  220. <div>
  221. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  222. </div>
  223. <div>
  224. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  225. </div>
  226. <div>
  227. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  228. </div>
  229. <div>
  230. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  231. </div>
  232. <div>
  233. <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>
  234. </div>
  235. <div>
  236. <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>
  237. </div>
  238. <div>
  239. <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>
  240. </div>
  241. <div>
  242. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  243. </div>
  244. <div>
  245. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  246. </div>
  247. <div>
  248. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnAdded_Terminal_Gui_View_">View.OnAdded(View)</a>
  249. </div>
  250. <div>
  251. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnRemoved_Terminal_Gui_View_">View.OnRemoved(View)</a>
  252. </div>
  253. <div>
  254. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave_Terminal_Gui_View_">View.OnLeave(View)</a>
  255. </div>
  256. <div>
  257. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  258. </div>
  259. <div>
  260. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  261. </div>
  262. <div>
  263. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  264. </div>
  265. <div>
  266. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  267. </div>
  268. <div>
  269. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  270. </div>
  271. <div>
  272. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  273. </div>
  274. <div>
  275. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  276. </div>
  277. <div>
  278. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus">View.SetFocus()</a>
  279. </div>
  280. <div>
  281. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  282. </div>
  283. <div>
  284. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  285. </div>
  286. <div>
  287. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  288. </div>
  289. <div>
  290. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  291. </div>
  292. <div>
  293. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  294. </div>
  295. <div>
  296. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  297. </div>
  298. <div>
  299. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  300. </div>
  301. <div>
  302. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  303. </div>
  304. <div>
  305. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  306. </div>
  307. <div>
  308. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  309. </div>
  310. <div>
  311. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  312. </div>
  313. <div>
  314. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  315. </div>
  316. <div>
  317. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStarted">View.LayoutStarted</a>
  318. </div>
  319. <div>
  320. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  321. </div>
  322. <div>
  323. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Initialized">View.Initialized</a>
  324. </div>
  325. <div>
  326. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  327. </div>
  328. <div>
  329. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AutoSize">View.AutoSize</a>
  330. </div>
  331. <div>
  332. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">View.TextAlignment</a>
  333. </div>
  334. <div>
  335. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsInitialized">View.IsInitialized</a>
  336. </div>
  337. <div>
  338. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  339. </div>
  340. <div>
  341. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  342. </div>
  343. <div>
  344. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  345. </div>
  346. <div>
  347. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  348. </div>
  349. <div>
  350. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseClick_Terminal_Gui_View_MouseEventArgs_">View.OnMouseClick(View.MouseEventArgs)</a>
  351. </div>
  352. <div>
  353. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Dispose_System_Boolean_">View.Dispose(Boolean)</a>
  354. </div>
  355. <div>
  356. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BeginInit">View.BeginInit()</a>
  357. </div>
  358. <div>
  359. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EndInit">View.EndInit()</a>
  360. </div>
  361. <div>
  362. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Visible">View.Visible</a>
  363. </div>
  364. <div>
  365. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetWidth_System_Int32_System_Int32__">View.SetWidth(Int32, Int32)</a>
  366. </div>
  367. <div>
  368. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetHeight_System_Int32_System_Int32__">View.SetHeight(Int32, Int32)</a>
  369. </div>
  370. <div>
  371. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
  372. </div>
  373. <div>
  374. <span class="xref">System.Object.Equals(System.Object)</span>
  375. </div>
  376. <div>
  377. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  378. </div>
  379. <div>
  380. <span class="xref">System.Object.GetHashCode()</span>
  381. </div>
  382. <div>
  383. <span class="xref">System.Object.GetType()</span>
  384. </div>
  385. <div>
  386. <span class="xref">System.Object.MemberwiseClone()</span>
  387. </div>
  388. <div>
  389. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  390. </div>
  391. </div>
  392. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  393. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  394. <h5 id="Terminal_Gui_TextView_syntax">Syntax</h5>
  395. <div class="codewrapper">
  396. <pre><code class="lang-csharp hljs">public class TextView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize</code></pre>
  397. </div>
  398. <h5 id="Terminal_Gui_TextView_remarks"><strong>Remarks</strong></h5>
  399. <div class="markdown level0 remarks">
  400. <p>
  401. <a class="xref" href="Terminal.Gui.TextView.html">TextView</a> provides a multi-line text editor. Users interact
  402. with it with the standard Emacs commands for movement or the arrow
  403. keys.
  404. </p>
  405. <table><thead><tr><th>Shortcut</th><th>Action performed</th></tr></thead><tbody><tr><td>Left cursor, Control-b</td><td>
  406. Moves the editing point left.
  407. </td></tr><tr><td>Right cursor, Control-f</td><td>
  408. Moves the editing point right.
  409. </td></tr><tr><td>Alt-b</td><td>
  410. Moves one word back.
  411. </td></tr><tr><td>Alt-f</td><td>
  412. Moves one word forward.
  413. </td></tr><tr><td>Up cursor, Control-p</td><td>
  414. Moves the editing point one line up.
  415. </td></tr><tr><td>Down cursor, Control-n</td><td>
  416. Moves the editing point one line down
  417. </td></tr><tr><td>Home key, Control-a</td><td>
  418. Moves the cursor to the beginning of the line.
  419. </td></tr><tr><td>End key, Control-e</td><td>
  420. Moves the cursor to the end of the line.
  421. </td></tr><tr><td>Control-Home</td><td>
  422. Scrolls to the first line and moves the cursor there.
  423. </td></tr><tr><td>Control-End</td><td>
  424. Scrolls to the last line and moves the cursor there.
  425. </td></tr><tr><td>Delete, Control-d</td><td>
  426. Deletes the character in front of the cursor.
  427. </td></tr><tr><td>Backspace</td><td>
  428. Deletes the character behind the cursor.
  429. </td></tr><tr><td>Control-k</td><td>
  430. Deletes the text until the end of the line and replaces the kill buffer
  431. with the deleted text. You can paste this text in a different place by
  432. using Control-y.
  433. </td></tr><tr><td>Control-y</td><td>
  434. Pastes the content of the kill ring into the current position.
  435. </td></tr><tr><td>Alt-d</td><td>
  436. Deletes the word above the cursor and adds it to the kill ring. You
  437. can paste the contents of the kill ring with Control-y.
  438. </td></tr><tr><td>Control-q</td><td>
  439. Quotes the next input character, to prevent the normal processing of
  440. key handling to take place.
  441. </td></tr></tbody></table>
  442. </div>
  443. <h3 id="constructors">Constructors
  444. </h3>
  445. <a id="Terminal_Gui_TextView__ctor_" data-uid="Terminal.Gui.TextView.#ctor*"></a>
  446. <h4 id="Terminal_Gui_TextView__ctor" data-uid="Terminal.Gui.TextView.#ctor">TextView()</h4>
  447. <div class="markdown level1 summary">
  448. Initializes a <a class="xref" href="Terminal.Gui.TextView.html">TextView</a> on the specified area,
  449. with dimensions controlled with the X, Y, Width and Height properties.
  450. </div>
  451. <div class="markdown level1 conceptual"></div>
  452. <h5 class="decalaration">Declaration</h5>
  453. <div class="codewrapper">
  454. <pre><code class="lang-csharp hljs">public TextView()</code></pre>
  455. </div>
  456. <a id="Terminal_Gui_TextView__ctor_" data-uid="Terminal.Gui.TextView.#ctor*"></a>
  457. <h4 id="Terminal_Gui_TextView__ctor_Terminal_Gui_Rect_" data-uid="Terminal.Gui.TextView.#ctor(Terminal.Gui.Rect)">TextView(Rect)</h4>
  458. <div class="markdown level1 summary">
  459. Initializes a <a class="xref" href="Terminal.Gui.TextView.html">TextView</a> on the specified area, with absolute position and size.
  460. </div>
  461. <div class="markdown level1 conceptual"></div>
  462. <h5 class="decalaration">Declaration</h5>
  463. <div class="codewrapper">
  464. <pre><code class="lang-csharp hljs">public TextView(Rect frame)</code></pre>
  465. </div>
  466. <h5 class="parameters">Parameters</h5>
  467. <table class="table table-bordered table-striped table-condensed">
  468. <thead>
  469. <tr>
  470. <th>Type</th>
  471. <th>Name</th>
  472. <th>Description</th>
  473. </tr>
  474. </thead>
  475. <tbody>
  476. <tr>
  477. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  478. <td><span class="parametername">frame</span></td>
  479. <td></td>
  480. </tr>
  481. </tbody>
  482. </table>
  483. <h5 id="Terminal_Gui_TextView__ctor_Terminal_Gui_Rect__remarks">Remarks</h5>
  484. <div class="markdown level1 remarks">
  485. </div>
  486. <h3 id="properties">Properties
  487. </h3>
  488. <a id="Terminal_Gui_TextView_CanFocus_" data-uid="Terminal.Gui.TextView.CanFocus*"></a>
  489. <h4 id="Terminal_Gui_TextView_CanFocus" data-uid="Terminal.Gui.TextView.CanFocus">CanFocus</h4>
  490. <div class="markdown level1 summary">
  491. Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.Responder.html">Responder</a> can focus.
  492. </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><code>true</code> if can focus; otherwise, <code>false</code>.</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_DesiredCursorVisibility_" data-uid="Terminal.Gui.TextView.DesiredCursorVisibility*"></a>
  566. <h4 id="Terminal_Gui_TextView_DesiredCursorVisibility" data-uid="Terminal.Gui.TextView.DesiredCursorVisibility">DesiredCursorVisibility</h4>
  567. <div class="markdown level1 summary">
  568. Get / Set the wished cursor when the field is focused
  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 CursorVisibility DesiredCursorVisibility { 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><a class="xref" href="Terminal.Gui.CursorVisibility.html">CursorVisibility</a></td>
  586. <td></td>
  587. </tr>
  588. </tbody>
  589. </table>
  590. <a id="Terminal_Gui_TextView_Frame_" data-uid="Terminal.Gui.TextView.Frame*"></a>
  591. <h4 id="Terminal_Gui_TextView_Frame" data-uid="Terminal.Gui.TextView.Frame">Frame</h4>
  592. <div class="markdown level1 summary">
  593. Gets or sets the frame for the view. The frame is relative to the view&apos;s container (<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">SuperView</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 Rect Frame { 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><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  611. <td>The frame.</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_Frame">View.Frame</a></div>
  617. <h5 id="Terminal_Gui_TextView_Frame_remarks">Remarks</h5>
  618. <div class="markdown level1 remarks">
  619. <p>
  620. Change the Frame when using the <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> layout style to move or resize views.
  621. </p>
  622. <p>
  623. Altering the Frame of a view will trigger the redrawing of the
  624. view as well as the redrawing of the affected regions of the <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">SuperView</a>.
  625. </p>
  626. </div>
  627. <a id="Terminal_Gui_TextView_LeftColumn_" data-uid="Terminal.Gui.TextView.LeftColumn*"></a>
  628. <h4 id="Terminal_Gui_TextView_LeftColumn" data-uid="Terminal.Gui.TextView.LeftColumn">LeftColumn</h4>
  629. <div class="markdown level1 summary">
  630. Gets or sets the left column.
  631. </div>
  632. <div class="markdown level1 conceptual"></div>
  633. <h5 class="decalaration">Declaration</h5>
  634. <div class="codewrapper">
  635. <pre><code class="lang-csharp hljs">public int LeftColumn { get; set; }</code></pre>
  636. </div>
  637. <h5 class="propertyValue">Property Value</h5>
  638. <table class="table table-bordered table-striped table-condensed">
  639. <thead>
  640. <tr>
  641. <th>Type</th>
  642. <th>Description</th>
  643. </tr>
  644. </thead>
  645. <tbody>
  646. <tr>
  647. <td><span class="xref">System.Int32</span></td>
  648. <td></td>
  649. </tr>
  650. </tbody>
  651. </table>
  652. <a id="Terminal_Gui_TextView_Lines_" data-uid="Terminal.Gui.TextView.Lines*"></a>
  653. <h4 id="Terminal_Gui_TextView_Lines" data-uid="Terminal.Gui.TextView.Lines">Lines</h4>
  654. <div class="markdown level1 summary">
  655. Gets the number of lines.
  656. </div>
  657. <div class="markdown level1 conceptual"></div>
  658. <h5 class="decalaration">Declaration</h5>
  659. <div class="codewrapper">
  660. <pre><code class="lang-csharp hljs">public int Lines { get; }</code></pre>
  661. </div>
  662. <h5 class="propertyValue">Property Value</h5>
  663. <table class="table table-bordered table-striped table-condensed">
  664. <thead>
  665. <tr>
  666. <th>Type</th>
  667. <th>Description</th>
  668. </tr>
  669. </thead>
  670. <tbody>
  671. <tr>
  672. <td><span class="xref">System.Int32</span></td>
  673. <td></td>
  674. </tr>
  675. </tbody>
  676. </table>
  677. <a id="Terminal_Gui_TextView_Maxlength_" data-uid="Terminal.Gui.TextView.Maxlength*"></a>
  678. <h4 id="Terminal_Gui_TextView_Maxlength" data-uid="Terminal.Gui.TextView.Maxlength">Maxlength</h4>
  679. <div class="markdown level1 summary">
  680. Gets the maximum visible length line.
  681. </div>
  682. <div class="markdown level1 conceptual"></div>
  683. <h5 class="decalaration">Declaration</h5>
  684. <div class="codewrapper">
  685. <pre><code class="lang-csharp hljs">public int Maxlength { get; }</code></pre>
  686. </div>
  687. <h5 class="propertyValue">Property Value</h5>
  688. <table class="table table-bordered table-striped table-condensed">
  689. <thead>
  690. <tr>
  691. <th>Type</th>
  692. <th>Description</th>
  693. </tr>
  694. </thead>
  695. <tbody>
  696. <tr>
  697. <td><span class="xref">System.Int32</span></td>
  698. <td></td>
  699. </tr>
  700. </tbody>
  701. </table>
  702. <a id="Terminal_Gui_TextView_ReadOnly_" data-uid="Terminal.Gui.TextView.ReadOnly*"></a>
  703. <h4 id="Terminal_Gui_TextView_ReadOnly" data-uid="Terminal.Gui.TextView.ReadOnly">ReadOnly</h4>
  704. <div class="markdown level1 summary">
  705. Gets or sets whether the <a class="xref" href="Terminal.Gui.TextView.html">TextView</a> is in read-only mode or not
  706. </div>
  707. <div class="markdown level1 conceptual"></div>
  708. <h5 class="decalaration">Declaration</h5>
  709. <div class="codewrapper">
  710. <pre><code class="lang-csharp hljs">public bool ReadOnly { get; set; }</code></pre>
  711. </div>
  712. <h5 class="propertyValue">Property Value</h5>
  713. <table class="table table-bordered table-striped table-condensed">
  714. <thead>
  715. <tr>
  716. <th>Type</th>
  717. <th>Description</th>
  718. </tr>
  719. </thead>
  720. <tbody>
  721. <tr>
  722. <td><span class="xref">System.Boolean</span></td>
  723. <td>Boolean value(Default false)</td>
  724. </tr>
  725. </tbody>
  726. </table>
  727. <a id="Terminal_Gui_TextView_Text_" data-uid="Terminal.Gui.TextView.Text*"></a>
  728. <h4 id="Terminal_Gui_TextView_Text" data-uid="Terminal.Gui.TextView.Text">Text</h4>
  729. <div class="markdown level1 summary">
  730. Sets or gets the text in the <a class="xref" href="Terminal.Gui.TextView.html">TextView</a>.
  731. </div>
  732. <div class="markdown level1 conceptual"></div>
  733. <h5 class="decalaration">Declaration</h5>
  734. <div class="codewrapper">
  735. <pre><code class="lang-csharp hljs">public override ustring Text { get; set; }</code></pre>
  736. </div>
  737. <h5 class="propertyValue">Property Value</h5>
  738. <table class="table table-bordered table-striped table-condensed">
  739. <thead>
  740. <tr>
  741. <th>Type</th>
  742. <th>Description</th>
  743. </tr>
  744. </thead>
  745. <tbody>
  746. <tr>
  747. <td><span class="xref">NStack.ustring</span></td>
  748. <td></td>
  749. </tr>
  750. </tbody>
  751. </table>
  752. <h5 class="overrides">Overrides</h5>
  753. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">View.Text</a></div>
  754. <h5 id="Terminal_Gui_TextView_Text_remarks">Remarks</h5>
  755. <div class="markdown level1 remarks">
  756. </div>
  757. <a id="Terminal_Gui_TextView_TopRow_" data-uid="Terminal.Gui.TextView.TopRow*"></a>
  758. <h4 id="Terminal_Gui_TextView_TopRow" data-uid="Terminal.Gui.TextView.TopRow">TopRow</h4>
  759. <div class="markdown level1 summary">
  760. Gets or sets the top row.
  761. </div>
  762. <div class="markdown level1 conceptual"></div>
  763. <h5 class="decalaration">Declaration</h5>
  764. <div class="codewrapper">
  765. <pre><code class="lang-csharp hljs">public int TopRow { get; set; }</code></pre>
  766. </div>
  767. <h5 class="propertyValue">Property Value</h5>
  768. <table class="table table-bordered table-striped table-condensed">
  769. <thead>
  770. <tr>
  771. <th>Type</th>
  772. <th>Description</th>
  773. </tr>
  774. </thead>
  775. <tbody>
  776. <tr>
  777. <td><span class="xref">System.Int32</span></td>
  778. <td></td>
  779. </tr>
  780. </tbody>
  781. </table>
  782. <h3 id="methods">Methods
  783. </h3>
  784. <a id="Terminal_Gui_TextView_CloseFile_" data-uid="Terminal.Gui.TextView.CloseFile*"></a>
  785. <h4 id="Terminal_Gui_TextView_CloseFile" data-uid="Terminal.Gui.TextView.CloseFile">CloseFile()</h4>
  786. <div class="markdown level1 summary">
  787. Closes the contents of the stream into the <a class="xref" href="Terminal.Gui.TextView.html">TextView</a>.
  788. </div>
  789. <div class="markdown level1 conceptual"></div>
  790. <h5 class="decalaration">Declaration</h5>
  791. <div class="codewrapper">
  792. <pre><code class="lang-csharp hljs">public bool CloseFile()</code></pre>
  793. </div>
  794. <h5 class="returns">Returns</h5>
  795. <table class="table table-bordered table-striped table-condensed">
  796. <thead>
  797. <tr>
  798. <th>Type</th>
  799. <th>Description</th>
  800. </tr>
  801. </thead>
  802. <tbody>
  803. <tr>
  804. <td><span class="xref">System.Boolean</span></td>
  805. <td><code>true</code>, if stream was closed, <code>false</code> otherwise.</td>
  806. </tr>
  807. </tbody>
  808. </table>
  809. <a id="Terminal_Gui_TextView_LoadFile_" data-uid="Terminal.Gui.TextView.LoadFile*"></a>
  810. <h4 id="Terminal_Gui_TextView_LoadFile_System_String_" data-uid="Terminal.Gui.TextView.LoadFile(System.String)">LoadFile(String)</h4>
  811. <div class="markdown level1 summary">
  812. Loads the contents of the file into the <a class="xref" href="Terminal.Gui.TextView.html">TextView</a>.
  813. </div>
  814. <div class="markdown level1 conceptual"></div>
  815. <h5 class="decalaration">Declaration</h5>
  816. <div class="codewrapper">
  817. <pre><code class="lang-csharp hljs">public bool LoadFile(string path)</code></pre>
  818. </div>
  819. <h5 class="parameters">Parameters</h5>
  820. <table class="table table-bordered table-striped table-condensed">
  821. <thead>
  822. <tr>
  823. <th>Type</th>
  824. <th>Name</th>
  825. <th>Description</th>
  826. </tr>
  827. </thead>
  828. <tbody>
  829. <tr>
  830. <td><span class="xref">System.String</span></td>
  831. <td><span class="parametername">path</span></td>
  832. <td>Path to the file to load.</td>
  833. </tr>
  834. </tbody>
  835. </table>
  836. <h5 class="returns">Returns</h5>
  837. <table class="table table-bordered table-striped table-condensed">
  838. <thead>
  839. <tr>
  840. <th>Type</th>
  841. <th>Description</th>
  842. </tr>
  843. </thead>
  844. <tbody>
  845. <tr>
  846. <td><span class="xref">System.Boolean</span></td>
  847. <td><code>true</code>, if file was loaded, <code>false</code> otherwise.</td>
  848. </tr>
  849. </tbody>
  850. </table>
  851. <a id="Terminal_Gui_TextView_LoadStream_" data-uid="Terminal.Gui.TextView.LoadStream*"></a>
  852. <h4 id="Terminal_Gui_TextView_LoadStream_System_IO_Stream_" data-uid="Terminal.Gui.TextView.LoadStream(System.IO.Stream)">LoadStream(Stream)</h4>
  853. <div class="markdown level1 summary">
  854. Loads the contents of the stream into the <a class="xref" href="Terminal.Gui.TextView.html">TextView</a>.
  855. </div>
  856. <div class="markdown level1 conceptual"></div>
  857. <h5 class="decalaration">Declaration</h5>
  858. <div class="codewrapper">
  859. <pre><code class="lang-csharp hljs">public void LoadStream(Stream stream)</code></pre>
  860. </div>
  861. <h5 class="parameters">Parameters</h5>
  862. <table class="table table-bordered table-striped table-condensed">
  863. <thead>
  864. <tr>
  865. <th>Type</th>
  866. <th>Name</th>
  867. <th>Description</th>
  868. </tr>
  869. </thead>
  870. <tbody>
  871. <tr>
  872. <td><span class="xref">System.IO.Stream</span></td>
  873. <td><span class="parametername">stream</span></td>
  874. <td>Stream to load the contents from.</td>
  875. </tr>
  876. </tbody>
  877. </table>
  878. <a id="Terminal_Gui_TextView_MouseEvent_" data-uid="Terminal.Gui.TextView.MouseEvent*"></a>
  879. <h4 id="Terminal_Gui_TextView_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.TextView.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  880. <div class="markdown level1 summary">
  881. Method invoked when a mouse event is generated
  882. </div>
  883. <div class="markdown level1 conceptual"></div>
  884. <h5 class="decalaration">Declaration</h5>
  885. <div class="codewrapper">
  886. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent ev)</code></pre>
  887. </div>
  888. <h5 class="parameters">Parameters</h5>
  889. <table class="table table-bordered table-striped table-condensed">
  890. <thead>
  891. <tr>
  892. <th>Type</th>
  893. <th>Name</th>
  894. <th>Description</th>
  895. </tr>
  896. </thead>
  897. <tbody>
  898. <tr>
  899. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  900. <td><span class="parametername">ev</span></td>
  901. <td></td>
  902. </tr>
  903. </tbody>
  904. </table>
  905. <h5 class="returns">Returns</h5>
  906. <table class="table table-bordered table-striped table-condensed">
  907. <thead>
  908. <tr>
  909. <th>Type</th>
  910. <th>Description</th>
  911. </tr>
  912. </thead>
  913. <tbody>
  914. <tr>
  915. <td><span class="xref">System.Boolean</span></td>
  916. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  917. </tr>
  918. </tbody>
  919. </table>
  920. <h5 class="overrides">Overrides</h5>
  921. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  922. <a id="Terminal_Gui_TextView_MoveEnd_" data-uid="Terminal.Gui.TextView.MoveEnd*"></a>
  923. <h4 id="Terminal_Gui_TextView_MoveEnd" data-uid="Terminal.Gui.TextView.MoveEnd">MoveEnd()</h4>
  924. <div class="markdown level1 summary">
  925. Will scroll the <a class="xref" href="Terminal.Gui.TextView.html">TextView</a> to the last line and position the cursor there.
  926. </div>
  927. <div class="markdown level1 conceptual"></div>
  928. <h5 class="decalaration">Declaration</h5>
  929. <div class="codewrapper">
  930. <pre><code class="lang-csharp hljs">public void MoveEnd()</code></pre>
  931. </div>
  932. <a id="Terminal_Gui_TextView_MoveHome_" data-uid="Terminal.Gui.TextView.MoveHome*"></a>
  933. <h4 id="Terminal_Gui_TextView_MoveHome" data-uid="Terminal.Gui.TextView.MoveHome">MoveHome()</h4>
  934. <div class="markdown level1 summary">
  935. Will scroll the <a class="xref" href="Terminal.Gui.TextView.html">TextView</a> to the first line and position the cursor there.
  936. </div>
  937. <div class="markdown level1 conceptual"></div>
  938. <h5 class="decalaration">Declaration</h5>
  939. <div class="codewrapper">
  940. <pre><code class="lang-csharp hljs">public void MoveHome()</code></pre>
  941. </div>
  942. <a id="Terminal_Gui_TextView_OnEnter_" data-uid="Terminal.Gui.TextView.OnEnter*"></a>
  943. <h4 id="Terminal_Gui_TextView_OnEnter_Terminal_Gui_View_" data-uid="Terminal.Gui.TextView.OnEnter(Terminal.Gui.View)">OnEnter(View)</h4>
  944. <div class="markdown level1 summary">
  945. Method invoked when a view gets focus.
  946. </div>
  947. <div class="markdown level1 conceptual"></div>
  948. <h5 class="decalaration">Declaration</h5>
  949. <div class="codewrapper">
  950. <pre><code class="lang-csharp hljs">public override bool OnEnter(View view)</code></pre>
  951. </div>
  952. <h5 class="parameters">Parameters</h5>
  953. <table class="table table-bordered table-striped table-condensed">
  954. <thead>
  955. <tr>
  956. <th>Type</th>
  957. <th>Name</th>
  958. <th>Description</th>
  959. </tr>
  960. </thead>
  961. <tbody>
  962. <tr>
  963. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  964. <td><span class="parametername">view</span></td>
  965. <td>The view that is losing focus.</td>
  966. </tr>
  967. </tbody>
  968. </table>
  969. <h5 class="returns">Returns</h5>
  970. <table class="table table-bordered table-striped table-condensed">
  971. <thead>
  972. <tr>
  973. <th>Type</th>
  974. <th>Description</th>
  975. </tr>
  976. </thead>
  977. <tbody>
  978. <tr>
  979. <td><span class="xref">System.Boolean</span></td>
  980. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  981. </tr>
  982. </tbody>
  983. </table>
  984. <h5 class="overrides">Overrides</h5>
  985. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter_Terminal_Gui_View_">View.OnEnter(View)</a></div>
  986. <a id="Terminal_Gui_TextView_PositionCursor_" data-uid="Terminal.Gui.TextView.PositionCursor*"></a>
  987. <h4 id="Terminal_Gui_TextView_PositionCursor" data-uid="Terminal.Gui.TextView.PositionCursor">PositionCursor()</h4>
  988. <div class="markdown level1 summary">
  989. Positions the cursor on the current row and column
  990. </div>
  991. <div class="markdown level1 conceptual"></div>
  992. <h5 class="decalaration">Declaration</h5>
  993. <div class="codewrapper">
  994. <pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
  995. </div>
  996. <h5 class="overrides">Overrides</h5>
  997. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
  998. <a id="Terminal_Gui_TextView_ProcessKey_" data-uid="Terminal.Gui.TextView.ProcessKey*"></a>
  999. <h4 id="Terminal_Gui_TextView_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.TextView.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  1000. <div class="markdown level1 summary">
  1001. If the view is focused, gives the view a
  1002. chance to process the keystroke.
  1003. </div>
  1004. <div class="markdown level1 conceptual"></div>
  1005. <h5 class="decalaration">Declaration</h5>
  1006. <div class="codewrapper">
  1007. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent kb)</code></pre>
  1008. </div>
  1009. <h5 class="parameters">Parameters</h5>
  1010. <table class="table table-bordered table-striped table-condensed">
  1011. <thead>
  1012. <tr>
  1013. <th>Type</th>
  1014. <th>Name</th>
  1015. <th>Description</th>
  1016. </tr>
  1017. </thead>
  1018. <tbody>
  1019. <tr>
  1020. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  1021. <td><span class="parametername">kb</span></td>
  1022. <td></td>
  1023. </tr>
  1024. </tbody>
  1025. </table>
  1026. <h5 class="returns">Returns</h5>
  1027. <table class="table table-bordered table-striped table-condensed">
  1028. <thead>
  1029. <tr>
  1030. <th>Type</th>
  1031. <th>Description</th>
  1032. </tr>
  1033. </thead>
  1034. <tbody>
  1035. <tr>
  1036. <td><span class="xref">System.Boolean</span></td>
  1037. <td></td>
  1038. </tr>
  1039. </tbody>
  1040. </table>
  1041. <h5 class="overrides">Overrides</h5>
  1042. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  1043. <h5 id="Terminal_Gui_TextView_ProcessKey_Terminal_Gui_KeyEvent__remarks">Remarks</h5>
  1044. <div class="markdown level1 remarks">
  1045. <p>
  1046. Views can override this method if they are
  1047. interested in processing the given keystroke.
  1048. If they consume the keystroke, they must
  1049. return true to stop the keystroke from being
  1050. processed by other widgets or consumed by the
  1051. widget engine. If they return false, the
  1052. keystroke will be passed using the ProcessColdKey
  1053. method to other views to process.
  1054. </p>
  1055. <p>
  1056. The View implementation does nothing but return false,
  1057. so it is not necessary to call base.ProcessKey if you
  1058. derive directly from View, but you should if you derive
  1059. other View subclasses.
  1060. </p>
  1061. </div>
  1062. <a id="Terminal_Gui_TextView_Redraw_" data-uid="Terminal.Gui.TextView.Redraw*"></a>
  1063. <h4 id="Terminal_Gui_TextView_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.TextView.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  1064. <div class="markdown level1 summary">
  1065. Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
  1066. </div>
  1067. <div class="markdown level1 conceptual"></div>
  1068. <h5 class="decalaration">Declaration</h5>
  1069. <div class="codewrapper">
  1070. <pre><code class="lang-csharp hljs">public override void Redraw(Rect bounds)</code></pre>
  1071. </div>
  1072. <h5 class="parameters">Parameters</h5>
  1073. <table class="table table-bordered table-striped table-condensed">
  1074. <thead>
  1075. <tr>
  1076. <th>Type</th>
  1077. <th>Name</th>
  1078. <th>Description</th>
  1079. </tr>
  1080. </thead>
  1081. <tbody>
  1082. <tr>
  1083. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1084. <td><span class="parametername">bounds</span></td>
  1085. <td>The bounds (view-relative region) to redraw.</td>
  1086. </tr>
  1087. </tbody>
  1088. </table>
  1089. <h5 class="overrides">Overrides</h5>
  1090. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  1091. <h5 id="Terminal_Gui_TextView_Redraw_Terminal_Gui_Rect__remarks">Remarks</h5>
  1092. <div class="markdown level1 remarks">
  1093. <p>
  1094. Always use <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">Bounds</a> (view-relative) when calling <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">Redraw(Rect)</a>, NOT <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> (superview-relative).
  1095. </p>
  1096. <p>
  1097. Views should set the color that they want to use on entry, as otherwise this will inherit
  1098. the last color that was set globally on the driver.
  1099. </p>
  1100. <p>
  1101. Overrides of <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">Redraw(Rect)</a> must ensure they do not set <code>Driver.Clip</code> to a clip region
  1102. larger than the <code>region</code> parameter.
  1103. </p>
  1104. </div>
  1105. <a id="Terminal_Gui_TextView_ScrollTo_" data-uid="Terminal.Gui.TextView.ScrollTo*"></a>
  1106. <h4 id="Terminal_Gui_TextView_ScrollTo_System_Int32_System_Boolean_" data-uid="Terminal.Gui.TextView.ScrollTo(System.Int32,System.Boolean)">ScrollTo(Int32, Boolean)</h4>
  1107. <div class="markdown level1 summary">
  1108. Will scroll the <a class="xref" href="Terminal.Gui.TextView.html">TextView</a> to display the specified row at the top if <code data-dev-comment-type="paramref" class="paramref">isRow</code> is true or
  1109. will scroll the <a class="xref" href="Terminal.Gui.TextView.html">TextView</a> to display the specified column at the left if <code data-dev-comment-type="paramref" class="paramref">isRow</code> is false.
  1110. </div>
  1111. <div class="markdown level1 conceptual"></div>
  1112. <h5 class="decalaration">Declaration</h5>
  1113. <div class="codewrapper">
  1114. <pre><code class="lang-csharp hljs">public void ScrollTo(int idx, bool isRow = true)</code></pre>
  1115. </div>
  1116. <h5 class="parameters">Parameters</h5>
  1117. <table class="table table-bordered table-striped table-condensed">
  1118. <thead>
  1119. <tr>
  1120. <th>Type</th>
  1121. <th>Name</th>
  1122. <th>Description</th>
  1123. </tr>
  1124. </thead>
  1125. <tbody>
  1126. <tr>
  1127. <td><span class="xref">System.Int32</span></td>
  1128. <td><span class="parametername">idx</span></td>
  1129. <td>Row that should be displayed at the top or Column that should be displayed at the left,
  1130. if the value is negative it will be reset to zero</td>
  1131. </tr>
  1132. <tr>
  1133. <td><span class="xref">System.Boolean</span></td>
  1134. <td><span class="parametername">isRow</span></td>
  1135. <td>If true (default) the <code data-dev-comment-type="paramref" class="paramref">idx</code> is a row, column otherwise.</td>
  1136. </tr>
  1137. </tbody>
  1138. </table>
  1139. <h3 id="events">Events
  1140. </h3>
  1141. <h4 id="Terminal_Gui_TextView_TextChanged" data-uid="Terminal.Gui.TextView.TextChanged">TextChanged</h4>
  1142. <div class="markdown level1 summary">
  1143. 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.
  1144. </div>
  1145. <div class="markdown level1 conceptual"></div>
  1146. <h5 class="decalaration">Declaration</h5>
  1147. <div class="codewrapper">
  1148. <pre><code class="lang-csharp hljs">public event Action TextChanged</code></pre>
  1149. </div>
  1150. <h5 class="eventType">Event Type</h5>
  1151. <table class="table table-bordered table-striped table-condensed">
  1152. <thead>
  1153. <tr>
  1154. <th>Type</th>
  1155. <th>Description</th>
  1156. </tr>
  1157. </thead>
  1158. <tbody>
  1159. <tr>
  1160. <td><span class="xref">System.Action</span></td>
  1161. <td></td>
  1162. </tr>
  1163. </tbody>
  1164. </table>
  1165. <h3 id="implements">Implements</h3>
  1166. <div>
  1167. <span class="xref">System.IDisposable</span>
  1168. </div>
  1169. <div>
  1170. <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
  1171. </div>
  1172. <div>
  1173. <span class="xref">System.ComponentModel.ISupportInitialize</span>
  1174. </div>
  1175. </article>
  1176. </div>
  1177. <div class="hidden-sm col-md-2" role="complementary">
  1178. <div class="sideaffix">
  1179. <div class="contribution">
  1180. <ul class="nav">
  1181. </ul>
  1182. </div>
  1183. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  1184. <h5>In This Article</h5>
  1185. <div></div>
  1186. </nav>
  1187. </div>
  1188. </div>
  1189. </div>
  1190. </div>
  1191. <footer>
  1192. <div class="grad-bottom"></div>
  1193. <div class="footer">
  1194. <div class="container">
  1195. <span class="pull-right">
  1196. <a href="#top">Back to top</a>
  1197. </span>
  1198. <span>Generated by <strong>DocFX</strong></span>
  1199. </div>
  1200. </div>
  1201. </footer>
  1202. </div>
  1203. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  1204. <script type="text/javascript" src="../../styles/docfx.js"></script>
  1205. <script type="text/javascript" src="../../styles/main.js"></script>
  1206. </body>
  1207. </html>