Home Explore Help
Sign In
csharp
/
gui-cs.Terminal.Gui
mirror of https://github.com/gui-cs/Terminal.Gui.git
2
0
Fork 0
Files Issues 0 Wiki
Tree: 56dea7423e
Branches Tags
gui-cs.Terminal...
/
docs
/
api
/
Terminal.Gui
/
Terminal.Gui.TextView.html

Terminal.Gui.TextView.html 27 KB
History Raw

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715 
  1. <!DOCTYPE html>
    2. 

  2. <!--[if IE]><![endif]-->
    3. 

  3. <html>
    4. 

  4.   
    5. 

  5.   <head>
    6. 

  6.     <meta charset="utf-8">
    7. 

  7.     <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    8. 

  8.     <title>Class TextView
    9. 

  9.    </title>
    10. 

  10.     <meta name="viewport" content="width=device-width">
    11. 

  11.     <meta name="title" content="Class TextView
    12. 

  12.    ">
    13. 

  13.     <meta name="generator" content="docfx 2.18.2.0">
    14. 

  14.     
    15. 

  15.     <link rel="shortcut icon" href="../../favicon.ico">
    16. 

  16.     <link rel="stylesheet" href="../../styles/docfx.vendor.css">
    17. 

  17.     <link rel="stylesheet" href="../../styles/docfx.css">
    18. 

  18.     <link rel="stylesheet" href="../../styles/main.css">
    19. 

  19.     <meta property="docfx:navrel" content="">
    20. 

  20.     <meta property="docfx:tocrel" content="../toc.html">
    21. 

  21.     
    22. 

  22.     
    23. 

  23.   </head>
    24. 

  24.   <body data-spy="scroll" data-target="#affix">
    25. 

  25.     <div id="wrapper">
    26. 

  26.       <header>
    27. 

  27.         
    28. 

  28.         <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
    29. 

  29.           <div class="container">
    30. 

  30.             <div class="navbar-header">
    31. 

  31.               <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
    32. 

  32.                 <span class="sr-only">Toggle navigation</span>
    33. 

  33.                 <span class="icon-bar"></span>
    34. 

  34.                 <span class="icon-bar"></span>
    35. 

  35.                 <span class="icon-bar"></span>
    36. 

  36.               </button>
    37. 

  37.               
    38. 

  38.               <a class="navbar-brand" href="../../index.html">
    39. 

  39.                 <img id="logo" class="svg" src="../../logo.svg" alt="">
    40. 

  40.               </a>
    41. 

  41.             </div>
    42. 

  42.             <div class="collapse navbar-collapse" id="navbar">
    43. 

  43.               <form class="navbar-form navbar-right" role="search" id="search">
    44. 

  44.                 <div class="form-group">
    45. 

  45.                   <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
    46. 

  46.                 </div>
    47. 

  47.               </form>
    48. 

  48.             </div>
    49. 

  49.           </div>
    50. 

  50.         </nav>
    51. 

  51.         
    52. 

  52.         <div class="subnav navbar navbar-default">
    53. 

  53.           <div class="container hide-when-search" id="breadcrumb">
    54. 

  54.             <ul class="breadcrumb">
    55. 

  55.               <li></li>
    56. 

  56.             </ul>
    57. 

  57.           </div>
    58. 

  58.         </div>
    59. 

  59.       </header>
    60. 

  60.       <div role="main" class="container body-content hide-when-search">
    61. 

  61.         
    62. 

  62.         <div class="sidenav hide-when-search">
    63. 

  63.           <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
    64. 

  64.           <div class="sidetoggle collapse" id="sidetoggle">
    65. 

  65.             <div id="sidetoc"></div>
    66. 

  66.           </div>
    67. 

  67.         </div>
    68. 

  68.         <div class="article row grid-right">
    69. 

  69.           <div class="col-md-10">
    70. 

  70.             <article class="content wrap" id="_content" data-uid="Terminal.Gui.TextView">
    71. 

  71.   
    72. 

  72.   
    73. 

  73.   <h1 id="Terminal_Gui_TextView" data-uid="Terminal.Gui.TextView">Class TextView
    74. 

  74.   </h1>
    75. 

  75.   <div class="markdown level0 summary"><p>Multi-line text editing view</p>
    76. 

  76. </div>
    77. 

  77.   <div class="markdown level0 conceptual"></div>
    78. 

  78.   <div class="inheritance">
    79. 

  79.     <h5>Inheritance</h5>
    80. 

  80.     <div class="level0"><span class="xref">System.Object</span></div>
    81. 

  81.     <div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
    82. 

  82.     <div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
    83. 

  83.     <div class="level3"><span class="xref">TextView</span></div>
    84. 

  84.   </div>
    85. 

  85.   <div class="inheritedMembers">
    86. 

  86.     <h5>Inherited Members</h5>
    87. 

  87.     <div>
    88. 

  88.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
    89. 

  89.     </div>
    90. 

  90.     <div>
    91. 

  91.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
    92. 

  92.     </div>
    93. 

  93.     <div>
    94. 

  94.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
    95. 

  95.     </div>
    96. 

  96.     <div>
    97. 

  97.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
    98. 

  98.     </div>
    99. 

  99.     <div>
    100. 

  100.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
    101. 

  101.     </div>
    102. 

  102.     <div>
    103. 

  103.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
    104. 

  104.     </div>
    105. 

  105.     <div>
    106. 

  106.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
    107. 

  107.     </div>
    108. 

  108.     <div>
    109. 

  109.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
    110. 

  110.     </div>
    111. 

  111.     <div>
    112. 

  112.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
    113. 

  113.     </div>
    114. 

  114.     <div>
    115. 

  115.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
    116. 

  116.     </div>
    117. 

  117.     <div>
    118. 

  118.       <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>
    119. 

  119.     </div>
    120. 

  120.     <div>
    121. 

  121.       <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>
    122. 

  122.     </div>
    123. 

  123.     <div>
    124. 

  124.       <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>
    125. 

  125.     </div>
    126. 

  126.     <div>
    127. 

  127.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
    128. 

  128.     </div>
    129. 

  129.     <div>
    130. 

  130.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
    131. 

  131.     </div>
    132. 

  132.     <div>
    133. 

  133.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
    134. 

  134.     </div>
    135. 

  135.     <div>
    136. 

  136.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
    137. 

  137.     </div>
    138. 

  138.     <div>
    139. 

  139.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
    140. 

  140.     </div>
    141. 

  141.     <div>
    142. 

  142.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
    143. 

  143.     </div>
    144. 

  144.     <div>
    145. 

  145.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
    146. 

  146.     </div>
    147. 

  147.     <div>
    148. 

  148.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
    149. 

  149.     </div>
    150. 

  150.     <div>
    151. 

  151.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetEnumerator">View.GetEnumerator()</a>
    152. 

  152.     </div>
    153. 

  153.     <div>
    154. 

  154.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
    155. 

  155.     </div>
    156. 

  156.     <div>
    157. 

  157.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
    158. 

  158.     </div>
    159. 

  159.     <div>
    160. 

  160.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
    161. 

  161.     </div>
    162. 

  162.     <div>
    163. 

  163.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
    164. 

  164.     </div>
    165. 

  165.     <div>
    166. 

  166.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
    167. 

  167.     </div>
    168. 

  168.     <div>
    169. 

  169.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
    170. 

  170.     </div>
    171. 

  171.     <div>
    172. 

  172.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
    173. 

  173.     </div>
    174. 

  174.     <div>
    175. 

  175.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
    176. 

  176.     </div>
    177. 

  177.     <div>
    178. 

  178.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
    179. 

  179.     </div>
    180. 

  180.     <div>
    181. 

  181.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
    182. 

  182.     </div>
    183. 

  183.     <div>
    184. 

  184.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
    185. 

  185.     </div>
    186. 

  186.     <div>
    187. 

  187.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
    188. 

  188.     </div>
    189. 

  189.     <div>
    190. 

  190.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
    191. 

  191.     </div>
    192. 

  192.     <div>
    193. 

  193.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus_Terminal_Gui_View_">View.SetFocus(View)</a>
    194. 

  194.     </div>
    195. 

  195.     <div>
    196. 

  196.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
    197. 

  197.     </div>
    198. 

  198.     <div>
    199. 

  199.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
    200. 

  200.     </div>
    201. 

  201.     <div>
    202. 

  202.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
    203. 

  203.     </div>
    204. 

  204.     <div>
    205. 

  205.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
    206. 

  206.     </div>
    207. 

  207.     <div>
    208. 

  208.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
    209. 

  209.     </div>
    210. 

  210.     <div>
    211. 

  211.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
    212. 

  212.     </div>
    213. 

  213.     <div>
    214. 

  214.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
    215. 

  215.     </div>
    216. 

  216.     <div>
    217. 

  217.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
    218. 

  218.     </div>
    219. 

  219.     <div>
    220. 

  220.       <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
    221. 

  221.     </div>
    222. 

  222.   </div>
    223. 

  223.   <h6><strong>Namespace</strong>: <a class="xref" href="../Terminal.Gui.html">Terminal.Gui</a></h6>
    224. 

  224.   <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
    225. 

  225.   <h5 id="Terminal_Gui_TextView_syntax">Syntax</h5>
    226. 

  226.   <div class="codewrapper">
    227. 

  227.     <pre><code class="lang-csharp hljs">public class TextView : Terminal.Gui.View</code></pre>
    228. 

  228.   </div>
    229. 

  229.   <h5 id="Terminal_Gui_TextView_remarks"><strong>Remarks</strong></h5>
    230. 

  230.   <div class="markdown level0 remarks"><p><p>
    231. 

  231.                 The text view provides a multi-line text view.   Users interact
    232. 

  232.                 with it with the standard Emacs commands for movement or the arrow
    233. 

  233.                 keys. 
    234. 

  234.               </p>
    235. 

  235.     <table><thead><tr><th>Shortcut</th><th>Action performed</th></tr></thead><tbody><tr><td>Left cursor, Control-b</td><td>
    236. 

  236.                      Moves the editing point left.
    237. 

  237.                    </td></tr><tr><td>Right cursor, Control-f</td><td>
    238. 

  238.                      Moves the editing point right.
    239. 

  239.                    </td></tr><tr><td>Alt-b</td><td>
    240. 

  240.                      Moves one word back.
    241. 

  241.                    </td></tr><tr><td>Alt-f</td><td>
    242. 

  242.                      Moves one word forward.
    243. 

  243.                    </td></tr><tr><td>Up cursor, Control-p</td><td>
    244. 

  244.                      Moves the editing point one line up.
    245. 

  245.                    </td></tr><tr><td>Down cursor, Control-n</td><td>
    246. 

  246.                      Moves the editing point one line down
    247. 

  247.                    </td></tr><tr><td>Home key, Control-a</td><td>
    248. 

  248.                      Moves the cursor to the beginning of the line.
    249. 

  249.                    </td></tr><tr><td>End key, Control-e</td><td>
    250. 

  250.                      Moves the cursor to the end of the line.
    251. 

  251.                    </td></tr><tr><td>Delete, Control-d</td><td>
    252. 

  252.                      Deletes the character in front of the cursor.
    253. 

  253.                    </td></tr><tr><td>Backspace</td><td>
    254. 

  254.                      Deletes the character behind the cursor.
    255. 

  255.                    </td></tr><tr><td>Control-k</td><td>
    256. 

  256.                      Deletes the text until the end of the line and replaces the kill buffer
    257. 

  257.                      with the deleted text.   You can paste this text in a different place by
    258. 

  258.                      using Control-y.
    259. 

  259.                    </td></tr><tr><td>Control-y</td><td>
    260. 

  260.                       Pastes the content of the kill ring into the current position.
    261. 

  261.                    </td></tr><tr><td>Alt-d</td><td>
    262. 

  262.                       Deletes the word above the cursor and adds it to the kill ring.  You 
    263. 

  263.                       can paste the contents of the kill ring with Control-y.
    264. 

  264.                    </td></tr><tr><td>Control-q</td><td>
    265. 

  265.                      Quotes the next input character, to prevent the normal processing of
    266. 

  266.                      key handling to take place.
    267. 

  267.                    </td></tr></tbody></table></p>
    268. 

  268. </div>
    269. 

  269.   <h3 id="constructors">Constructors
    270. 

  270.   </h3>
    271. 

  271.   
    272. 

  272.   
    273. 

  273.   <a id="Terminal_Gui_TextView__ctor_" data-uid="Terminal.Gui.TextView.#ctor*"></a>
    274. 

  274.   <h4 id="Terminal_Gui_TextView__ctor" data-uid="Terminal.Gui.TextView.#ctor">TextView()</h4>
    275. 

  275.   <div class="markdown level1 summary"><p>Public constructor, creates a view on the specified area, with dimensions controlled with the X, Y, Width and Height properties.</p>
    276. 

  276. </div>
    277. 

  277.   <div class="markdown level1 conceptual"></div>
    278. 

  278.   <h5 class="decalaration">Declaration</h5>
    279. 

  279.   <div class="codewrapper">
    280. 

  280.     <pre><code class="lang-csharp hljs">public TextView ();</code></pre>
    281. 

  281.   </div>
    282. 

  282.   
    283. 

  283.   
    284. 

  284.   <a id="Terminal_Gui_TextView__ctor_" data-uid="Terminal.Gui.TextView.#ctor*"></a>
    285. 

  285.   <h4 id="Terminal_Gui_TextView__ctor_Terminal_Gui_Rect_" data-uid="Terminal.Gui.TextView.#ctor(Terminal.Gui.Rect)">TextView(Rect)</h4>
    286. 

  286.   <div class="markdown level1 summary"><p>Public constructor, creates a view on the specified area, with absolute position and size.</p>
    287. 

  287. </div>
    288. 

  288.   <div class="markdown level1 conceptual"></div>
    289. 

  289.   <h5 class="decalaration">Declaration</h5>
    290. 

  290.   <div class="codewrapper">
    291. 

  291.     <pre><code class="lang-csharp hljs">public TextView (Terminal.Gui.Rect frame);</code></pre>
    292. 

  292.   </div>
    293. 

  293.   <h5 class="parameters">Parameters</h5>
    294. 

  294.   <table class="table table-bordered table-striped table-condensed">
    295. 

  295.     <thead>
    296. 

  296.       <tr>
    297. 

  297.         <th>Type</th>
    298. 

  298.         <th>Name</th>
    299. 

  299.         <th>Description</th>
    300. 

  300.       </tr>
    301. 

  301.     </thead>
    302. 

  302.     <tbody>
    303. 

  303.       <tr>
    304. 

  304.         <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
    305. 

  305.         <td><span class="parametername">frame</span></td>
    306. 

  306.         <td><p>To be added.</p>
    307. 

  307. </td>
    308. 

  308.       </tr>
    309. 

  309.     </tbody>
    310. 

  310.   </table>
    311. 

  311.   <h3 id="properties">Properties
    312. 

  312.   </h3>
    313. 

  313.   
    314. 

  314.   
    315. 

  315.   <a id="Terminal_Gui_TextView_CanFocus_" data-uid="Terminal.Gui.TextView.CanFocus*"></a>
    316. 

  316.   <h4 id="Terminal_Gui_TextView_CanFocus" data-uid="Terminal.Gui.TextView.CanFocus">CanFocus</h4>
    317. 

  317.   <div class="markdown level1 summary"></div>
    318. 

  318.   <div class="markdown level1 conceptual"></div>
    319. 

  319.   <h5 class="decalaration">Declaration</h5>
    320. 

  320.   <div class="codewrapper">
    321. 

  321.     <pre><code class="lang-csharp hljs">public override bool CanFocus { get; set; }</code></pre>
    322. 

  322.   </div>
    323. 

  323.   <h5 class="propertyValue">Property Value</h5>
    324. 

  324.   <table class="table table-bordered table-striped table-condensed">
    325. 

  325.     <thead>
    326. 

  326.       <tr>
    327. 

  327.         <th>Type</th>
    328. 

  328.         <th>Description</th>
    329. 

  329.       </tr>
    330. 

  330.     </thead>
    331. 

  331.     <tbody>
    332. 

  332.       <tr>
    333. 

  333.         <td><span class="xref">System.Boolean</span></td>
    334. 

  334.         <td><p>To be added.</p>
    335. 

  335. </td>
    336. 

  336.       </tr>
    337. 

  337.     </tbody>
    338. 

  338.   </table>
    339. 

  339.   
    340. 

  340.   
    341. 

  341.   <a id="Terminal_Gui_TextView_CurrentColumn_" data-uid="Terminal.Gui.TextView.CurrentColumn*"></a>
    342. 

  342.   <h4 id="Terminal_Gui_TextView_CurrentColumn" data-uid="Terminal.Gui.TextView.CurrentColumn">CurrentColumn</h4>
    343. 

  343.   <div class="markdown level1 summary"><p>Gets the cursor column.</p>
    344. 

  344. </div>
    345. 

  345.   <div class="markdown level1 conceptual"></div>
    346. 

  346.   <h5 class="decalaration">Declaration</h5>
    347. 

  347.   <div class="codewrapper">
    348. 

  348.     <pre><code class="lang-csharp hljs">public int CurrentColumn { get; }</code></pre>
    349. 

  349.   </div>
    350. 

  350.   <h5 class="propertyValue">Property Value</h5>
    351. 

  351.   <table class="table table-bordered table-striped table-condensed">
    352. 

  352.     <thead>
    353. 

  353.       <tr>
    354. 

  354.         <th>Type</th>
    355. 

  355.         <th>Description</th>
    356. 

  356.       </tr>
    357. 

  357.     </thead>
    358. 

  358.     <tbody>
    359. 

  359.       <tr>
    360. 

  360.         <td><span class="xref">System.Int32</span></td>
    361. 

  361.         <td><p>The cursor column.</p>
    362. 

  362. </td>
    363. 

  363.       </tr>
    364. 

  364.     </tbody>
    365. 

  365.   </table>
    366. 

  366.   
    367. 

  367.   
    368. 

  368.   <a id="Terminal_Gui_TextView_CurrentRow_" data-uid="Terminal.Gui.TextView.CurrentRow*"></a>
    369. 

  369.   <h4 id="Terminal_Gui_TextView_CurrentRow" data-uid="Terminal.Gui.TextView.CurrentRow">CurrentRow</h4>
    370. 

  370.   <div class="markdown level1 summary"><p>The current cursor row.</p>
    371. 

  371. </div>
    372. 

  372.   <div class="markdown level1 conceptual"></div>
    373. 

  373.   <h5 class="decalaration">Declaration</h5>
    374. 

  374.   <div class="codewrapper">
    375. 

  375.     <pre><code class="lang-csharp hljs">public int CurrentRow { get; }</code></pre>
    376. 

  376.   </div>
    377. 

  377.   <h5 class="propertyValue">Property Value</h5>
    378. 

  378.   <table class="table table-bordered table-striped table-condensed">
    379. 

  379.     <thead>
    380. 

  380.       <tr>
    381. 

  381.         <th>Type</th>
    382. 

  382.         <th>Description</th>
    383. 

  383.       </tr>
    384. 

  384.     </thead>
    385. 

  385.     <tbody>
    386. 

  386.       <tr>
    387. 

  387.         <td><span class="xref">System.Int32</span></td>
    388. 

  388.         <td><p>To be added.</p>
    389. 

  389. </td>
    390. 

  390.       </tr>
    391. 

  391.     </tbody>
    392. 

  392.   </table>
    393. 

  393.   
    394. 

  394.   
    395. 

  395.   <a id="Terminal_Gui_TextView_ReadOnly_" data-uid="Terminal.Gui.TextView.ReadOnly*"></a>
    396. 

  396.   <h4 id="Terminal_Gui_TextView_ReadOnly" data-uid="Terminal.Gui.TextView.ReadOnly">ReadOnly</h4>
    397. 

  397.   <div class="markdown level1 summary"><p>Indicates readonly attribute of TextView</p>
    398. 

  398. </div>
    399. 

  399.   <div class="markdown level1 conceptual"></div>
    400. 

  400.   <h5 class="decalaration">Declaration</h5>
    401. 

  401.   <div class="codewrapper">
    402. 

  402.     <pre><code class="lang-csharp hljs">public bool ReadOnly { get; set; }</code></pre>
    403. 

  403.   </div>
    404. 

  404.   <h5 class="propertyValue">Property Value</h5>
    405. 

  405.   <table class="table table-bordered table-striped table-condensed">
    406. 

  406.     <thead>
    407. 

  407.       <tr>
    408. 

  408.         <th>Type</th>
    409. 

  409.         <th>Description</th>
    410. 

  410.       </tr>
    411. 

  411.     </thead>
    412. 

  412.     <tbody>
    413. 

  413.       <tr>
    414. 

  414.         <td><span class="xref">System.Boolean</span></td>
    415. 

  415.         <td><p>Boolean value(Default false)</p>
    416. 

  416. </td>
    417. 

  417.       </tr>
    418. 

  418.     </tbody>
    419. 

  419.   </table>
    420. 

  420.   
    421. 

  421.   
    422. 

  422.   <a id="Terminal_Gui_TextView_Text_" data-uid="Terminal.Gui.TextView.Text*"></a>
    423. 

  423.   <h4 id="Terminal_Gui_TextView_Text" data-uid="Terminal.Gui.TextView.Text">Text</h4>
    424. 

  424.   <div class="markdown level1 summary"><p>Sets or gets the text in the entry.</p>
    425. 

  425. </div>
    426. 

  426.   <div class="markdown level1 conceptual"></div>
    427. 

  427.   <h5 class="decalaration">Declaration</h5>
    428. 

  428.   <div class="codewrapper">
    429. 

  429.     <pre><code class="lang-csharp hljs">public NStack.ustring Text { get; set; }</code></pre>
    430. 

  430.   </div>
    431. 

  431.   <h5 class="propertyValue">Property Value</h5>
    432. 

  432.   <table class="table table-bordered table-striped table-condensed">
    433. 

  433.     <thead>
    434. 

  434.       <tr>
    435. 

  435.         <th>Type</th>
    436. 

  436.         <th>Description</th>
    437. 

  437.       </tr>
    438. 

  438.     </thead>
    439. 

  439.     <tbody>
    440. 

  440.       <tr>
    441. 

  441.         <td><span class="xref">NStack.ustring</span></td>
    442. 

  442.         <td><p>To be added.</p>
    443. 

  443. </td>
    444. 

  444.       </tr>
    445. 

  445.     </tbody>
    446. 

  446.   </table>
    447. 

  447.   <h3 id="methods">Methods
    448. 

  448.   </h3>
    449. 

  449.   
    450. 

  450.   
    451. 

  451.   <a id="Terminal_Gui_TextView_LoadFile_" data-uid="Terminal.Gui.TextView.LoadFile*"></a>
    452. 

  452.   <h4 id="Terminal_Gui_TextView_LoadFile_System_String_" data-uid="Terminal.Gui.TextView.LoadFile(System.String)">LoadFile(String)</h4>
    453. 

  453.   <div class="markdown level1 summary"><p>Loads the contents of the file into the TextView.</p>
    454. 

  454. </div>
    455. 

  455.   <div class="markdown level1 conceptual"></div>
    456. 

  456.   <h5 class="decalaration">Declaration</h5>
    457. 

  457.   <div class="codewrapper">
    458. 

  458.     <pre><code class="lang-csharp hljs">public bool LoadFile (string path);</code></pre>
    459. 

  459.   </div>
    460. 

  460.   <h5 class="parameters">Parameters</h5>
    461. 

  461.   <table class="table table-bordered table-striped table-condensed">
    462. 

  462.     <thead>
    463. 

  463.       <tr>
    464. 

  464.         <th>Type</th>
    465. 

  465.         <th>Name</th>
    466. 

  466.         <th>Description</th>
    467. 

  467.       </tr>
    468. 

  468.     </thead>
    469. 

  469.     <tbody>
    470. 

  470.       <tr>
    471. 

  471.         <td><span class="xref">System.String</span></td>
    472. 

  472.         <td><span class="parametername">path</span></td>
    473. 

  473.         <td><p>Path to the file to load.</p>
    474. 

  474. </td>
    475. 

  475.       </tr>
    476. 

  476.     </tbody>
    477. 

  477.   </table>
    478. 

  478.   <h5 class="returns">Returns</h5>
    479. 

  479.   <table class="table table-bordered table-striped table-condensed">
    480. 

  480.     <thead>
    481. 

  481.       <tr>
    482. 

  482.         <th>Type</th>
    483. 

  483.         <th>Description</th>
    484. 

  484.       </tr>
    485. 

  485.     </thead>
    486. 

  486.     <tbody>
    487. 

  487.       <tr>
    488. 

  488.         <td><span class="xref">System.Boolean</span></td>
    489. 

  489.         <td><p><code>true</code>, if file was loaded, <code>false</code> otherwise.</p>
    490. 

  490. </td>
    491. 

  491.       </tr>
    492. 

  492.     </tbody>
    493. 

  493.   </table>
    494. 

  494.   
    495. 

  495.   
    496. 

  496.   <a id="Terminal_Gui_TextView_LoadStream_" data-uid="Terminal.Gui.TextView.LoadStream*"></a>
    497. 

  497.   <h4 id="Terminal_Gui_TextView_LoadStream_System_IO_Stream_" data-uid="Terminal.Gui.TextView.LoadStream(System.IO.Stream)">LoadStream(Stream)</h4>
    498. 

  498.   <div class="markdown level1 summary"><p>Loads the contents of the stream into the TextView.</p>
    499. 

  499. </div>
    500. 

  500.   <div class="markdown level1 conceptual"></div>
    501. 

  501.   <h5 class="decalaration">Declaration</h5>
    502. 

  502.   <div class="codewrapper">
    503. 

  503.     <pre><code class="lang-csharp hljs">public void LoadStream (System.IO.Stream stream);</code></pre>
    504. 

  504.   </div>
    505. 

  505.   <h5 class="parameters">Parameters</h5>
    506. 

  506.   <table class="table table-bordered table-striped table-condensed">
    507. 

  507.     <thead>
    508. 

  508.       <tr>
    509. 

  509.         <th>Type</th>
    510. 

  510.         <th>Name</th>
    511. 

  511.         <th>Description</th>
    512. 

  512.       </tr>
    513. 

  513.     </thead>
    514. 

  514.     <tbody>
    515. 

  515.       <tr>
    516. 

  516.         <td><span class="xref">System.IO.Stream</span></td>
    517. 

  517.         <td><span class="parametername">stream</span></td>
    518. 

  518.         <td><p>Stream to load the contents from.</p>
    519. 

  519. </td>
    520. 

  520.       </tr>
    521. 

  521.     </tbody>
    522. 

  522.   </table>
    523. 

  523.   
    524. 

  524.   
    525. 

  525.   <a id="Terminal_Gui_TextView_MouseEvent_" data-uid="Terminal.Gui.TextView.MouseEvent*"></a>
    526. 

  526.   <h4 id="Terminal_Gui_TextView_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.TextView.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
    527. 

  527.   <div class="markdown level1 summary"></div>
    528. 

  528.   <div class="markdown level1 conceptual"></div>
    529. 

  529.   <h5 class="decalaration">Declaration</h5>
    530. 

  530.   <div class="codewrapper">
    531. 

  531.     <pre><code class="lang-csharp hljs">public override bool MouseEvent (Terminal.Gui.MouseEvent ev);</code></pre>
    532. 

  532.   </div>
    533. 

  533.   <h5 class="parameters">Parameters</h5>
    534. 

  534.   <table class="table table-bordered table-striped table-condensed">
    535. 

  535.     <thead>
    536. 

  536.       <tr>
    537. 

  537.         <th>Type</th>
    538. 

  538.         <th>Name</th>
    539. 

  539.         <th>Description</th>
    540. 

  540.       </tr>
    541. 

  541.     </thead>
    542. 

  542.     <tbody>
    543. 

  543.       <tr>
    544. 

  544.         <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
    545. 

  545.         <td><span class="parametername">ev</span></td>
    546. 

  546.         <td><p>To be added.</p>
    547. 

  547. </td>
    548. 

  548.       </tr>
    549. 

  549.     </tbody>
    550. 

  550.   </table>
    551. 

  551.   <h5 class="returns">Returns</h5>
    552. 

  552.   <table class="table table-bordered table-striped table-condensed">
    553. 

  553.     <thead>
    554. 

  554.       <tr>
    555. 

  555.         <th>Type</th>
    556. 

  556.         <th>Description</th>
    557. 

  557.       </tr>
    558. 

  558.     </thead>
    559. 

  559.     <tbody>
    560. 

  560.       <tr>
    561. 

  561.         <td><span class="xref">System.Boolean</span></td>
    562. 

  562.         <td><p>To be added.</p>
    563. 

  563. </td>
    564. 

  564.       </tr>
    565. 

  565.     </tbody>
    566. 

  566.   </table>
    567. 

  567.   
    568. 

  568.   
    569. 

  569.   <a id="Terminal_Gui_TextView_PositionCursor_" data-uid="Terminal.Gui.TextView.PositionCursor*"></a>
    570. 

  570.   <h4 id="Terminal_Gui_TextView_PositionCursor" data-uid="Terminal.Gui.TextView.PositionCursor">PositionCursor()</h4>
    571. 

  571.   <div class="markdown level1 summary"><p>Positions the cursor on the current row and column</p>
    572. 

  572. </div>
    573. 

  573.   <div class="markdown level1 conceptual"></div>
    574. 

  574.   <h5 class="decalaration">Declaration</h5>
    575. 

  575.   <div class="codewrapper">
    576. 

  576.     <pre><code class="lang-csharp hljs">public override void PositionCursor ();</code></pre>
    577. 

  577.   </div>
    578. 

  578.   
    579. 

  579.   
    580. 

  580.   <a id="Terminal_Gui_TextView_ProcessKey_" data-uid="Terminal.Gui.TextView.ProcessKey*"></a>
    581. 

  581.   <h4 id="Terminal_Gui_TextView_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.TextView.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
    582. 

  582.   <div class="markdown level1 summary"></div>
    583. 

  583.   <div class="markdown level1 conceptual"></div>
    584. 

  584.   <h5 class="decalaration">Declaration</h5>
    585. 

  585.   <div class="codewrapper">
    586. 

  586.     <pre><code class="lang-csharp hljs">public override bool ProcessKey (Terminal.Gui.KeyEvent kb);</code></pre>
    587. 

  587.   </div>
    588. 

  588.   <h5 class="parameters">Parameters</h5>
    589. 

  589.   <table class="table table-bordered table-striped table-condensed">
    590. 

  590.     <thead>
    591. 

  591.       <tr>
    592. 

  592.         <th>Type</th>
    593. 

  593.         <th>Name</th>
    594. 

  594.         <th>Description</th>
    595. 

  595.       </tr>
    596. 

  596.     </thead>
    597. 

  597.     <tbody>
    598. 

  598.       <tr>
    599. 

  599.         <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
    600. 

  600.         <td><span class="parametername">kb</span></td>
    601. 

  601.         <td><p>To be added.</p>
    602. 

  602. </td>
    603. 

  603.       </tr>
    604. 

  604.     </tbody>
    605. 

  605.   </table>
    606. 

  606.   <h5 class="returns">Returns</h5>
    607. 

  607.   <table class="table table-bordered table-striped table-condensed">
    608. 

  608.     <thead>
    609. 

  609.       <tr>
    610. 

  610.         <th>Type</th>
    611. 

  611.         <th>Description</th>
    612. 

  612.       </tr>
    613. 

  613.     </thead>
    614. 

  614.     <tbody>
    615. 

  615.       <tr>
    616. 

  616.         <td><span class="xref">System.Boolean</span></td>
    617. 

  617.         <td><p>To be added.</p>
    618. 

  618. </td>
    619. 

  619.       </tr>
    620. 

  620.     </tbody>
    621. 

  621.   </table>
    622. 

  622.   
    623. 

  623.   
    624. 

  624.   <a id="Terminal_Gui_TextView_Redraw_" data-uid="Terminal.Gui.TextView.Redraw*"></a>
    625. 

  625.   <h4 id="Terminal_Gui_TextView_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.TextView.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
    626. 

  626.   <div class="markdown level1 summary"><p>Redraw the text editor region</p>
    627. 

  627. </div>
    628. 

  628.   <div class="markdown level1 conceptual"></div>
    629. 

  629.   <h5 class="decalaration">Declaration</h5>
    630. 

  630.   <div class="codewrapper">
    631. 

  631.     <pre><code class="lang-csharp hljs">public override void Redraw (Terminal.Gui.Rect region);</code></pre>
    632. 

  632.   </div>
    633. 

  633.   <h5 class="parameters">Parameters</h5>
    634. 

  634.   <table class="table table-bordered table-striped table-condensed">
    635. 

  635.     <thead>
    636. 

  636.       <tr>
    637. 

  637.         <th>Type</th>
    638. 

  638.         <th>Name</th>
    639. 

  639.         <th>Description</th>
    640. 

  640.       </tr>
    641. 

  641.     </thead>
    642. 

  642.     <tbody>
    643. 

  643.       <tr>
    644. 

  644.         <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
    645. 

  645.         <td><span class="parametername">region</span></td>
    646. 

  646.         <td><p>The region to redraw.</p>
    647. 

  647. </td>
    648. 

  648.       </tr>
    649. 

  649.     </tbody>
    650. 

  650.   </table>
    651. 

  651.   
    652. 

  652.   
    653. 

  653.   <a id="Terminal_Gui_TextView_ScrollTo_" data-uid="Terminal.Gui.TextView.ScrollTo*"></a>
    654. 

  654.   <h4 id="Terminal_Gui_TextView_ScrollTo_System_Int32_" data-uid="Terminal.Gui.TextView.ScrollTo(System.Int32)">ScrollTo(Int32)</h4>
    655. 

  655.   <div class="markdown level1 summary"><p>Will scroll the view to display the specified row at the top</p>
    656. 

  656. </div>
    657. 

  657.   <div class="markdown level1 conceptual"></div>
    658. 

  658.   <h5 class="decalaration">Declaration</h5>
    659. 

  659.   <div class="codewrapper">
    660. 

  660.     <pre><code class="lang-csharp hljs">public void ScrollTo (int row);</code></pre>
    661. 

  661.   </div>
    662. 

  662.   <h5 class="parameters">Parameters</h5>
    663. 

  663.   <table class="table table-bordered table-striped table-condensed">
    664. 

  664.     <thead>
    665. 

  665.       <tr>
    666. 

  666.         <th>Type</th>
    667. 

  667.         <th>Name</th>
    668. 

  668.         <th>Description</th>
    669. 

  669.       </tr>
    670. 

  670.     </thead>
    671. 

  671.     <tbody>
    672. 

  672.       <tr>
    673. 

  673.         <td><span class="xref">System.Int32</span></td>
    674. 

  674.         <td><span class="parametername">row</span></td>
    675. 

  675.         <td><p>Row that should be displayed at the top, if the value is negative it will be reset to zero</p>
    676. 

  676. </td>
    677. 

  677.       </tr>
    678. 

  678.     </tbody>
    679. 

  679.   </table>
    680. 

  680. </article>
    681. 

  681.           </div>
    682. 

  682.           
    683. 

  683.           <div class="hidden-sm col-md-2" role="complementary">
    684. 

  684.             <div class="sideaffix">
    685. 

  685.               <div class="contribution">
    686. 

  686.                 <ul class="nav">
    687. 

  687.                 </ul>
    688. 

  688.               </div>
    689. 

  689.               <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
    690. 

  690.               <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
    691. 

  691.               </nav>
    692. 

  692.             </div>
    693. 

  693.           </div>
    694. 

  694.         </div>
    695. 

  695.       </div>
    696. 

  696.       
    697. 

  697.       <footer>
    698. 

  698.         <div class="grad-bottom"></div>
    699. 

  699.         <div class="footer">
    700. 

  700.           <div class="container">
    701. 

  701.             <span class="pull-right">
    702. 

  702.               <a href="#top">Back to top</a>
    703. 

  703.             </span>
    704. 

  704.             
    705. 

  705.             <span>Copyright © 2015-2017 Microsoft<br>Generated by <strong>DocFX</strong></span>
    706. 

  706.           </div>
    707. 

  707.         </div>
    708. 

  708.       </footer>
    709. 

  709.     </div>
    710. 

  710.     
    711. 

  711.     <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
    712. 

  712.     <script type="text/javascript" src="../../styles/docfx.js"></script>
    713. 

  713.     <script type="text/javascript" src="../../styles/main.js"></script>
    714. 

  714.   </body>
    715. 

  715. </html>
    716.