Terminal.Gui.TextView.html 72 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950
  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_Focused">View.Focused</a>
  255. </div>
  256. <div>
  257. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  258. </div>
  259. <div>
  260. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  261. </div>
  262. <div>
  263. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  264. </div>
  265. <div>
  266. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  267. </div>
  268. <div>
  269. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  270. </div>
  271. <div>
  272. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  273. </div>
  274. <div>
  275. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus">View.SetFocus()</a>
  276. </div>
  277. <div>
  278. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  279. </div>
  280. <div>
  281. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  282. </div>
  283. <div>
  284. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  285. </div>
  286. <div>
  287. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  288. </div>
  289. <div>
  290. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  291. </div>
  292. <div>
  293. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  294. </div>
  295. <div>
  296. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  297. </div>
  298. <div>
  299. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  300. </div>
  301. <div>
  302. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  303. </div>
  304. <div>
  305. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  306. </div>
  307. <div>
  308. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  309. </div>
  310. <div>
  311. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStarted">View.LayoutStarted</a>
  312. </div>
  313. <div>
  314. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  315. </div>
  316. <div>
  317. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Initialized">View.Initialized</a>
  318. </div>
  319. <div>
  320. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  321. </div>
  322. <div>
  323. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AutoSize">View.AutoSize</a>
  324. </div>
  325. <div>
  326. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">View.TextAlignment</a>
  327. </div>
  328. <div>
  329. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VerticalTextAlignment">View.VerticalTextAlignment</a>
  330. </div>
  331. <div>
  332. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextDirection">View.TextDirection</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.View.html#Terminal_Gui_View_GetCurrentWidth_System_Int32__">View.GetCurrentWidth(Int32)</a>
  372. </div>
  373. <div>
  374. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentHeight_System_Int32__">View.GetCurrentHeight(Int32)</a>
  375. </div>
  376. <div>
  377. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
  378. </div>
  379. <div>
  380. <span class="xref">System.Object.Equals(System.Object)</span>
  381. </div>
  382. <div>
  383. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  384. </div>
  385. <div>
  386. <span class="xref">System.Object.GetHashCode()</span>
  387. </div>
  388. <div>
  389. <span class="xref">System.Object.GetType()</span>
  390. </div>
  391. <div>
  392. <span class="xref">System.Object.MemberwiseClone()</span>
  393. </div>
  394. <div>
  395. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  396. </div>
  397. </div>
  398. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  399. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  400. <h5 id="Terminal_Gui_TextView_syntax">Syntax</h5>
  401. <div class="codewrapper">
  402. <pre><code class="lang-csharp hljs">public class TextView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize</code></pre>
  403. </div>
  404. <h5 id="Terminal_Gui_TextView_remarks"><strong>Remarks</strong></h5>
  405. <div class="markdown level0 remarks">
  406. <p>
  407. <a class="xref" href="Terminal.Gui.TextView.html">TextView</a> provides a multi-line text editor. Users interact
  408. with it with the standard Emacs commands for movement or the arrow
  409. keys.
  410. </p>
  411. <table><thead><tr><th>Shortcut</th><th>Action performed</th></tr></thead><tbody><tr><td>Left cursor, Control-b</td><td>
  412. Moves the editing point left.
  413. </td></tr><tr><td>Right cursor, Control-f</td><td>
  414. Moves the editing point right.
  415. </td></tr><tr><td>Alt-b</td><td>
  416. Moves one word back.
  417. </td></tr><tr><td>Alt-f</td><td>
  418. Moves one word forward.
  419. </td></tr><tr><td>Up cursor, Control-p</td><td>
  420. Moves the editing point one line up.
  421. </td></tr><tr><td>Down cursor, Control-n</td><td>
  422. Moves the editing point one line down
  423. </td></tr><tr><td>Home key, Control-a</td><td>
  424. Moves the cursor to the beginning of the line.
  425. </td></tr><tr><td>End key, Control-e</td><td>
  426. Moves the cursor to the end of the line.
  427. </td></tr><tr><td>Control-Home</td><td>
  428. Scrolls to the first line and moves the cursor there.
  429. </td></tr><tr><td>Control-End</td><td>
  430. Scrolls to the last line and moves the cursor there.
  431. </td></tr><tr><td>Delete, Control-d</td><td>
  432. Deletes the character in front of the cursor.
  433. </td></tr><tr><td>Backspace</td><td>
  434. Deletes the character behind the cursor.
  435. </td></tr><tr><td>Control-k</td><td>
  436. Deletes the text until the end of the line and replaces the kill buffer
  437. with the deleted text. You can paste this text in a different place by
  438. using Control-y.
  439. </td></tr><tr><td>Control-y</td><td>
  440. Pastes the content of the kill ring into the current position.
  441. </td></tr><tr><td>Alt-d</td><td>
  442. Deletes the word above the cursor and adds it to the kill ring. You
  443. can paste the contents of the kill ring with Control-y.
  444. </td></tr><tr><td>Control-q</td><td>
  445. Quotes the next input character, to prevent the normal processing of
  446. key handling to take place.
  447. </td></tr></tbody></table>
  448. </div>
  449. <h3 id="constructors">Constructors
  450. </h3>
  451. <a id="Terminal_Gui_TextView__ctor_" data-uid="Terminal.Gui.TextView.#ctor*"></a>
  452. <h4 id="Terminal_Gui_TextView__ctor" data-uid="Terminal.Gui.TextView.#ctor">TextView()</h4>
  453. <div class="markdown level1 summary">
  454. Initializes a <a class="xref" href="Terminal.Gui.TextView.html">TextView</a> on the specified area,
  455. with dimensions controlled with the X, Y, Width and Height properties.
  456. </div>
  457. <div class="markdown level1 conceptual"></div>
  458. <h5 class="decalaration">Declaration</h5>
  459. <div class="codewrapper">
  460. <pre><code class="lang-csharp hljs">public TextView()</code></pre>
  461. </div>
  462. <a id="Terminal_Gui_TextView__ctor_" data-uid="Terminal.Gui.TextView.#ctor*"></a>
  463. <h4 id="Terminal_Gui_TextView__ctor_Terminal_Gui_Rect_" data-uid="Terminal.Gui.TextView.#ctor(Terminal.Gui.Rect)">TextView(Rect)</h4>
  464. <div class="markdown level1 summary">
  465. Initializes a <a class="xref" href="Terminal.Gui.TextView.html">TextView</a> on the specified area, with absolute position and size.
  466. </div>
  467. <div class="markdown level1 conceptual"></div>
  468. <h5 class="decalaration">Declaration</h5>
  469. <div class="codewrapper">
  470. <pre><code class="lang-csharp hljs">public TextView(Rect frame)</code></pre>
  471. </div>
  472. <h5 class="parameters">Parameters</h5>
  473. <table class="table table-bordered table-striped table-condensed">
  474. <thead>
  475. <tr>
  476. <th>Type</th>
  477. <th>Name</th>
  478. <th>Description</th>
  479. </tr>
  480. </thead>
  481. <tbody>
  482. <tr>
  483. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  484. <td><span class="parametername">frame</span></td>
  485. <td></td>
  486. </tr>
  487. </tbody>
  488. </table>
  489. <h5 id="Terminal_Gui_TextView__ctor_Terminal_Gui_Rect__remarks">Remarks</h5>
  490. <div class="markdown level1 remarks">
  491. </div>
  492. <h3 id="properties">Properties
  493. </h3>
  494. <a id="Terminal_Gui_TextView_AllowsReturn_" data-uid="Terminal.Gui.TextView.AllowsReturn*"></a>
  495. <h4 id="Terminal_Gui_TextView_AllowsReturn" data-uid="Terminal.Gui.TextView.AllowsReturn">AllowsReturn</h4>
  496. <div class="markdown level1 summary">
  497. Gets or sets a value indicating whether pressing ENTER in a <a class="xref" href="Terminal.Gui.TextView.html">TextView</a>
  498. creates a new line of text in the view or activates the default button for the toplevel.
  499. </div>
  500. <div class="markdown level1 conceptual"></div>
  501. <h5 class="decalaration">Declaration</h5>
  502. <div class="codewrapper">
  503. <pre><code class="lang-csharp hljs">public bool AllowsReturn { get; set; }</code></pre>
  504. </div>
  505. <h5 class="propertyValue">Property Value</h5>
  506. <table class="table table-bordered table-striped table-condensed">
  507. <thead>
  508. <tr>
  509. <th>Type</th>
  510. <th>Description</th>
  511. </tr>
  512. </thead>
  513. <tbody>
  514. <tr>
  515. <td><span class="xref">System.Boolean</span></td>
  516. <td></td>
  517. </tr>
  518. </tbody>
  519. </table>
  520. <a id="Terminal_Gui_TextView_AllowsTab_" data-uid="Terminal.Gui.TextView.AllowsTab*"></a>
  521. <h4 id="Terminal_Gui_TextView_AllowsTab" data-uid="Terminal.Gui.TextView.AllowsTab">AllowsTab</h4>
  522. <div class="markdown level1 summary">
  523. Gets or sets a value indicating whether pressing the TAB key in a <a class="xref" href="Terminal.Gui.TextView.html">TextView</a>
  524. types a TAB character in the view instead of moving the focus to the next view in the tab order.
  525. </div>
  526. <div class="markdown level1 conceptual"></div>
  527. <h5 class="decalaration">Declaration</h5>
  528. <div class="codewrapper">
  529. <pre><code class="lang-csharp hljs">public bool AllowsTab { get; set; }</code></pre>
  530. </div>
  531. <h5 class="propertyValue">Property Value</h5>
  532. <table class="table table-bordered table-striped table-condensed">
  533. <thead>
  534. <tr>
  535. <th>Type</th>
  536. <th>Description</th>
  537. </tr>
  538. </thead>
  539. <tbody>
  540. <tr>
  541. <td><span class="xref">System.Boolean</span></td>
  542. <td></td>
  543. </tr>
  544. </tbody>
  545. </table>
  546. <a id="Terminal_Gui_TextView_BottomOffset_" data-uid="Terminal.Gui.TextView.BottomOffset*"></a>
  547. <h4 id="Terminal_Gui_TextView_BottomOffset" data-uid="Terminal.Gui.TextView.BottomOffset">BottomOffset</h4>
  548. <div class="markdown level1 summary">
  549. The bottom offset needed to use a horizontal scrollbar or for another reason.
  550. This is only needed with the keyboard navigation.
  551. </div>
  552. <div class="markdown level1 conceptual"></div>
  553. <h5 class="decalaration">Declaration</h5>
  554. <div class="codewrapper">
  555. <pre><code class="lang-csharp hljs">public int BottomOffset { get; set; }</code></pre>
  556. </div>
  557. <h5 class="propertyValue">Property Value</h5>
  558. <table class="table table-bordered table-striped table-condensed">
  559. <thead>
  560. <tr>
  561. <th>Type</th>
  562. <th>Description</th>
  563. </tr>
  564. </thead>
  565. <tbody>
  566. <tr>
  567. <td><span class="xref">System.Int32</span></td>
  568. <td></td>
  569. </tr>
  570. </tbody>
  571. </table>
  572. <a id="Terminal_Gui_TextView_CanFocus_" data-uid="Terminal.Gui.TextView.CanFocus*"></a>
  573. <h4 id="Terminal_Gui_TextView_CanFocus" data-uid="Terminal.Gui.TextView.CanFocus">CanFocus</h4>
  574. <div class="markdown level1 summary"></div>
  575. <div class="markdown level1 conceptual"></div>
  576. <h5 class="decalaration">Declaration</h5>
  577. <div class="codewrapper">
  578. <pre><code class="lang-csharp hljs">public override bool CanFocus { get; set; }</code></pre>
  579. </div>
  580. <h5 class="propertyValue">Property Value</h5>
  581. <table class="table table-bordered table-striped table-condensed">
  582. <thead>
  583. <tr>
  584. <th>Type</th>
  585. <th>Description</th>
  586. </tr>
  587. </thead>
  588. <tbody>
  589. <tr>
  590. <td><span class="xref">System.Boolean</span></td>
  591. <td></td>
  592. </tr>
  593. </tbody>
  594. </table>
  595. <h5 class="overrides">Overrides</h5>
  596. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocus">View.CanFocus</a></div>
  597. <a id="Terminal_Gui_TextView_CurrentColumn_" data-uid="Terminal.Gui.TextView.CurrentColumn*"></a>
  598. <h4 id="Terminal_Gui_TextView_CurrentColumn" data-uid="Terminal.Gui.TextView.CurrentColumn">CurrentColumn</h4>
  599. <div class="markdown level1 summary">
  600. Gets the cursor column.
  601. </div>
  602. <div class="markdown level1 conceptual"></div>
  603. <h5 class="decalaration">Declaration</h5>
  604. <div class="codewrapper">
  605. <pre><code class="lang-csharp hljs">public int CurrentColumn { get; }</code></pre>
  606. </div>
  607. <h5 class="propertyValue">Property Value</h5>
  608. <table class="table table-bordered table-striped table-condensed">
  609. <thead>
  610. <tr>
  611. <th>Type</th>
  612. <th>Description</th>
  613. </tr>
  614. </thead>
  615. <tbody>
  616. <tr>
  617. <td><span class="xref">System.Int32</span></td>
  618. <td>The cursor column.</td>
  619. </tr>
  620. </tbody>
  621. </table>
  622. <a id="Terminal_Gui_TextView_CurrentRow_" data-uid="Terminal.Gui.TextView.CurrentRow*"></a>
  623. <h4 id="Terminal_Gui_TextView_CurrentRow" data-uid="Terminal.Gui.TextView.CurrentRow">CurrentRow</h4>
  624. <div class="markdown level1 summary">
  625. Gets the current cursor row.
  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 int CurrentRow { get; }</code></pre>
  631. </div>
  632. <h5 class="propertyValue">Property Value</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.Int32</span></td>
  643. <td></td>
  644. </tr>
  645. </tbody>
  646. </table>
  647. <a id="Terminal_Gui_TextView_CursorPosition_" data-uid="Terminal.Gui.TextView.CursorPosition*"></a>
  648. <h4 id="Terminal_Gui_TextView_CursorPosition" data-uid="Terminal.Gui.TextView.CursorPosition">CursorPosition</h4>
  649. <div class="markdown level1 summary">
  650. Sets or gets the current cursor position.
  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 Point CursorPosition { get; set; }</code></pre>
  656. </div>
  657. <h5 class="propertyValue">Property Value</h5>
  658. <table class="table table-bordered table-striped table-condensed">
  659. <thead>
  660. <tr>
  661. <th>Type</th>
  662. <th>Description</th>
  663. </tr>
  664. </thead>
  665. <tbody>
  666. <tr>
  667. <td><a class="xref" href="Terminal.Gui.Point.html">Point</a></td>
  668. <td></td>
  669. </tr>
  670. </tbody>
  671. </table>
  672. <a id="Terminal_Gui_TextView_DesiredCursorVisibility_" data-uid="Terminal.Gui.TextView.DesiredCursorVisibility*"></a>
  673. <h4 id="Terminal_Gui_TextView_DesiredCursorVisibility" data-uid="Terminal.Gui.TextView.DesiredCursorVisibility">DesiredCursorVisibility</h4>
  674. <div class="markdown level1 summary">
  675. Get / Set the wished cursor when the field is focused
  676. </div>
  677. <div class="markdown level1 conceptual"></div>
  678. <h5 class="decalaration">Declaration</h5>
  679. <div class="codewrapper">
  680. <pre><code class="lang-csharp hljs">public CursorVisibility DesiredCursorVisibility { get; set; }</code></pre>
  681. </div>
  682. <h5 class="propertyValue">Property Value</h5>
  683. <table class="table table-bordered table-striped table-condensed">
  684. <thead>
  685. <tr>
  686. <th>Type</th>
  687. <th>Description</th>
  688. </tr>
  689. </thead>
  690. <tbody>
  691. <tr>
  692. <td><a class="xref" href="Terminal.Gui.CursorVisibility.html">CursorVisibility</a></td>
  693. <td></td>
  694. </tr>
  695. </tbody>
  696. </table>
  697. <a id="Terminal_Gui_TextView_Frame_" data-uid="Terminal.Gui.TextView.Frame*"></a>
  698. <h4 id="Terminal_Gui_TextView_Frame" data-uid="Terminal.Gui.TextView.Frame">Frame</h4>
  699. <div class="markdown level1 summary"></div>
  700. <div class="markdown level1 conceptual"></div>
  701. <h5 class="decalaration">Declaration</h5>
  702. <div class="codewrapper">
  703. <pre><code class="lang-csharp hljs">public override Rect Frame { get; set; }</code></pre>
  704. </div>
  705. <h5 class="propertyValue">Property Value</h5>
  706. <table class="table table-bordered table-striped table-condensed">
  707. <thead>
  708. <tr>
  709. <th>Type</th>
  710. <th>Description</th>
  711. </tr>
  712. </thead>
  713. <tbody>
  714. <tr>
  715. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  716. <td></td>
  717. </tr>
  718. </tbody>
  719. </table>
  720. <h5 class="overrides">Overrides</h5>
  721. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a></div>
  722. <a id="Terminal_Gui_TextView_LeftColumn_" data-uid="Terminal.Gui.TextView.LeftColumn*"></a>
  723. <h4 id="Terminal_Gui_TextView_LeftColumn" data-uid="Terminal.Gui.TextView.LeftColumn">LeftColumn</h4>
  724. <div class="markdown level1 summary">
  725. Gets or sets the left column.
  726. </div>
  727. <div class="markdown level1 conceptual"></div>
  728. <h5 class="decalaration">Declaration</h5>
  729. <div class="codewrapper">
  730. <pre><code class="lang-csharp hljs">public int LeftColumn { get; set; }</code></pre>
  731. </div>
  732. <h5 class="propertyValue">Property Value</h5>
  733. <table class="table table-bordered table-striped table-condensed">
  734. <thead>
  735. <tr>
  736. <th>Type</th>
  737. <th>Description</th>
  738. </tr>
  739. </thead>
  740. <tbody>
  741. <tr>
  742. <td><span class="xref">System.Int32</span></td>
  743. <td></td>
  744. </tr>
  745. </tbody>
  746. </table>
  747. <a id="Terminal_Gui_TextView_Lines_" data-uid="Terminal.Gui.TextView.Lines*"></a>
  748. <h4 id="Terminal_Gui_TextView_Lines" data-uid="Terminal.Gui.TextView.Lines">Lines</h4>
  749. <div class="markdown level1 summary">
  750. Gets the number of lines.
  751. </div>
  752. <div class="markdown level1 conceptual"></div>
  753. <h5 class="decalaration">Declaration</h5>
  754. <div class="codewrapper">
  755. <pre><code class="lang-csharp hljs">public int Lines { get; }</code></pre>
  756. </div>
  757. <h5 class="propertyValue">Property Value</h5>
  758. <table class="table table-bordered table-striped table-condensed">
  759. <thead>
  760. <tr>
  761. <th>Type</th>
  762. <th>Description</th>
  763. </tr>
  764. </thead>
  765. <tbody>
  766. <tr>
  767. <td><span class="xref">System.Int32</span></td>
  768. <td></td>
  769. </tr>
  770. </tbody>
  771. </table>
  772. <a id="Terminal_Gui_TextView_Maxlength_" data-uid="Terminal.Gui.TextView.Maxlength*"></a>
  773. <h4 id="Terminal_Gui_TextView_Maxlength" data-uid="Terminal.Gui.TextView.Maxlength">Maxlength</h4>
  774. <div class="markdown level1 summary">
  775. Gets the maximum visible length line.
  776. </div>
  777. <div class="markdown level1 conceptual"></div>
  778. <h5 class="decalaration">Declaration</h5>
  779. <div class="codewrapper">
  780. <pre><code class="lang-csharp hljs">public int Maxlength { get; }</code></pre>
  781. </div>
  782. <h5 class="propertyValue">Property Value</h5>
  783. <table class="table table-bordered table-striped table-condensed">
  784. <thead>
  785. <tr>
  786. <th>Type</th>
  787. <th>Description</th>
  788. </tr>
  789. </thead>
  790. <tbody>
  791. <tr>
  792. <td><span class="xref">System.Int32</span></td>
  793. <td></td>
  794. </tr>
  795. </tbody>
  796. </table>
  797. <a id="Terminal_Gui_TextView_Multiline_" data-uid="Terminal.Gui.TextView.Multiline*"></a>
  798. <h4 id="Terminal_Gui_TextView_Multiline" data-uid="Terminal.Gui.TextView.Multiline">Multiline</h4>
  799. <div class="markdown level1 summary">
  800. Gets or sets a value indicating whether this <a class="xref" href="Terminal.Gui.TextView.html">TextView</a> is a multiline text view.
  801. </div>
  802. <div class="markdown level1 conceptual"></div>
  803. <h5 class="decalaration">Declaration</h5>
  804. <div class="codewrapper">
  805. <pre><code class="lang-csharp hljs">public bool Multiline { get; set; }</code></pre>
  806. </div>
  807. <h5 class="propertyValue">Property Value</h5>
  808. <table class="table table-bordered table-striped table-condensed">
  809. <thead>
  810. <tr>
  811. <th>Type</th>
  812. <th>Description</th>
  813. </tr>
  814. </thead>
  815. <tbody>
  816. <tr>
  817. <td><span class="xref">System.Boolean</span></td>
  818. <td></td>
  819. </tr>
  820. </tbody>
  821. </table>
  822. <a id="Terminal_Gui_TextView_ReadOnly_" data-uid="Terminal.Gui.TextView.ReadOnly*"></a>
  823. <h4 id="Terminal_Gui_TextView_ReadOnly" data-uid="Terminal.Gui.TextView.ReadOnly">ReadOnly</h4>
  824. <div class="markdown level1 summary">
  825. Gets or sets whether the <a class="xref" href="Terminal.Gui.TextView.html">TextView</a> is in read-only mode or not
  826. </div>
  827. <div class="markdown level1 conceptual"></div>
  828. <h5 class="decalaration">Declaration</h5>
  829. <div class="codewrapper">
  830. <pre><code class="lang-csharp hljs">public bool ReadOnly { get; set; }</code></pre>
  831. </div>
  832. <h5 class="propertyValue">Property Value</h5>
  833. <table class="table table-bordered table-striped table-condensed">
  834. <thead>
  835. <tr>
  836. <th>Type</th>
  837. <th>Description</th>
  838. </tr>
  839. </thead>
  840. <tbody>
  841. <tr>
  842. <td><span class="xref">System.Boolean</span></td>
  843. <td>Boolean value(Default false)</td>
  844. </tr>
  845. </tbody>
  846. </table>
  847. <a id="Terminal_Gui_TextView_RightOffset_" data-uid="Terminal.Gui.TextView.RightOffset*"></a>
  848. <h4 id="Terminal_Gui_TextView_RightOffset" data-uid="Terminal.Gui.TextView.RightOffset">RightOffset</h4>
  849. <div class="markdown level1 summary">
  850. The right offset needed to use a vertical scrollbar or for another reason.
  851. This is only needed with the keyboard navigation.
  852. </div>
  853. <div class="markdown level1 conceptual"></div>
  854. <h5 class="decalaration">Declaration</h5>
  855. <div class="codewrapper">
  856. <pre><code class="lang-csharp hljs">public int RightOffset { get; set; }</code></pre>
  857. </div>
  858. <h5 class="propertyValue">Property Value</h5>
  859. <table class="table table-bordered table-striped table-condensed">
  860. <thead>
  861. <tr>
  862. <th>Type</th>
  863. <th>Description</th>
  864. </tr>
  865. </thead>
  866. <tbody>
  867. <tr>
  868. <td><span class="xref">System.Int32</span></td>
  869. <td></td>
  870. </tr>
  871. </tbody>
  872. </table>
  873. <a id="Terminal_Gui_TextView_SelectedLength_" data-uid="Terminal.Gui.TextView.SelectedLength*"></a>
  874. <h4 id="Terminal_Gui_TextView_SelectedLength" data-uid="Terminal.Gui.TextView.SelectedLength">SelectedLength</h4>
  875. <div class="markdown level1 summary">
  876. Length of the selected text.
  877. </div>
  878. <div class="markdown level1 conceptual"></div>
  879. <h5 class="decalaration">Declaration</h5>
  880. <div class="codewrapper">
  881. <pre><code class="lang-csharp hljs">public int SelectedLength { get; }</code></pre>
  882. </div>
  883. <h5 class="propertyValue">Property Value</h5>
  884. <table class="table table-bordered table-striped table-condensed">
  885. <thead>
  886. <tr>
  887. <th>Type</th>
  888. <th>Description</th>
  889. </tr>
  890. </thead>
  891. <tbody>
  892. <tr>
  893. <td><span class="xref">System.Int32</span></td>
  894. <td></td>
  895. </tr>
  896. </tbody>
  897. </table>
  898. <a id="Terminal_Gui_TextView_SelectedText_" data-uid="Terminal.Gui.TextView.SelectedText*"></a>
  899. <h4 id="Terminal_Gui_TextView_SelectedText" data-uid="Terminal.Gui.TextView.SelectedText">SelectedText</h4>
  900. <div class="markdown level1 summary">
  901. The selected text.
  902. </div>
  903. <div class="markdown level1 conceptual"></div>
  904. <h5 class="decalaration">Declaration</h5>
  905. <div class="codewrapper">
  906. <pre><code class="lang-csharp hljs">public ustring SelectedText { get; }</code></pre>
  907. </div>
  908. <h5 class="propertyValue">Property Value</h5>
  909. <table class="table table-bordered table-striped table-condensed">
  910. <thead>
  911. <tr>
  912. <th>Type</th>
  913. <th>Description</th>
  914. </tr>
  915. </thead>
  916. <tbody>
  917. <tr>
  918. <td><span class="xref">NStack.ustring</span></td>
  919. <td></td>
  920. </tr>
  921. </tbody>
  922. </table>
  923. <a id="Terminal_Gui_TextView_Selecting_" data-uid="Terminal.Gui.TextView.Selecting*"></a>
  924. <h4 id="Terminal_Gui_TextView_Selecting" data-uid="Terminal.Gui.TextView.Selecting">Selecting</h4>
  925. <div class="markdown level1 summary">
  926. Get or sets the selecting.
  927. </div>
  928. <div class="markdown level1 conceptual"></div>
  929. <h5 class="decalaration">Declaration</h5>
  930. <div class="codewrapper">
  931. <pre><code class="lang-csharp hljs">public bool Selecting { get; set; }</code></pre>
  932. </div>
  933. <h5 class="propertyValue">Property Value</h5>
  934. <table class="table table-bordered table-striped table-condensed">
  935. <thead>
  936. <tr>
  937. <th>Type</th>
  938. <th>Description</th>
  939. </tr>
  940. </thead>
  941. <tbody>
  942. <tr>
  943. <td><span class="xref">System.Boolean</span></td>
  944. <td></td>
  945. </tr>
  946. </tbody>
  947. </table>
  948. <a id="Terminal_Gui_TextView_SelectionStartColumn_" data-uid="Terminal.Gui.TextView.SelectionStartColumn*"></a>
  949. <h4 id="Terminal_Gui_TextView_SelectionStartColumn" data-uid="Terminal.Gui.TextView.SelectionStartColumn">SelectionStartColumn</h4>
  950. <div class="markdown level1 summary">
  951. Start column position of the selected text.
  952. </div>
  953. <div class="markdown level1 conceptual"></div>
  954. <h5 class="decalaration">Declaration</h5>
  955. <div class="codewrapper">
  956. <pre><code class="lang-csharp hljs">public int SelectionStartColumn { get; set; }</code></pre>
  957. </div>
  958. <h5 class="propertyValue">Property Value</h5>
  959. <table class="table table-bordered table-striped table-condensed">
  960. <thead>
  961. <tr>
  962. <th>Type</th>
  963. <th>Description</th>
  964. </tr>
  965. </thead>
  966. <tbody>
  967. <tr>
  968. <td><span class="xref">System.Int32</span></td>
  969. <td></td>
  970. </tr>
  971. </tbody>
  972. </table>
  973. <a id="Terminal_Gui_TextView_SelectionStartRow_" data-uid="Terminal.Gui.TextView.SelectionStartRow*"></a>
  974. <h4 id="Terminal_Gui_TextView_SelectionStartRow" data-uid="Terminal.Gui.TextView.SelectionStartRow">SelectionStartRow</h4>
  975. <div class="markdown level1 summary">
  976. Start row position of the selected text.
  977. </div>
  978. <div class="markdown level1 conceptual"></div>
  979. <h5 class="decalaration">Declaration</h5>
  980. <div class="codewrapper">
  981. <pre><code class="lang-csharp hljs">public int SelectionStartRow { get; set; }</code></pre>
  982. </div>
  983. <h5 class="propertyValue">Property Value</h5>
  984. <table class="table table-bordered table-striped table-condensed">
  985. <thead>
  986. <tr>
  987. <th>Type</th>
  988. <th>Description</th>
  989. </tr>
  990. </thead>
  991. <tbody>
  992. <tr>
  993. <td><span class="xref">System.Int32</span></td>
  994. <td></td>
  995. </tr>
  996. </tbody>
  997. </table>
  998. <a id="Terminal_Gui_TextView_TabWidth_" data-uid="Terminal.Gui.TextView.TabWidth*"></a>
  999. <h4 id="Terminal_Gui_TextView_TabWidth" data-uid="Terminal.Gui.TextView.TabWidth">TabWidth</h4>
  1000. <div class="markdown level1 summary">
  1001. Gets or sets a value indicating the number of whitespace when pressing the TAB key.
  1002. </div>
  1003. <div class="markdown level1 conceptual"></div>
  1004. <h5 class="decalaration">Declaration</h5>
  1005. <div class="codewrapper">
  1006. <pre><code class="lang-csharp hljs">public int TabWidth { get; set; }</code></pre>
  1007. </div>
  1008. <h5 class="propertyValue">Property Value</h5>
  1009. <table class="table table-bordered table-striped table-condensed">
  1010. <thead>
  1011. <tr>
  1012. <th>Type</th>
  1013. <th>Description</th>
  1014. </tr>
  1015. </thead>
  1016. <tbody>
  1017. <tr>
  1018. <td><span class="xref">System.Int32</span></td>
  1019. <td></td>
  1020. </tr>
  1021. </tbody>
  1022. </table>
  1023. <a id="Terminal_Gui_TextView_Text_" data-uid="Terminal.Gui.TextView.Text*"></a>
  1024. <h4 id="Terminal_Gui_TextView_Text" data-uid="Terminal.Gui.TextView.Text">Text</h4>
  1025. <div class="markdown level1 summary">
  1026. Sets or gets the text in the <a class="xref" href="Terminal.Gui.TextView.html">TextView</a>.
  1027. </div>
  1028. <div class="markdown level1 conceptual"></div>
  1029. <h5 class="decalaration">Declaration</h5>
  1030. <div class="codewrapper">
  1031. <pre><code class="lang-csharp hljs">public override ustring Text { get; set; }</code></pre>
  1032. </div>
  1033. <h5 class="propertyValue">Property Value</h5>
  1034. <table class="table table-bordered table-striped table-condensed">
  1035. <thead>
  1036. <tr>
  1037. <th>Type</th>
  1038. <th>Description</th>
  1039. </tr>
  1040. </thead>
  1041. <tbody>
  1042. <tr>
  1043. <td><span class="xref">NStack.ustring</span></td>
  1044. <td></td>
  1045. </tr>
  1046. </tbody>
  1047. </table>
  1048. <h5 class="overrides">Overrides</h5>
  1049. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">View.Text</a></div>
  1050. <h5 id="Terminal_Gui_TextView_Text_remarks">Remarks</h5>
  1051. <div class="markdown level1 remarks">
  1052. </div>
  1053. <a id="Terminal_Gui_TextView_TopRow_" data-uid="Terminal.Gui.TextView.TopRow*"></a>
  1054. <h4 id="Terminal_Gui_TextView_TopRow" data-uid="Terminal.Gui.TextView.TopRow">TopRow</h4>
  1055. <div class="markdown level1 summary">
  1056. Gets or sets the top row.
  1057. </div>
  1058. <div class="markdown level1 conceptual"></div>
  1059. <h5 class="decalaration">Declaration</h5>
  1060. <div class="codewrapper">
  1061. <pre><code class="lang-csharp hljs">public int TopRow { get; set; }</code></pre>
  1062. </div>
  1063. <h5 class="propertyValue">Property Value</h5>
  1064. <table class="table table-bordered table-striped table-condensed">
  1065. <thead>
  1066. <tr>
  1067. <th>Type</th>
  1068. <th>Description</th>
  1069. </tr>
  1070. </thead>
  1071. <tbody>
  1072. <tr>
  1073. <td><span class="xref">System.Int32</span></td>
  1074. <td></td>
  1075. </tr>
  1076. </tbody>
  1077. </table>
  1078. <a id="Terminal_Gui_TextView_Used_" data-uid="Terminal.Gui.TextView.Used*"></a>
  1079. <h4 id="Terminal_Gui_TextView_Used" data-uid="Terminal.Gui.TextView.Used">Used</h4>
  1080. <div class="markdown level1 summary">
  1081. Tracks whether the text view should be considered &quot;used&quot;, that is, that the user has moved in the entry,
  1082. so new input should be appended at the cursor position, rather than clearing the entry
  1083. </div>
  1084. <div class="markdown level1 conceptual"></div>
  1085. <h5 class="decalaration">Declaration</h5>
  1086. <div class="codewrapper">
  1087. <pre><code class="lang-csharp hljs">public bool Used { get; set; }</code></pre>
  1088. </div>
  1089. <h5 class="propertyValue">Property Value</h5>
  1090. <table class="table table-bordered table-striped table-condensed">
  1091. <thead>
  1092. <tr>
  1093. <th>Type</th>
  1094. <th>Description</th>
  1095. </tr>
  1096. </thead>
  1097. <tbody>
  1098. <tr>
  1099. <td><span class="xref">System.Boolean</span></td>
  1100. <td></td>
  1101. </tr>
  1102. </tbody>
  1103. </table>
  1104. <a id="Terminal_Gui_TextView_WordWrap_" data-uid="Terminal.Gui.TextView.WordWrap*"></a>
  1105. <h4 id="Terminal_Gui_TextView_WordWrap" data-uid="Terminal.Gui.TextView.WordWrap">WordWrap</h4>
  1106. <div class="markdown level1 summary">
  1107. Allows word wrap the to fit the available container width.
  1108. </div>
  1109. <div class="markdown level1 conceptual"></div>
  1110. <h5 class="decalaration">Declaration</h5>
  1111. <div class="codewrapper">
  1112. <pre><code class="lang-csharp hljs">public bool WordWrap { get; set; }</code></pre>
  1113. </div>
  1114. <h5 class="propertyValue">Property Value</h5>
  1115. <table class="table table-bordered table-striped table-condensed">
  1116. <thead>
  1117. <tr>
  1118. <th>Type</th>
  1119. <th>Description</th>
  1120. </tr>
  1121. </thead>
  1122. <tbody>
  1123. <tr>
  1124. <td><span class="xref">System.Boolean</span></td>
  1125. <td></td>
  1126. </tr>
  1127. </tbody>
  1128. </table>
  1129. <h3 id="methods">Methods
  1130. </h3>
  1131. <a id="Terminal_Gui_TextView_CloseFile_" data-uid="Terminal.Gui.TextView.CloseFile*"></a>
  1132. <h4 id="Terminal_Gui_TextView_CloseFile" data-uid="Terminal.Gui.TextView.CloseFile">CloseFile()</h4>
  1133. <div class="markdown level1 summary">
  1134. Closes the contents of the stream into the <a class="xref" href="Terminal.Gui.TextView.html">TextView</a>.
  1135. </div>
  1136. <div class="markdown level1 conceptual"></div>
  1137. <h5 class="decalaration">Declaration</h5>
  1138. <div class="codewrapper">
  1139. <pre><code class="lang-csharp hljs">public bool CloseFile()</code></pre>
  1140. </div>
  1141. <h5 class="returns">Returns</h5>
  1142. <table class="table table-bordered table-striped table-condensed">
  1143. <thead>
  1144. <tr>
  1145. <th>Type</th>
  1146. <th>Description</th>
  1147. </tr>
  1148. </thead>
  1149. <tbody>
  1150. <tr>
  1151. <td><span class="xref">System.Boolean</span></td>
  1152. <td><code>true</code>, if stream was closed, <code>false</code> otherwise.</td>
  1153. </tr>
  1154. </tbody>
  1155. </table>
  1156. <a id="Terminal_Gui_TextView_Copy_" data-uid="Terminal.Gui.TextView.Copy*"></a>
  1157. <h4 id="Terminal_Gui_TextView_Copy" data-uid="Terminal.Gui.TextView.Copy">Copy()</h4>
  1158. <div class="markdown level1 summary">
  1159. Copy the selected text to the clipboard contents.
  1160. </div>
  1161. <div class="markdown level1 conceptual"></div>
  1162. <h5 class="decalaration">Declaration</h5>
  1163. <div class="codewrapper">
  1164. <pre><code class="lang-csharp hljs">public void Copy()</code></pre>
  1165. </div>
  1166. <a id="Terminal_Gui_TextView_Cut_" data-uid="Terminal.Gui.TextView.Cut*"></a>
  1167. <h4 id="Terminal_Gui_TextView_Cut" data-uid="Terminal.Gui.TextView.Cut">Cut()</h4>
  1168. <div class="markdown level1 summary">
  1169. Cut the selected text to the clipboard contents.
  1170. </div>
  1171. <div class="markdown level1 conceptual"></div>
  1172. <h5 class="decalaration">Declaration</h5>
  1173. <div class="codewrapper">
  1174. <pre><code class="lang-csharp hljs">public void Cut()</code></pre>
  1175. </div>
  1176. <a id="Terminal_Gui_TextView_FindNextText_" data-uid="Terminal.Gui.TextView.FindNextText*"></a>
  1177. <h4 id="Terminal_Gui_TextView_FindNextText_NStack_ustring_System_Boolean__System_Boolean_System_Boolean_NStack_ustring_System_Boolean_" data-uid="Terminal.Gui.TextView.FindNextText(NStack.ustring,System.Boolean@,System.Boolean,System.Boolean,NStack.ustring,System.Boolean)">FindNextText(ustring, out Boolean, Boolean, Boolean, ustring, Boolean)</h4>
  1178. <div class="markdown level1 summary">
  1179. Find the next text based on the match case with the option to replace it.
  1180. </div>
  1181. <div class="markdown level1 conceptual"></div>
  1182. <h5 class="decalaration">Declaration</h5>
  1183. <div class="codewrapper">
  1184. <pre><code class="lang-csharp hljs">public bool FindNextText(ustring textToFind, out bool gaveFullTurn, bool matchCase = false, bool matchWholeWord = false, ustring textToReplace = null, bool replace = false)</code></pre>
  1185. </div>
  1186. <h5 class="parameters">Parameters</h5>
  1187. <table class="table table-bordered table-striped table-condensed">
  1188. <thead>
  1189. <tr>
  1190. <th>Type</th>
  1191. <th>Name</th>
  1192. <th>Description</th>
  1193. </tr>
  1194. </thead>
  1195. <tbody>
  1196. <tr>
  1197. <td><span class="xref">NStack.ustring</span></td>
  1198. <td><span class="parametername">textToFind</span></td>
  1199. <td>The text to find.</td>
  1200. </tr>
  1201. <tr>
  1202. <td><span class="xref">System.Boolean</span></td>
  1203. <td><span class="parametername">gaveFullTurn</span></td>
  1204. <td><code>true</code>If all the text was forward searched.<code>false</code>otherwise.</td>
  1205. </tr>
  1206. <tr>
  1207. <td><span class="xref">System.Boolean</span></td>
  1208. <td><span class="parametername">matchCase</span></td>
  1209. <td>The match case setting.</td>
  1210. </tr>
  1211. <tr>
  1212. <td><span class="xref">System.Boolean</span></td>
  1213. <td><span class="parametername">matchWholeWord</span></td>
  1214. <td>The match whole word setting.</td>
  1215. </tr>
  1216. <tr>
  1217. <td><span class="xref">NStack.ustring</span></td>
  1218. <td><span class="parametername">textToReplace</span></td>
  1219. <td>The text to replace.</td>
  1220. </tr>
  1221. <tr>
  1222. <td><span class="xref">System.Boolean</span></td>
  1223. <td><span class="parametername">replace</span></td>
  1224. <td><code>true</code>If is replacing.<code>false</code>otherwise.</td>
  1225. </tr>
  1226. </tbody>
  1227. </table>
  1228. <h5 class="returns">Returns</h5>
  1229. <table class="table table-bordered table-striped table-condensed">
  1230. <thead>
  1231. <tr>
  1232. <th>Type</th>
  1233. <th>Description</th>
  1234. </tr>
  1235. </thead>
  1236. <tbody>
  1237. <tr>
  1238. <td><span class="xref">System.Boolean</span></td>
  1239. <td><code>true</code>If the text was found.<code>false</code>otherwise.</td>
  1240. </tr>
  1241. </tbody>
  1242. </table>
  1243. <a id="Terminal_Gui_TextView_FindPreviousText_" data-uid="Terminal.Gui.TextView.FindPreviousText*"></a>
  1244. <h4 id="Terminal_Gui_TextView_FindPreviousText_NStack_ustring_System_Boolean__System_Boolean_System_Boolean_NStack_ustring_System_Boolean_" data-uid="Terminal.Gui.TextView.FindPreviousText(NStack.ustring,System.Boolean@,System.Boolean,System.Boolean,NStack.ustring,System.Boolean)">FindPreviousText(ustring, out Boolean, Boolean, Boolean, ustring, Boolean)</h4>
  1245. <div class="markdown level1 summary">
  1246. Find the previous text based on the match case with the option to replace it.
  1247. </div>
  1248. <div class="markdown level1 conceptual"></div>
  1249. <h5 class="decalaration">Declaration</h5>
  1250. <div class="codewrapper">
  1251. <pre><code class="lang-csharp hljs">public bool FindPreviousText(ustring textToFind, out bool gaveFullTurn, bool matchCase = false, bool matchWholeWord = false, ustring textToReplace = null, bool replace = false)</code></pre>
  1252. </div>
  1253. <h5 class="parameters">Parameters</h5>
  1254. <table class="table table-bordered table-striped table-condensed">
  1255. <thead>
  1256. <tr>
  1257. <th>Type</th>
  1258. <th>Name</th>
  1259. <th>Description</th>
  1260. </tr>
  1261. </thead>
  1262. <tbody>
  1263. <tr>
  1264. <td><span class="xref">NStack.ustring</span></td>
  1265. <td><span class="parametername">textToFind</span></td>
  1266. <td>The text to find.</td>
  1267. </tr>
  1268. <tr>
  1269. <td><span class="xref">System.Boolean</span></td>
  1270. <td><span class="parametername">gaveFullTurn</span></td>
  1271. <td><code>true</code>If all the text was backward searched.<code>false</code>otherwise.</td>
  1272. </tr>
  1273. <tr>
  1274. <td><span class="xref">System.Boolean</span></td>
  1275. <td><span class="parametername">matchCase</span></td>
  1276. <td>The match case setting.</td>
  1277. </tr>
  1278. <tr>
  1279. <td><span class="xref">System.Boolean</span></td>
  1280. <td><span class="parametername">matchWholeWord</span></td>
  1281. <td>The match whole word setting.</td>
  1282. </tr>
  1283. <tr>
  1284. <td><span class="xref">NStack.ustring</span></td>
  1285. <td><span class="parametername">textToReplace</span></td>
  1286. <td>The text to replace.</td>
  1287. </tr>
  1288. <tr>
  1289. <td><span class="xref">System.Boolean</span></td>
  1290. <td><span class="parametername">replace</span></td>
  1291. <td><code>true</code>If the text was found.<code>false</code>otherwise.</td>
  1292. </tr>
  1293. </tbody>
  1294. </table>
  1295. <h5 class="returns">Returns</h5>
  1296. <table class="table table-bordered table-striped table-condensed">
  1297. <thead>
  1298. <tr>
  1299. <th>Type</th>
  1300. <th>Description</th>
  1301. </tr>
  1302. </thead>
  1303. <tbody>
  1304. <tr>
  1305. <td><span class="xref">System.Boolean</span></td>
  1306. <td><code>true</code>If the text was found.<code>false</code>otherwise.</td>
  1307. </tr>
  1308. </tbody>
  1309. </table>
  1310. <a id="Terminal_Gui_TextView_FindTextChanged_" data-uid="Terminal.Gui.TextView.FindTextChanged*"></a>
  1311. <h4 id="Terminal_Gui_TextView_FindTextChanged" data-uid="Terminal.Gui.TextView.FindTextChanged">FindTextChanged()</h4>
  1312. <div class="markdown level1 summary">
  1313. Reset the flag to stop continuous find.
  1314. </div>
  1315. <div class="markdown level1 conceptual"></div>
  1316. <h5 class="decalaration">Declaration</h5>
  1317. <div class="codewrapper">
  1318. <pre><code class="lang-csharp hljs">public void FindTextChanged()</code></pre>
  1319. </div>
  1320. <a id="Terminal_Gui_TextView_LoadFile_" data-uid="Terminal.Gui.TextView.LoadFile*"></a>
  1321. <h4 id="Terminal_Gui_TextView_LoadFile_System_String_" data-uid="Terminal.Gui.TextView.LoadFile(System.String)">LoadFile(String)</h4>
  1322. <div class="markdown level1 summary">
  1323. Loads the contents of the file into the <a class="xref" href="Terminal.Gui.TextView.html">TextView</a>.
  1324. </div>
  1325. <div class="markdown level1 conceptual"></div>
  1326. <h5 class="decalaration">Declaration</h5>
  1327. <div class="codewrapper">
  1328. <pre><code class="lang-csharp hljs">public bool LoadFile(string path)</code></pre>
  1329. </div>
  1330. <h5 class="parameters">Parameters</h5>
  1331. <table class="table table-bordered table-striped table-condensed">
  1332. <thead>
  1333. <tr>
  1334. <th>Type</th>
  1335. <th>Name</th>
  1336. <th>Description</th>
  1337. </tr>
  1338. </thead>
  1339. <tbody>
  1340. <tr>
  1341. <td><span class="xref">System.String</span></td>
  1342. <td><span class="parametername">path</span></td>
  1343. <td>Path to the file to load.</td>
  1344. </tr>
  1345. </tbody>
  1346. </table>
  1347. <h5 class="returns">Returns</h5>
  1348. <table class="table table-bordered table-striped table-condensed">
  1349. <thead>
  1350. <tr>
  1351. <th>Type</th>
  1352. <th>Description</th>
  1353. </tr>
  1354. </thead>
  1355. <tbody>
  1356. <tr>
  1357. <td><span class="xref">System.Boolean</span></td>
  1358. <td><code>true</code>, if file was loaded, <code>false</code> otherwise.</td>
  1359. </tr>
  1360. </tbody>
  1361. </table>
  1362. <a id="Terminal_Gui_TextView_LoadStream_" data-uid="Terminal.Gui.TextView.LoadStream*"></a>
  1363. <h4 id="Terminal_Gui_TextView_LoadStream_System_IO_Stream_" data-uid="Terminal.Gui.TextView.LoadStream(System.IO.Stream)">LoadStream(Stream)</h4>
  1364. <div class="markdown level1 summary">
  1365. Loads the contents of the stream into the <a class="xref" href="Terminal.Gui.TextView.html">TextView</a>.
  1366. </div>
  1367. <div class="markdown level1 conceptual"></div>
  1368. <h5 class="decalaration">Declaration</h5>
  1369. <div class="codewrapper">
  1370. <pre><code class="lang-csharp hljs">public void LoadStream(Stream stream)</code></pre>
  1371. </div>
  1372. <h5 class="parameters">Parameters</h5>
  1373. <table class="table table-bordered table-striped table-condensed">
  1374. <thead>
  1375. <tr>
  1376. <th>Type</th>
  1377. <th>Name</th>
  1378. <th>Description</th>
  1379. </tr>
  1380. </thead>
  1381. <tbody>
  1382. <tr>
  1383. <td><span class="xref">System.IO.Stream</span></td>
  1384. <td><span class="parametername">stream</span></td>
  1385. <td>Stream to load the contents from.</td>
  1386. </tr>
  1387. </tbody>
  1388. </table>
  1389. <a id="Terminal_Gui_TextView_MouseEvent_" data-uid="Terminal.Gui.TextView.MouseEvent*"></a>
  1390. <h4 id="Terminal_Gui_TextView_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.TextView.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  1391. <div class="markdown level1 summary"></div>
  1392. <div class="markdown level1 conceptual"></div>
  1393. <h5 class="decalaration">Declaration</h5>
  1394. <div class="codewrapper">
  1395. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent ev)</code></pre>
  1396. </div>
  1397. <h5 class="parameters">Parameters</h5>
  1398. <table class="table table-bordered table-striped table-condensed">
  1399. <thead>
  1400. <tr>
  1401. <th>Type</th>
  1402. <th>Name</th>
  1403. <th>Description</th>
  1404. </tr>
  1405. </thead>
  1406. <tbody>
  1407. <tr>
  1408. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  1409. <td><span class="parametername">ev</span></td>
  1410. <td></td>
  1411. </tr>
  1412. </tbody>
  1413. </table>
  1414. <h5 class="returns">Returns</h5>
  1415. <table class="table table-bordered table-striped table-condensed">
  1416. <thead>
  1417. <tr>
  1418. <th>Type</th>
  1419. <th>Description</th>
  1420. </tr>
  1421. </thead>
  1422. <tbody>
  1423. <tr>
  1424. <td><span class="xref">System.Boolean</span></td>
  1425. <td></td>
  1426. </tr>
  1427. </tbody>
  1428. </table>
  1429. <h5 class="overrides">Overrides</h5>
  1430. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  1431. <a id="Terminal_Gui_TextView_MoveEnd_" data-uid="Terminal.Gui.TextView.MoveEnd*"></a>
  1432. <h4 id="Terminal_Gui_TextView_MoveEnd" data-uid="Terminal.Gui.TextView.MoveEnd">MoveEnd()</h4>
  1433. <div class="markdown level1 summary">
  1434. Will scroll the <a class="xref" href="Terminal.Gui.TextView.html">TextView</a> to the last line and position the cursor there.
  1435. </div>
  1436. <div class="markdown level1 conceptual"></div>
  1437. <h5 class="decalaration">Declaration</h5>
  1438. <div class="codewrapper">
  1439. <pre><code class="lang-csharp hljs">public void MoveEnd()</code></pre>
  1440. </div>
  1441. <a id="Terminal_Gui_TextView_MoveHome_" data-uid="Terminal.Gui.TextView.MoveHome*"></a>
  1442. <h4 id="Terminal_Gui_TextView_MoveHome" data-uid="Terminal.Gui.TextView.MoveHome">MoveHome()</h4>
  1443. <div class="markdown level1 summary">
  1444. Will scroll the <a class="xref" href="Terminal.Gui.TextView.html">TextView</a> to the first line and position the cursor there.
  1445. </div>
  1446. <div class="markdown level1 conceptual"></div>
  1447. <h5 class="decalaration">Declaration</h5>
  1448. <div class="codewrapper">
  1449. <pre><code class="lang-csharp hljs">public void MoveHome()</code></pre>
  1450. </div>
  1451. <a id="Terminal_Gui_TextView_OnEnter_" data-uid="Terminal.Gui.TextView.OnEnter*"></a>
  1452. <h4 id="Terminal_Gui_TextView_OnEnter_Terminal_Gui_View_" data-uid="Terminal.Gui.TextView.OnEnter(Terminal.Gui.View)">OnEnter(View)</h4>
  1453. <div class="markdown level1 summary"></div>
  1454. <div class="markdown level1 conceptual"></div>
  1455. <h5 class="decalaration">Declaration</h5>
  1456. <div class="codewrapper">
  1457. <pre><code class="lang-csharp hljs">public override bool OnEnter(View view)</code></pre>
  1458. </div>
  1459. <h5 class="parameters">Parameters</h5>
  1460. <table class="table table-bordered table-striped table-condensed">
  1461. <thead>
  1462. <tr>
  1463. <th>Type</th>
  1464. <th>Name</th>
  1465. <th>Description</th>
  1466. </tr>
  1467. </thead>
  1468. <tbody>
  1469. <tr>
  1470. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  1471. <td><span class="parametername">view</span></td>
  1472. <td></td>
  1473. </tr>
  1474. </tbody>
  1475. </table>
  1476. <h5 class="returns">Returns</h5>
  1477. <table class="table table-bordered table-striped table-condensed">
  1478. <thead>
  1479. <tr>
  1480. <th>Type</th>
  1481. <th>Description</th>
  1482. </tr>
  1483. </thead>
  1484. <tbody>
  1485. <tr>
  1486. <td><span class="xref">System.Boolean</span></td>
  1487. <td></td>
  1488. </tr>
  1489. </tbody>
  1490. </table>
  1491. <h5 class="overrides">Overrides</h5>
  1492. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter_Terminal_Gui_View_">View.OnEnter(View)</a></div>
  1493. <a id="Terminal_Gui_TextView_OnKeyUp_" data-uid="Terminal.Gui.TextView.OnKeyUp*"></a>
  1494. <h4 id="Terminal_Gui_TextView_OnKeyUp_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.TextView.OnKeyUp(Terminal.Gui.KeyEvent)">OnKeyUp(KeyEvent)</h4>
  1495. <div class="markdown level1 summary"></div>
  1496. <div class="markdown level1 conceptual"></div>
  1497. <h5 class="decalaration">Declaration</h5>
  1498. <div class="codewrapper">
  1499. <pre><code class="lang-csharp hljs">public override bool OnKeyUp(KeyEvent kb)</code></pre>
  1500. </div>
  1501. <h5 class="parameters">Parameters</h5>
  1502. <table class="table table-bordered table-striped table-condensed">
  1503. <thead>
  1504. <tr>
  1505. <th>Type</th>
  1506. <th>Name</th>
  1507. <th>Description</th>
  1508. </tr>
  1509. </thead>
  1510. <tbody>
  1511. <tr>
  1512. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  1513. <td><span class="parametername">kb</span></td>
  1514. <td></td>
  1515. </tr>
  1516. </tbody>
  1517. </table>
  1518. <h5 class="returns">Returns</h5>
  1519. <table class="table table-bordered table-striped table-condensed">
  1520. <thead>
  1521. <tr>
  1522. <th>Type</th>
  1523. <th>Description</th>
  1524. </tr>
  1525. </thead>
  1526. <tbody>
  1527. <tr>
  1528. <td><span class="xref">System.Boolean</span></td>
  1529. <td></td>
  1530. </tr>
  1531. </tbody>
  1532. </table>
  1533. <h5 class="overrides">Overrides</h5>
  1534. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a></div>
  1535. <a id="Terminal_Gui_TextView_OnLeave_" data-uid="Terminal.Gui.TextView.OnLeave*"></a>
  1536. <h4 id="Terminal_Gui_TextView_OnLeave_Terminal_Gui_View_" data-uid="Terminal.Gui.TextView.OnLeave(Terminal.Gui.View)">OnLeave(View)</h4>
  1537. <div class="markdown level1 summary"></div>
  1538. <div class="markdown level1 conceptual"></div>
  1539. <h5 class="decalaration">Declaration</h5>
  1540. <div class="codewrapper">
  1541. <pre><code class="lang-csharp hljs">public override bool OnLeave(View view)</code></pre>
  1542. </div>
  1543. <h5 class="parameters">Parameters</h5>
  1544. <table class="table table-bordered table-striped table-condensed">
  1545. <thead>
  1546. <tr>
  1547. <th>Type</th>
  1548. <th>Name</th>
  1549. <th>Description</th>
  1550. </tr>
  1551. </thead>
  1552. <tbody>
  1553. <tr>
  1554. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  1555. <td><span class="parametername">view</span></td>
  1556. <td></td>
  1557. </tr>
  1558. </tbody>
  1559. </table>
  1560. <h5 class="returns">Returns</h5>
  1561. <table class="table table-bordered table-striped table-condensed">
  1562. <thead>
  1563. <tr>
  1564. <th>Type</th>
  1565. <th>Description</th>
  1566. </tr>
  1567. </thead>
  1568. <tbody>
  1569. <tr>
  1570. <td><span class="xref">System.Boolean</span></td>
  1571. <td></td>
  1572. </tr>
  1573. </tbody>
  1574. </table>
  1575. <h5 class="overrides">Overrides</h5>
  1576. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave_Terminal_Gui_View_">View.OnLeave(View)</a></div>
  1577. <a id="Terminal_Gui_TextView_Paste_" data-uid="Terminal.Gui.TextView.Paste*"></a>
  1578. <h4 id="Terminal_Gui_TextView_Paste" data-uid="Terminal.Gui.TextView.Paste">Paste()</h4>
  1579. <div class="markdown level1 summary">
  1580. Paste the clipboard contents into the current selected position.
  1581. </div>
  1582. <div class="markdown level1 conceptual"></div>
  1583. <h5 class="decalaration">Declaration</h5>
  1584. <div class="codewrapper">
  1585. <pre><code class="lang-csharp hljs">public void Paste()</code></pre>
  1586. </div>
  1587. <a id="Terminal_Gui_TextView_PositionCursor_" data-uid="Terminal.Gui.TextView.PositionCursor*"></a>
  1588. <h4 id="Terminal_Gui_TextView_PositionCursor" data-uid="Terminal.Gui.TextView.PositionCursor">PositionCursor()</h4>
  1589. <div class="markdown level1 summary">
  1590. Positions the cursor on the current row and column
  1591. </div>
  1592. <div class="markdown level1 conceptual"></div>
  1593. <h5 class="decalaration">Declaration</h5>
  1594. <div class="codewrapper">
  1595. <pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
  1596. </div>
  1597. <h5 class="overrides">Overrides</h5>
  1598. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
  1599. <a id="Terminal_Gui_TextView_ProcessKey_" data-uid="Terminal.Gui.TextView.ProcessKey*"></a>
  1600. <h4 id="Terminal_Gui_TextView_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.TextView.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  1601. <div class="markdown level1 summary"></div>
  1602. <div class="markdown level1 conceptual"></div>
  1603. <h5 class="decalaration">Declaration</h5>
  1604. <div class="codewrapper">
  1605. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent kb)</code></pre>
  1606. </div>
  1607. <h5 class="parameters">Parameters</h5>
  1608. <table class="table table-bordered table-striped table-condensed">
  1609. <thead>
  1610. <tr>
  1611. <th>Type</th>
  1612. <th>Name</th>
  1613. <th>Description</th>
  1614. </tr>
  1615. </thead>
  1616. <tbody>
  1617. <tr>
  1618. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  1619. <td><span class="parametername">kb</span></td>
  1620. <td></td>
  1621. </tr>
  1622. </tbody>
  1623. </table>
  1624. <h5 class="returns">Returns</h5>
  1625. <table class="table table-bordered table-striped table-condensed">
  1626. <thead>
  1627. <tr>
  1628. <th>Type</th>
  1629. <th>Description</th>
  1630. </tr>
  1631. </thead>
  1632. <tbody>
  1633. <tr>
  1634. <td><span class="xref">System.Boolean</span></td>
  1635. <td></td>
  1636. </tr>
  1637. </tbody>
  1638. </table>
  1639. <h5 class="overrides">Overrides</h5>
  1640. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  1641. <a id="Terminal_Gui_TextView_Redraw_" data-uid="Terminal.Gui.TextView.Redraw*"></a>
  1642. <h4 id="Terminal_Gui_TextView_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.TextView.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  1643. <div class="markdown level1 summary"></div>
  1644. <div class="markdown level1 conceptual"></div>
  1645. <h5 class="decalaration">Declaration</h5>
  1646. <div class="codewrapper">
  1647. <pre><code class="lang-csharp hljs">public override void Redraw(Rect bounds)</code></pre>
  1648. </div>
  1649. <h5 class="parameters">Parameters</h5>
  1650. <table class="table table-bordered table-striped table-condensed">
  1651. <thead>
  1652. <tr>
  1653. <th>Type</th>
  1654. <th>Name</th>
  1655. <th>Description</th>
  1656. </tr>
  1657. </thead>
  1658. <tbody>
  1659. <tr>
  1660. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1661. <td><span class="parametername">bounds</span></td>
  1662. <td></td>
  1663. </tr>
  1664. </tbody>
  1665. </table>
  1666. <h5 class="overrides">Overrides</h5>
  1667. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  1668. <a id="Terminal_Gui_TextView_ReplaceAllText_" data-uid="Terminal.Gui.TextView.ReplaceAllText*"></a>
  1669. <h4 id="Terminal_Gui_TextView_ReplaceAllText_NStack_ustring_System_Boolean_System_Boolean_NStack_ustring_" data-uid="Terminal.Gui.TextView.ReplaceAllText(NStack.ustring,System.Boolean,System.Boolean,NStack.ustring)">ReplaceAllText(ustring, Boolean, Boolean, ustring)</h4>
  1670. <div class="markdown level1 summary">
  1671. Replaces all the text based on the match case.
  1672. </div>
  1673. <div class="markdown level1 conceptual"></div>
  1674. <h5 class="decalaration">Declaration</h5>
  1675. <div class="codewrapper">
  1676. <pre><code class="lang-csharp hljs">public bool ReplaceAllText(ustring textToFind, bool matchCase = false, bool matchWholeWord = false, ustring textToReplace = null)</code></pre>
  1677. </div>
  1678. <h5 class="parameters">Parameters</h5>
  1679. <table class="table table-bordered table-striped table-condensed">
  1680. <thead>
  1681. <tr>
  1682. <th>Type</th>
  1683. <th>Name</th>
  1684. <th>Description</th>
  1685. </tr>
  1686. </thead>
  1687. <tbody>
  1688. <tr>
  1689. <td><span class="xref">NStack.ustring</span></td>
  1690. <td><span class="parametername">textToFind</span></td>
  1691. <td>The text to find.</td>
  1692. </tr>
  1693. <tr>
  1694. <td><span class="xref">System.Boolean</span></td>
  1695. <td><span class="parametername">matchCase</span></td>
  1696. <td>The match case setting.</td>
  1697. </tr>
  1698. <tr>
  1699. <td><span class="xref">System.Boolean</span></td>
  1700. <td><span class="parametername">matchWholeWord</span></td>
  1701. <td>The match whole word setting.</td>
  1702. </tr>
  1703. <tr>
  1704. <td><span class="xref">NStack.ustring</span></td>
  1705. <td><span class="parametername">textToReplace</span></td>
  1706. <td>The text to replace.</td>
  1707. </tr>
  1708. </tbody>
  1709. </table>
  1710. <h5 class="returns">Returns</h5>
  1711. <table class="table table-bordered table-striped table-condensed">
  1712. <thead>
  1713. <tr>
  1714. <th>Type</th>
  1715. <th>Description</th>
  1716. </tr>
  1717. </thead>
  1718. <tbody>
  1719. <tr>
  1720. <td><span class="xref">System.Boolean</span></td>
  1721. <td><code>true</code>If the text was found.<code>false</code>otherwise.</td>
  1722. </tr>
  1723. </tbody>
  1724. </table>
  1725. <a id="Terminal_Gui_TextView_ScrollTo_" data-uid="Terminal.Gui.TextView.ScrollTo*"></a>
  1726. <h4 id="Terminal_Gui_TextView_ScrollTo_System_Int32_System_Boolean_" data-uid="Terminal.Gui.TextView.ScrollTo(System.Int32,System.Boolean)">ScrollTo(Int32, Boolean)</h4>
  1727. <div class="markdown level1 summary">
  1728. 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
  1729. 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.
  1730. </div>
  1731. <div class="markdown level1 conceptual"></div>
  1732. <h5 class="decalaration">Declaration</h5>
  1733. <div class="codewrapper">
  1734. <pre><code class="lang-csharp hljs">public void ScrollTo(int idx, bool isRow = true)</code></pre>
  1735. </div>
  1736. <h5 class="parameters">Parameters</h5>
  1737. <table class="table table-bordered table-striped table-condensed">
  1738. <thead>
  1739. <tr>
  1740. <th>Type</th>
  1741. <th>Name</th>
  1742. <th>Description</th>
  1743. </tr>
  1744. </thead>
  1745. <tbody>
  1746. <tr>
  1747. <td><span class="xref">System.Int32</span></td>
  1748. <td><span class="parametername">idx</span></td>
  1749. <td>Row that should be displayed at the top or Column that should be displayed at the left,
  1750. if the value is negative it will be reset to zero</td>
  1751. </tr>
  1752. <tr>
  1753. <td><span class="xref">System.Boolean</span></td>
  1754. <td><span class="parametername">isRow</span></td>
  1755. <td>If true (default) the <code data-dev-comment-type="paramref" class="paramref">idx</code> is a row, column otherwise.</td>
  1756. </tr>
  1757. </tbody>
  1758. </table>
  1759. <a id="Terminal_Gui_TextView_SelectAll_" data-uid="Terminal.Gui.TextView.SelectAll*"></a>
  1760. <h4 id="Terminal_Gui_TextView_SelectAll" data-uid="Terminal.Gui.TextView.SelectAll">SelectAll()</h4>
  1761. <div class="markdown level1 summary">
  1762. Select all text.
  1763. </div>
  1764. <div class="markdown level1 conceptual"></div>
  1765. <h5 class="decalaration">Declaration</h5>
  1766. <div class="codewrapper">
  1767. <pre><code class="lang-csharp hljs">public void SelectAll()</code></pre>
  1768. </div>
  1769. <h3 id="events">Events
  1770. </h3>
  1771. <h4 id="Terminal_Gui_TextView_TextChanged" data-uid="Terminal.Gui.TextView.TextChanged">TextChanged</h4>
  1772. <div class="markdown level1 summary">
  1773. 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.
  1774. </div>
  1775. <div class="markdown level1 conceptual"></div>
  1776. <h5 class="decalaration">Declaration</h5>
  1777. <div class="codewrapper">
  1778. <pre><code class="lang-csharp hljs">public event Action TextChanged</code></pre>
  1779. </div>
  1780. <h5 class="eventType">Event Type</h5>
  1781. <table class="table table-bordered table-striped table-condensed">
  1782. <thead>
  1783. <tr>
  1784. <th>Type</th>
  1785. <th>Description</th>
  1786. </tr>
  1787. </thead>
  1788. <tbody>
  1789. <tr>
  1790. <td><span class="xref">System.Action</span></td>
  1791. <td></td>
  1792. </tr>
  1793. </tbody>
  1794. </table>
  1795. <h3 id="implements">Implements</h3>
  1796. <div>
  1797. <span class="xref">System.IDisposable</span>
  1798. </div>
  1799. <div>
  1800. <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
  1801. </div>
  1802. <div>
  1803. <span class="xref">System.ComponentModel.ISupportInitialize</span>
  1804. </div>
  1805. </article>
  1806. </div>
  1807. <div class="hidden-sm col-md-2" role="complementary">
  1808. <div class="sideaffix">
  1809. <div class="contribution">
  1810. <ul class="nav">
  1811. </ul>
  1812. </div>
  1813. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  1814. <h5>In This Article</h5>
  1815. <div></div>
  1816. </nav>
  1817. </div>
  1818. </div>
  1819. </div>
  1820. </div>
  1821. <footer>
  1822. <div class="grad-bottom"></div>
  1823. <div class="footer">
  1824. <div class="container">
  1825. <span class="pull-right">
  1826. <a href="#top">Back to top</a>
  1827. </span>
  1828. <span>Generated by <strong>DocFX</strong></span>
  1829. </div>
  1830. </div>
  1831. </footer>
  1832. </div>
  1833. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  1834. <script type="text/javascript" src="../../styles/docfx.js"></script>
  1835. <script type="text/javascript" src="../../styles/main.js"></script>
  1836. </body>
  1837. </html>