Terminal.Gui.ScrollView.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862
  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 ScrollView
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class ScrollView
  11. ">
  12. <meta name="generator" content="docfx 2.53.1.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <link href="https://fonts.googleapis.com/css?family=Roboto" rel="stylesheet">
  18. <meta property="docfx:navrel" content="">
  19. <meta property="docfx:tocrel" content="toc.html">
  20. <meta property="docfx:rel" content="../../">
  21. </head> <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list"></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Terminal.Gui.ScrollView">
  73. <h1 id="Terminal_Gui_ScrollView" data-uid="Terminal.Gui.ScrollView" class="text-break">Class ScrollView
  74. </h1>
  75. <div class="markdown level0 summary">
  76. Scrollviews are views that present a window into a virtual space where children views are added. Similar to the iOS UIScrollView.
  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">ScrollView</span></div>
  85. </div>
  86. <div classs="implements">
  87. <h5>Implements</h5>
  88. <div><span class="xref">System.Collections.IEnumerable</span></div>
  89. </div>
  90. <div class="inheritedMembers">
  91. <h5>Inherited Members</h5>
  92. <div>
  93. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  94. </div>
  95. <div>
  96. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  97. </div>
  98. <div>
  99. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  100. </div>
  101. <div>
  102. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  103. </div>
  104. <div>
  105. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  106. </div>
  107. <div>
  108. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  109. </div>
  110. <div>
  111. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  112. </div>
  113. <div>
  114. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  115. </div>
  116. <div>
  117. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  118. </div>
  119. <div>
  120. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  121. </div>
  122. <div>
  123. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetEnumerator">View.GetEnumerator()</a>
  124. </div>
  125. <div>
  126. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  127. </div>
  128. <div>
  129. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  130. </div>
  131. <div>
  132. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  133. </div>
  134. <div>
  135. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  136. </div>
  137. <div>
  138. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  139. </div>
  140. <div>
  141. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  142. </div>
  143. <div>
  144. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  145. </div>
  146. <div>
  147. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  148. </div>
  149. <div>
  150. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  151. </div>
  152. <div>
  153. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
  154. </div>
  155. <div>
  156. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  157. </div>
  158. <div>
  159. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  160. </div>
  161. <div>
  162. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  163. </div>
  164. <div>
  165. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  166. </div>
  167. <div>
  168. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  169. </div>
  170. <div>
  171. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  172. </div>
  173. <div>
  174. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  175. </div>
  176. <div>
  177. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  178. </div>
  179. <div>
  180. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  181. </div>
  182. <div>
  183. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  184. </div>
  185. <div>
  186. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  187. </div>
  188. <div>
  189. <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>
  190. </div>
  191. <div>
  192. <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>
  193. </div>
  194. <div>
  195. <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>
  196. </div>
  197. <div>
  198. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  199. </div>
  200. <div>
  201. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  202. </div>
  203. <div>
  204. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter">View.OnEnter()</a>
  205. </div>
  206. <div>
  207. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave">View.OnLeave()</a>
  208. </div>
  209. <div>
  210. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  211. </div>
  212. <div>
  213. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  214. </div>
  215. <div>
  216. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  217. </div>
  218. <div>
  219. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  220. </div>
  221. <div>
  222. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  223. </div>
  224. <div>
  225. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus_Terminal_Gui_View_">View.SetFocus(View)</a>
  226. </div>
  227. <div>
  228. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  229. </div>
  230. <div>
  231. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  232. </div>
  233. <div>
  234. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  235. </div>
  236. <div>
  237. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  238. </div>
  239. <div>
  240. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  241. </div>
  242. <div>
  243. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  244. </div>
  245. <div>
  246. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  247. </div>
  248. <div>
  249. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  250. </div>
  251. <div>
  252. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  253. </div>
  254. <div>
  255. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  256. </div>
  257. <div>
  258. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  259. </div>
  260. <div>
  261. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  262. </div>
  263. <div>
  264. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  265. </div>
  266. <div>
  267. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  268. </div>
  269. <div>
  270. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  271. </div>
  272. <div>
  273. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  274. </div>
  275. <div>
  276. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_CanFocus">Responder.CanFocus</a>
  277. </div>
  278. <div>
  279. <span class="xref">System.Object.Equals(System.Object)</span>
  280. </div>
  281. <div>
  282. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  283. </div>
  284. <div>
  285. <span class="xref">System.Object.GetHashCode()</span>
  286. </div>
  287. <div>
  288. <span class="xref">System.Object.GetType()</span>
  289. </div>
  290. <div>
  291. <span class="xref">System.Object.MemberwiseClone()</span>
  292. </div>
  293. <div>
  294. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  295. </div>
  296. </div>
  297. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  298. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  299. <h5 id="Terminal_Gui_ScrollView_syntax">Syntax</h5>
  300. <div class="codewrapper">
  301. <pre><code class="lang-csharp hljs">public class ScrollView : View, IEnumerable</code></pre>
  302. </div>
  303. <h5 id="Terminal_Gui_ScrollView_remarks"><strong>Remarks</strong></h5>
  304. <div class="markdown level0 remarks">
  305. <p>
  306. The subviews that are added to this scrollview are offset by the
  307. ContentOffset property. The view itself is a window into the
  308. space represented by the ContentSize.
  309. </p>
  310. <p>
  311. </p>
  312. </div>
  313. <h3 id="constructors">Constructors
  314. </h3>
  315. <a id="Terminal_Gui_ScrollView__ctor_" data-uid="Terminal.Gui.ScrollView.#ctor*"></a>
  316. <h4 id="Terminal_Gui_ScrollView__ctor_Terminal_Gui_Rect_" data-uid="Terminal.Gui.ScrollView.#ctor(Terminal.Gui.Rect)">ScrollView(Rect)</h4>
  317. <div class="markdown level1 summary">
  318. Constructs a ScrollView
  319. </div>
  320. <div class="markdown level1 conceptual"></div>
  321. <h5 class="decalaration">Declaration</h5>
  322. <div class="codewrapper">
  323. <pre><code class="lang-csharp hljs">public ScrollView(Rect frame)</code></pre>
  324. </div>
  325. <h5 class="parameters">Parameters</h5>
  326. <table class="table table-bordered table-striped table-condensed">
  327. <thead>
  328. <tr>
  329. <th>Type</th>
  330. <th>Name</th>
  331. <th>Description</th>
  332. </tr>
  333. </thead>
  334. <tbody>
  335. <tr>
  336. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  337. <td><span class="parametername">frame</span></td>
  338. <td></td>
  339. </tr>
  340. </tbody>
  341. </table>
  342. <h3 id="properties">Properties
  343. </h3>
  344. <a id="Terminal_Gui_ScrollView_ContentOffset_" data-uid="Terminal.Gui.ScrollView.ContentOffset*"></a>
  345. <h4 id="Terminal_Gui_ScrollView_ContentOffset" data-uid="Terminal.Gui.ScrollView.ContentOffset">ContentOffset</h4>
  346. <div class="markdown level1 summary">
  347. Represents the top left corner coordinate that is displayed by the scrollview
  348. </div>
  349. <div class="markdown level1 conceptual"></div>
  350. <h5 class="decalaration">Declaration</h5>
  351. <div class="codewrapper">
  352. <pre><code class="lang-csharp hljs">public Point ContentOffset { get; set; }</code></pre>
  353. </div>
  354. <h5 class="propertyValue">Property Value</h5>
  355. <table class="table table-bordered table-striped table-condensed">
  356. <thead>
  357. <tr>
  358. <th>Type</th>
  359. <th>Description</th>
  360. </tr>
  361. </thead>
  362. <tbody>
  363. <tr>
  364. <td><a class="xref" href="Terminal.Gui.Point.html">Point</a></td>
  365. <td>The content offset.</td>
  366. </tr>
  367. </tbody>
  368. </table>
  369. <a id="Terminal_Gui_ScrollView_ContentSize_" data-uid="Terminal.Gui.ScrollView.ContentSize*"></a>
  370. <h4 id="Terminal_Gui_ScrollView_ContentSize" data-uid="Terminal.Gui.ScrollView.ContentSize">ContentSize</h4>
  371. <div class="markdown level1 summary">
  372. Represents the contents of the data shown inside the scrolview
  373. </div>
  374. <div class="markdown level1 conceptual"></div>
  375. <h5 class="decalaration">Declaration</h5>
  376. <div class="codewrapper">
  377. <pre><code class="lang-csharp hljs">public Size ContentSize { get; set; }</code></pre>
  378. </div>
  379. <h5 class="propertyValue">Property Value</h5>
  380. <table class="table table-bordered table-striped table-condensed">
  381. <thead>
  382. <tr>
  383. <th>Type</th>
  384. <th>Description</th>
  385. </tr>
  386. </thead>
  387. <tbody>
  388. <tr>
  389. <td><a class="xref" href="Terminal.Gui.Size.html">Size</a></td>
  390. <td>The size of the content.</td>
  391. </tr>
  392. </tbody>
  393. </table>
  394. <a id="Terminal_Gui_ScrollView_ShowHorizontalScrollIndicator_" data-uid="Terminal.Gui.ScrollView.ShowHorizontalScrollIndicator*"></a>
  395. <h4 id="Terminal_Gui_ScrollView_ShowHorizontalScrollIndicator" data-uid="Terminal.Gui.ScrollView.ShowHorizontalScrollIndicator">ShowHorizontalScrollIndicator</h4>
  396. <div class="markdown level1 summary">
  397. Gets or sets the visibility for the horizontal scroll indicator.
  398. </div>
  399. <div class="markdown level1 conceptual"></div>
  400. <h5 class="decalaration">Declaration</h5>
  401. <div class="codewrapper">
  402. <pre><code class="lang-csharp hljs">public bool ShowHorizontalScrollIndicator { get; set; }</code></pre>
  403. </div>
  404. <h5 class="propertyValue">Property Value</h5>
  405. <table class="table table-bordered table-striped table-condensed">
  406. <thead>
  407. <tr>
  408. <th>Type</th>
  409. <th>Description</th>
  410. </tr>
  411. </thead>
  412. <tbody>
  413. <tr>
  414. <td><span class="xref">System.Boolean</span></td>
  415. <td><code>true</code> if show vertical scroll indicator; otherwise, <code>false</code>.</td>
  416. </tr>
  417. </tbody>
  418. </table>
  419. <a id="Terminal_Gui_ScrollView_ShowVerticalScrollIndicator_" data-uid="Terminal.Gui.ScrollView.ShowVerticalScrollIndicator*"></a>
  420. <h4 id="Terminal_Gui_ScrollView_ShowVerticalScrollIndicator" data-uid="Terminal.Gui.ScrollView.ShowVerticalScrollIndicator">ShowVerticalScrollIndicator</h4>
  421. <div class="markdown level1 summary">
  422. /// Gets or sets the visibility for the vertical scroll indicator.
  423. </div>
  424. <div class="markdown level1 conceptual"></div>
  425. <h5 class="decalaration">Declaration</h5>
  426. <div class="codewrapper">
  427. <pre><code class="lang-csharp hljs">public bool ShowVerticalScrollIndicator { get; set; }</code></pre>
  428. </div>
  429. <h5 class="propertyValue">Property Value</h5>
  430. <table class="table table-bordered table-striped table-condensed">
  431. <thead>
  432. <tr>
  433. <th>Type</th>
  434. <th>Description</th>
  435. </tr>
  436. </thead>
  437. <tbody>
  438. <tr>
  439. <td><span class="xref">System.Boolean</span></td>
  440. <td><code>true</code> if show vertical scroll indicator; otherwise, <code>false</code>.</td>
  441. </tr>
  442. </tbody>
  443. </table>
  444. <h3 id="methods">Methods
  445. </h3>
  446. <a id="Terminal_Gui_ScrollView_Add_" data-uid="Terminal.Gui.ScrollView.Add*"></a>
  447. <h4 id="Terminal_Gui_ScrollView_Add_Terminal_Gui_View_" data-uid="Terminal.Gui.ScrollView.Add(Terminal.Gui.View)">Add(View)</h4>
  448. <div class="markdown level1 summary">
  449. Adds the view to the scrollview.
  450. </div>
  451. <div class="markdown level1 conceptual"></div>
  452. <h5 class="decalaration">Declaration</h5>
  453. <div class="codewrapper">
  454. <pre><code class="lang-csharp hljs">public override void Add(View view)</code></pre>
  455. </div>
  456. <h5 class="parameters">Parameters</h5>
  457. <table class="table table-bordered table-striped table-condensed">
  458. <thead>
  459. <tr>
  460. <th>Type</th>
  461. <th>Name</th>
  462. <th>Description</th>
  463. </tr>
  464. </thead>
  465. <tbody>
  466. <tr>
  467. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  468. <td><span class="parametername">view</span></td>
  469. <td>The view to add to the scrollview.</td>
  470. </tr>
  471. </tbody>
  472. </table>
  473. <h5 class="overrides">Overrides</h5>
  474. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a></div>
  475. <a id="Terminal_Gui_ScrollView_MouseEvent_" data-uid="Terminal.Gui.ScrollView.MouseEvent*"></a>
  476. <h4 id="Terminal_Gui_ScrollView_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.ScrollView.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  477. <div class="markdown level1 summary"></div>
  478. <div class="markdown level1 conceptual"></div>
  479. <h5 class="decalaration">Declaration</h5>
  480. <div class="codewrapper">
  481. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent me)</code></pre>
  482. </div>
  483. <h5 class="parameters">Parameters</h5>
  484. <table class="table table-bordered table-striped table-condensed">
  485. <thead>
  486. <tr>
  487. <th>Type</th>
  488. <th>Name</th>
  489. <th>Description</th>
  490. </tr>
  491. </thead>
  492. <tbody>
  493. <tr>
  494. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  495. <td><span class="parametername">me</span></td>
  496. <td></td>
  497. </tr>
  498. </tbody>
  499. </table>
  500. <h5 class="returns">Returns</h5>
  501. <table class="table table-bordered table-striped table-condensed">
  502. <thead>
  503. <tr>
  504. <th>Type</th>
  505. <th>Description</th>
  506. </tr>
  507. </thead>
  508. <tbody>
  509. <tr>
  510. <td><span class="xref">System.Boolean</span></td>
  511. <td></td>
  512. </tr>
  513. </tbody>
  514. </table>
  515. <h5 class="overrides">Overrides</h5>
  516. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  517. <a id="Terminal_Gui_ScrollView_PositionCursor_" data-uid="Terminal.Gui.ScrollView.PositionCursor*"></a>
  518. <h4 id="Terminal_Gui_ScrollView_PositionCursor" data-uid="Terminal.Gui.ScrollView.PositionCursor">PositionCursor()</h4>
  519. <div class="markdown level1 summary"></div>
  520. <div class="markdown level1 conceptual"></div>
  521. <h5 class="decalaration">Declaration</h5>
  522. <div class="codewrapper">
  523. <pre><code class="lang-csharp hljs">public override void PositionCursor()</code></pre>
  524. </div>
  525. <h5 class="overrides">Overrides</h5>
  526. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a></div>
  527. <a id="Terminal_Gui_ScrollView_ProcessKey_" data-uid="Terminal.Gui.ScrollView.ProcessKey*"></a>
  528. <h4 id="Terminal_Gui_ScrollView_ProcessKey_Terminal_Gui_KeyEvent_" data-uid="Terminal.Gui.ScrollView.ProcessKey(Terminal.Gui.KeyEvent)">ProcessKey(KeyEvent)</h4>
  529. <div class="markdown level1 summary"></div>
  530. <div class="markdown level1 conceptual"></div>
  531. <h5 class="decalaration">Declaration</h5>
  532. <div class="codewrapper">
  533. <pre><code class="lang-csharp hljs">public override bool ProcessKey(KeyEvent kb)</code></pre>
  534. </div>
  535. <h5 class="parameters">Parameters</h5>
  536. <table class="table table-bordered table-striped table-condensed">
  537. <thead>
  538. <tr>
  539. <th>Type</th>
  540. <th>Name</th>
  541. <th>Description</th>
  542. </tr>
  543. </thead>
  544. <tbody>
  545. <tr>
  546. <td><a class="xref" href="Terminal.Gui.KeyEvent.html">KeyEvent</a></td>
  547. <td><span class="parametername">kb</span></td>
  548. <td></td>
  549. </tr>
  550. </tbody>
  551. </table>
  552. <h5 class="returns">Returns</h5>
  553. <table class="table table-bordered table-striped table-condensed">
  554. <thead>
  555. <tr>
  556. <th>Type</th>
  557. <th>Description</th>
  558. </tr>
  559. </thead>
  560. <tbody>
  561. <tr>
  562. <td><span class="xref">System.Boolean</span></td>
  563. <td></td>
  564. </tr>
  565. </tbody>
  566. </table>
  567. <h5 class="overrides">Overrides</h5>
  568. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a></div>
  569. <a id="Terminal_Gui_ScrollView_Redraw_" data-uid="Terminal.Gui.ScrollView.Redraw*"></a>
  570. <h4 id="Terminal_Gui_ScrollView_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.ScrollView.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  571. <div class="markdown level1 summary">
  572. This event is raised when the contents have scrolled
  573. </div>
  574. <div class="markdown level1 conceptual"></div>
  575. <h5 class="decalaration">Declaration</h5>
  576. <div class="codewrapper">
  577. <pre><code class="lang-csharp hljs">public override void Redraw(Rect region)</code></pre>
  578. </div>
  579. <h5 class="parameters">Parameters</h5>
  580. <table class="table table-bordered table-striped table-condensed">
  581. <thead>
  582. <tr>
  583. <th>Type</th>
  584. <th>Name</th>
  585. <th>Description</th>
  586. </tr>
  587. </thead>
  588. <tbody>
  589. <tr>
  590. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  591. <td><span class="parametername">region</span></td>
  592. <td></td>
  593. </tr>
  594. </tbody>
  595. </table>
  596. <h5 class="overrides">Overrides</h5>
  597. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  598. <a id="Terminal_Gui_ScrollView_RemoveAll_" data-uid="Terminal.Gui.ScrollView.RemoveAll*"></a>
  599. <h4 id="Terminal_Gui_ScrollView_RemoveAll" data-uid="Terminal.Gui.ScrollView.RemoveAll">RemoveAll()</h4>
  600. <div class="markdown level1 summary">
  601. Removes all widgets from this container.
  602. </div>
  603. <div class="markdown level1 conceptual"></div>
  604. <h5 class="decalaration">Declaration</h5>
  605. <div class="codewrapper">
  606. <pre><code class="lang-csharp hljs">public override void RemoveAll()</code></pre>
  607. </div>
  608. <h5 class="overrides">Overrides</h5>
  609. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a></div>
  610. <h5 id="Terminal_Gui_ScrollView_RemoveAll_remarks">Remarks</h5>
  611. <div class="markdown level1 remarks">
  612. </div>
  613. <a id="Terminal_Gui_ScrollView_ScrollDown_" data-uid="Terminal.Gui.ScrollView.ScrollDown*"></a>
  614. <h4 id="Terminal_Gui_ScrollView_ScrollDown_System_Int32_" data-uid="Terminal.Gui.ScrollView.ScrollDown(System.Int32)">ScrollDown(Int32)</h4>
  615. <div class="markdown level1 summary">
  616. Scrolls the view down.
  617. </div>
  618. <div class="markdown level1 conceptual"></div>
  619. <h5 class="decalaration">Declaration</h5>
  620. <div class="codewrapper">
  621. <pre><code class="lang-csharp hljs">public bool ScrollDown(int lines)</code></pre>
  622. </div>
  623. <h5 class="parameters">Parameters</h5>
  624. <table class="table table-bordered table-striped table-condensed">
  625. <thead>
  626. <tr>
  627. <th>Type</th>
  628. <th>Name</th>
  629. <th>Description</th>
  630. </tr>
  631. </thead>
  632. <tbody>
  633. <tr>
  634. <td><span class="xref">System.Int32</span></td>
  635. <td><span class="parametername">lines</span></td>
  636. <td>Number of lines to scroll.</td>
  637. </tr>
  638. </tbody>
  639. </table>
  640. <h5 class="returns">Returns</h5>
  641. <table class="table table-bordered table-striped table-condensed">
  642. <thead>
  643. <tr>
  644. <th>Type</th>
  645. <th>Description</th>
  646. </tr>
  647. </thead>
  648. <tbody>
  649. <tr>
  650. <td><span class="xref">System.Boolean</span></td>
  651. <td><code>true</code>, if left was scrolled, <code>false</code> otherwise.</td>
  652. </tr>
  653. </tbody>
  654. </table>
  655. <a id="Terminal_Gui_ScrollView_ScrollLeft_" data-uid="Terminal.Gui.ScrollView.ScrollLeft*"></a>
  656. <h4 id="Terminal_Gui_ScrollView_ScrollLeft_System_Int32_" data-uid="Terminal.Gui.ScrollView.ScrollLeft(System.Int32)">ScrollLeft(Int32)</h4>
  657. <div class="markdown level1 summary">
  658. Scrolls the view to the left
  659. </div>
  660. <div class="markdown level1 conceptual"></div>
  661. <h5 class="decalaration">Declaration</h5>
  662. <div class="codewrapper">
  663. <pre><code class="lang-csharp hljs">public bool ScrollLeft(int cols)</code></pre>
  664. </div>
  665. <h5 class="parameters">Parameters</h5>
  666. <table class="table table-bordered table-striped table-condensed">
  667. <thead>
  668. <tr>
  669. <th>Type</th>
  670. <th>Name</th>
  671. <th>Description</th>
  672. </tr>
  673. </thead>
  674. <tbody>
  675. <tr>
  676. <td><span class="xref">System.Int32</span></td>
  677. <td><span class="parametername">cols</span></td>
  678. <td>Number of columns to scroll by.</td>
  679. </tr>
  680. </tbody>
  681. </table>
  682. <h5 class="returns">Returns</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><span class="xref">System.Boolean</span></td>
  693. <td><code>true</code>, if left was scrolled, <code>false</code> otherwise.</td>
  694. </tr>
  695. </tbody>
  696. </table>
  697. <a id="Terminal_Gui_ScrollView_ScrollRight_" data-uid="Terminal.Gui.ScrollView.ScrollRight*"></a>
  698. <h4 id="Terminal_Gui_ScrollView_ScrollRight_System_Int32_" data-uid="Terminal.Gui.ScrollView.ScrollRight(System.Int32)">ScrollRight(Int32)</h4>
  699. <div class="markdown level1 summary">
  700. Scrolls the view to the right.
  701. </div>
  702. <div class="markdown level1 conceptual"></div>
  703. <h5 class="decalaration">Declaration</h5>
  704. <div class="codewrapper">
  705. <pre><code class="lang-csharp hljs">public bool ScrollRight(int cols)</code></pre>
  706. </div>
  707. <h5 class="parameters">Parameters</h5>
  708. <table class="table table-bordered table-striped table-condensed">
  709. <thead>
  710. <tr>
  711. <th>Type</th>
  712. <th>Name</th>
  713. <th>Description</th>
  714. </tr>
  715. </thead>
  716. <tbody>
  717. <tr>
  718. <td><span class="xref">System.Int32</span></td>
  719. <td><span class="parametername">cols</span></td>
  720. <td>Number of columns to scroll by.</td>
  721. </tr>
  722. </tbody>
  723. </table>
  724. <h5 class="returns">Returns</h5>
  725. <table class="table table-bordered table-striped table-condensed">
  726. <thead>
  727. <tr>
  728. <th>Type</th>
  729. <th>Description</th>
  730. </tr>
  731. </thead>
  732. <tbody>
  733. <tr>
  734. <td><span class="xref">System.Boolean</span></td>
  735. <td><code>true</code>, if right was scrolled, <code>false</code> otherwise.</td>
  736. </tr>
  737. </tbody>
  738. </table>
  739. <a id="Terminal_Gui_ScrollView_ScrollUp_" data-uid="Terminal.Gui.ScrollView.ScrollUp*"></a>
  740. <h4 id="Terminal_Gui_ScrollView_ScrollUp_System_Int32_" data-uid="Terminal.Gui.ScrollView.ScrollUp(System.Int32)">ScrollUp(Int32)</h4>
  741. <div class="markdown level1 summary">
  742. Scrolls the view up.
  743. </div>
  744. <div class="markdown level1 conceptual"></div>
  745. <h5 class="decalaration">Declaration</h5>
  746. <div class="codewrapper">
  747. <pre><code class="lang-csharp hljs">public bool ScrollUp(int lines)</code></pre>
  748. </div>
  749. <h5 class="parameters">Parameters</h5>
  750. <table class="table table-bordered table-striped table-condensed">
  751. <thead>
  752. <tr>
  753. <th>Type</th>
  754. <th>Name</th>
  755. <th>Description</th>
  756. </tr>
  757. </thead>
  758. <tbody>
  759. <tr>
  760. <td><span class="xref">System.Int32</span></td>
  761. <td><span class="parametername">lines</span></td>
  762. <td>Number of lines to scroll.</td>
  763. </tr>
  764. </tbody>
  765. </table>
  766. <h5 class="returns">Returns</h5>
  767. <table class="table table-bordered table-striped table-condensed">
  768. <thead>
  769. <tr>
  770. <th>Type</th>
  771. <th>Description</th>
  772. </tr>
  773. </thead>
  774. <tbody>
  775. <tr>
  776. <td><span class="xref">System.Boolean</span></td>
  777. <td><code>true</code>, if left was scrolled, <code>false</code> otherwise.</td>
  778. </tr>
  779. </tbody>
  780. </table>
  781. <h3 id="implements">Implements</h3>
  782. <div>
  783. <span class="xref">System.Collections.IEnumerable</span>
  784. </div>
  785. </article>
  786. </div>
  787. <div class="hidden-sm col-md-2" role="complementary">
  788. <div class="sideaffix">
  789. <div class="contribution">
  790. <ul class="nav">
  791. </ul>
  792. </div>
  793. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  794. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  795. </nav>
  796. </div>
  797. </div>
  798. </div>
  799. </div>
  800. <footer>
  801. <div class="grad-bottom"></div>
  802. <div class="footer">
  803. <div class="container">
  804. <span class="pull-right">
  805. <a href="#top">Back to top</a>
  806. </span>
  807. <span>Generated by <strong>DocFX</strong></span>
  808. </div>
  809. </div>
  810. </footer>
  811. </div>
  812. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  813. <script type="text/javascript" src="../../styles/docfx.js"></script>
  814. <script type="text/javascript" src="../../styles/main.js"></script>
  815. </body>
  816. </html>