Terminal.Gui.ScrollView.html 28 KB

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