Terminal.Gui.ScrollBarView.html 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727
  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 ScrollBarView
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class ScrollBarView
  11. ">
  12. <meta name="generator" content="docfx 2.54.0.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <meta property="docfx:navrel" content="../../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list"></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.ScrollBarView">
  73. <h1 id="Terminal_Gui_ScrollBarView" data-uid="Terminal.Gui.ScrollBarView" class="text-break">Class ScrollBarView
  74. </h1>
  75. <div class="markdown level0 summary">
  76. ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical
  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">ScrollBarView</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_MouseClick">View.MouseClick</a>
  106. </div>
  107. <div>
  108. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  109. </div>
  110. <div>
  111. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  112. </div>
  113. <div>
  114. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  115. </div>
  116. <div>
  117. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  118. </div>
  119. <div>
  120. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  121. </div>
  122. <div>
  123. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  124. </div>
  125. <div>
  126. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  127. </div>
  128. <div>
  129. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetEnumerator">View.GetEnumerator()</a>
  130. </div>
  131. <div>
  132. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  133. </div>
  134. <div>
  135. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  136. </div>
  137. <div>
  138. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  139. </div>
  140. <div>
  141. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  142. </div>
  143. <div>
  144. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  145. </div>
  146. <div>
  147. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  148. </div>
  149. <div>
  150. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  151. </div>
  152. <div>
  153. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  154. </div>
  155. <div>
  156. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  157. </div>
  158. <div>
  159. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
  160. </div>
  161. <div>
  162. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  163. </div>
  164. <div>
  165. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  166. </div>
  167. <div>
  168. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  169. </div>
  170. <div>
  171. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  172. </div>
  173. <div>
  174. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  175. </div>
  176. <div>
  177. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  178. </div>
  179. <div>
  180. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  181. </div>
  182. <div>
  183. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  184. </div>
  185. <div>
  186. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  187. </div>
  188. <div>
  189. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  190. </div>
  191. <div>
  192. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  193. </div>
  194. <div>
  195. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  196. </div>
  197. <div>
  198. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  199. </div>
  200. <div>
  201. <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>
  202. </div>
  203. <div>
  204. <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>
  205. </div>
  206. <div>
  207. <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>
  208. </div>
  209. <div>
  210. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  211. </div>
  212. <div>
  213. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a>
  214. </div>
  215. <div>
  216. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  217. </div>
  218. <div>
  219. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter">View.OnEnter()</a>
  220. </div>
  221. <div>
  222. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave">View.OnLeave()</a>
  223. </div>
  224. <div>
  225. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  226. </div>
  227. <div>
  228. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  229. </div>
  230. <div>
  231. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  232. </div>
  233. <div>
  234. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  235. </div>
  236. <div>
  237. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  238. </div>
  239. <div>
  240. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  241. </div>
  242. <div>
  243. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  244. </div>
  245. <div>
  246. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus_Terminal_Gui_View_">View.SetFocus(View)</a>
  247. </div>
  248. <div>
  249. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  250. </div>
  251. <div>
  252. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a>
  253. </div>
  254. <div>
  255. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  256. </div>
  257. <div>
  258. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  259. </div>
  260. <div>
  261. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  262. </div>
  263. <div>
  264. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  265. </div>
  266. <div>
  267. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  268. </div>
  269. <div>
  270. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  271. </div>
  272. <div>
  273. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  274. </div>
  275. <div>
  276. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  277. </div>
  278. <div>
  279. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  280. </div>
  281. <div>
  282. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  283. </div>
  284. <div>
  285. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  286. </div>
  287. <div>
  288. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  289. </div>
  290. <div>
  291. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  292. </div>
  293. <div>
  294. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  295. </div>
  296. <div>
  297. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  298. </div>
  299. <div>
  300. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  301. </div>
  302. <div>
  303. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  304. </div>
  305. <div>
  306. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_CanFocus">Responder.CanFocus</a>
  307. </div>
  308. <div>
  309. <span class="xref">System.Object.Equals(System.Object)</span>
  310. </div>
  311. <div>
  312. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  313. </div>
  314. <div>
  315. <span class="xref">System.Object.GetHashCode()</span>
  316. </div>
  317. <div>
  318. <span class="xref">System.Object.GetType()</span>
  319. </div>
  320. <div>
  321. <span class="xref">System.Object.MemberwiseClone()</span>
  322. </div>
  323. <div>
  324. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  325. </div>
  326. </div>
  327. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  328. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  329. <h5 id="Terminal_Gui_ScrollBarView_syntax">Syntax</h5>
  330. <div class="codewrapper">
  331. <pre><code class="lang-csharp hljs">public class ScrollBarView : View, IEnumerable</code></pre>
  332. </div>
  333. <h5 id="Terminal_Gui_ScrollBarView_remarks"><strong>Remarks</strong></h5>
  334. <div class="markdown level0 remarks">
  335. <p>
  336. The scrollbar is drawn to be a representation of the Size, assuming that the
  337. scroll position is set at Position.
  338. </p>
  339. <p>
  340. If the region to display the scrollbar is larger than three characters,
  341. arrow indicators are drawn.
  342. </p>
  343. </div>
  344. <h3 id="constructors">Constructors
  345. </h3>
  346. <a id="Terminal_Gui_ScrollBarView__ctor_" data-uid="Terminal.Gui.ScrollBarView.#ctor*"></a>
  347. <h4 id="Terminal_Gui_ScrollBarView__ctor" data-uid="Terminal.Gui.ScrollBarView.#ctor">ScrollBarView()</h4>
  348. <div class="markdown level1 summary">
  349. Initializes a new instance of the <a class="xref" href="Terminal.Gui.ScrollBarView.html">ScrollBarView</a> class using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a> layout.
  350. </div>
  351. <div class="markdown level1 conceptual"></div>
  352. <h5 class="decalaration">Declaration</h5>
  353. <div class="codewrapper">
  354. <pre><code class="lang-csharp hljs">public ScrollBarView()</code></pre>
  355. </div>
  356. <a id="Terminal_Gui_ScrollBarView__ctor_" data-uid="Terminal.Gui.ScrollBarView.#ctor*"></a>
  357. <h4 id="Terminal_Gui_ScrollBarView__ctor_System_Int32_System_Int32_System_Boolean_" data-uid="Terminal.Gui.ScrollBarView.#ctor(System.Int32,System.Int32,System.Boolean)">ScrollBarView(Int32, Int32, Boolean)</h4>
  358. <div class="markdown level1 summary">
  359. Initializes a new instance of the <a class="xref" href="Terminal.Gui.ScrollBarView.html">ScrollBarView</a> class using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Computed">Computed</a> layout.
  360. </div>
  361. <div class="markdown level1 conceptual"></div>
  362. <h5 class="decalaration">Declaration</h5>
  363. <div class="codewrapper">
  364. <pre><code class="lang-csharp hljs">public ScrollBarView(int size, int position, bool isVertical)</code></pre>
  365. </div>
  366. <h5 class="parameters">Parameters</h5>
  367. <table class="table table-bordered table-striped table-condensed">
  368. <thead>
  369. <tr>
  370. <th>Type</th>
  371. <th>Name</th>
  372. <th>Description</th>
  373. </tr>
  374. </thead>
  375. <tbody>
  376. <tr>
  377. <td><span class="xref">System.Int32</span></td>
  378. <td><span class="parametername">size</span></td>
  379. <td>The size that this scrollbar represents.</td>
  380. </tr>
  381. <tr>
  382. <td><span class="xref">System.Int32</span></td>
  383. <td><span class="parametername">position</span></td>
  384. <td>The position within this scrollbar.</td>
  385. </tr>
  386. <tr>
  387. <td><span class="xref">System.Boolean</span></td>
  388. <td><span class="parametername">isVertical</span></td>
  389. <td>If set to <code>true</code> this is a vertical scrollbar, otherwise, the scrollbar is horizontal.</td>
  390. </tr>
  391. </tbody>
  392. </table>
  393. <a id="Terminal_Gui_ScrollBarView__ctor_" data-uid="Terminal.Gui.ScrollBarView.#ctor*"></a>
  394. <h4 id="Terminal_Gui_ScrollBarView__ctor_Terminal_Gui_Rect_" data-uid="Terminal.Gui.ScrollBarView.#ctor(Terminal.Gui.Rect)">ScrollBarView(Rect)</h4>
  395. <div class="markdown level1 summary">
  396. Initializes a new instance of the <a class="xref" href="Terminal.Gui.ScrollBarView.html">ScrollBarView</a> class using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> layout.
  397. </div>
  398. <div class="markdown level1 conceptual"></div>
  399. <h5 class="decalaration">Declaration</h5>
  400. <div class="codewrapper">
  401. <pre><code class="lang-csharp hljs">public ScrollBarView(Rect rect)</code></pre>
  402. </div>
  403. <h5 class="parameters">Parameters</h5>
  404. <table class="table table-bordered table-striped table-condensed">
  405. <thead>
  406. <tr>
  407. <th>Type</th>
  408. <th>Name</th>
  409. <th>Description</th>
  410. </tr>
  411. </thead>
  412. <tbody>
  413. <tr>
  414. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  415. <td><span class="parametername">rect</span></td>
  416. <td>Frame for the scrollbar.</td>
  417. </tr>
  418. </tbody>
  419. </table>
  420. <a id="Terminal_Gui_ScrollBarView__ctor_" data-uid="Terminal.Gui.ScrollBarView.#ctor*"></a>
  421. <h4 id="Terminal_Gui_ScrollBarView__ctor_Terminal_Gui_Rect_System_Int32_System_Int32_System_Boolean_" data-uid="Terminal.Gui.ScrollBarView.#ctor(Terminal.Gui.Rect,System.Int32,System.Int32,System.Boolean)">ScrollBarView(Rect, Int32, Int32, Boolean)</h4>
  422. <div class="markdown level1 summary">
  423. Initializes a new instance of the <a class="xref" href="Terminal.Gui.ScrollBarView.html">ScrollBarView</a> class using <a class="xref" href="Terminal.Gui.LayoutStyle.html#Terminal_Gui_LayoutStyle_Absolute">Absolute</a> layout.
  424. </div>
  425. <div class="markdown level1 conceptual"></div>
  426. <h5 class="decalaration">Declaration</h5>
  427. <div class="codewrapper">
  428. <pre><code class="lang-csharp hljs">public ScrollBarView(Rect rect, int size, int position, bool isVertical)</code></pre>
  429. </div>
  430. <h5 class="parameters">Parameters</h5>
  431. <table class="table table-bordered table-striped table-condensed">
  432. <thead>
  433. <tr>
  434. <th>Type</th>
  435. <th>Name</th>
  436. <th>Description</th>
  437. </tr>
  438. </thead>
  439. <tbody>
  440. <tr>
  441. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  442. <td><span class="parametername">rect</span></td>
  443. <td>Frame for the scrollbar.</td>
  444. </tr>
  445. <tr>
  446. <td><span class="xref">System.Int32</span></td>
  447. <td><span class="parametername">size</span></td>
  448. <td>The size that this scrollbar represents. Sets the <a class="xref" href="Terminal.Gui.ScrollBarView.html#Terminal_Gui_ScrollBarView_Size">Size</a> property.</td>
  449. </tr>
  450. <tr>
  451. <td><span class="xref">System.Int32</span></td>
  452. <td><span class="parametername">position</span></td>
  453. <td>The position within this scrollbar. Sets the <a class="xref" href="Terminal.Gui.ScrollBarView.html#Terminal_Gui_ScrollBarView_Position">Position</a> property.</td>
  454. </tr>
  455. <tr>
  456. <td><span class="xref">System.Boolean</span></td>
  457. <td><span class="parametername">isVertical</span></td>
  458. <td>If set to <code>true</code> this is a vertical scrollbar, otherwise, the scrollbar is horizontal. Sets the <a class="xref" href="Terminal.Gui.ScrollBarView.html#Terminal_Gui_ScrollBarView_IsVertical">IsVertical</a> property.</td>
  459. </tr>
  460. </tbody>
  461. </table>
  462. <h3 id="properties">Properties
  463. </h3>
  464. <a id="Terminal_Gui_ScrollBarView_IsVertical_" data-uid="Terminal.Gui.ScrollBarView.IsVertical*"></a>
  465. <h4 id="Terminal_Gui_ScrollBarView_IsVertical" data-uid="Terminal.Gui.ScrollBarView.IsVertical">IsVertical</h4>
  466. <div class="markdown level1 summary">
  467. If set to <code>true</code> this is a vertical scrollbar, otherwise, the scrollbar is horizontal.
  468. </div>
  469. <div class="markdown level1 conceptual"></div>
  470. <h5 class="decalaration">Declaration</h5>
  471. <div class="codewrapper">
  472. <pre><code class="lang-csharp hljs">public bool IsVertical { get; set; }</code></pre>
  473. </div>
  474. <h5 class="propertyValue">Property Value</h5>
  475. <table class="table table-bordered table-striped table-condensed">
  476. <thead>
  477. <tr>
  478. <th>Type</th>
  479. <th>Description</th>
  480. </tr>
  481. </thead>
  482. <tbody>
  483. <tr>
  484. <td><span class="xref">System.Boolean</span></td>
  485. <td></td>
  486. </tr>
  487. </tbody>
  488. </table>
  489. <a id="Terminal_Gui_ScrollBarView_Position_" data-uid="Terminal.Gui.ScrollBarView.Position*"></a>
  490. <h4 id="Terminal_Gui_ScrollBarView_Position" data-uid="Terminal.Gui.ScrollBarView.Position">Position</h4>
  491. <div class="markdown level1 summary">
  492. The position, relative to <a class="xref" href="Terminal.Gui.ScrollBarView.html#Terminal_Gui_ScrollBarView_Size">Size</a>, to set the scrollbar at.
  493. </div>
  494. <div class="markdown level1 conceptual"></div>
  495. <h5 class="decalaration">Declaration</h5>
  496. <div class="codewrapper">
  497. <pre><code class="lang-csharp hljs">public int Position { get; set; }</code></pre>
  498. </div>
  499. <h5 class="propertyValue">Property Value</h5>
  500. <table class="table table-bordered table-striped table-condensed">
  501. <thead>
  502. <tr>
  503. <th>Type</th>
  504. <th>Description</th>
  505. </tr>
  506. </thead>
  507. <tbody>
  508. <tr>
  509. <td><span class="xref">System.Int32</span></td>
  510. <td>The position.</td>
  511. </tr>
  512. </tbody>
  513. </table>
  514. <a id="Terminal_Gui_ScrollBarView_Size_" data-uid="Terminal.Gui.ScrollBarView.Size*"></a>
  515. <h4 id="Terminal_Gui_ScrollBarView_Size" data-uid="Terminal.Gui.ScrollBarView.Size">Size</h4>
  516. <div class="markdown level1 summary">
  517. The size of content the scrollbar represents.
  518. </div>
  519. <div class="markdown level1 conceptual"></div>
  520. <h5 class="decalaration">Declaration</h5>
  521. <div class="codewrapper">
  522. <pre><code class="lang-csharp hljs">public int Size { get; set; }</code></pre>
  523. </div>
  524. <h5 class="propertyValue">Property Value</h5>
  525. <table class="table table-bordered table-striped table-condensed">
  526. <thead>
  527. <tr>
  528. <th>Type</th>
  529. <th>Description</th>
  530. </tr>
  531. </thead>
  532. <tbody>
  533. <tr>
  534. <td><span class="xref">System.Int32</span></td>
  535. <td>The size.</td>
  536. </tr>
  537. </tbody>
  538. </table>
  539. <h5 id="Terminal_Gui_ScrollBarView_Size_remarks">Remarks</h5>
  540. <div class="markdown level1 remarks">The <a class="xref" href="Terminal.Gui.ScrollBarView.html#Terminal_Gui_ScrollBarView_Size">Size</a> is typically the size of the virtual content. E.g. when a Scrollbar is
  541. part of a <a class="xref" href="Terminal.Gui.ScrollView.html">ScrollView</a> the Size is set to the appropriate dimension of <a class="xref" href="Terminal.Gui.ScrollView.html#Terminal_Gui_ScrollView_ContentSize">ContentSize</a>.</div>
  542. <h3 id="methods">Methods
  543. </h3>
  544. <a id="Terminal_Gui_ScrollBarView_MouseEvent_" data-uid="Terminal.Gui.ScrollBarView.MouseEvent*"></a>
  545. <h4 id="Terminal_Gui_ScrollBarView_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.ScrollBarView.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  546. <div class="markdown level1 summary">
  547. Method invoked when a mouse event is generated
  548. </div>
  549. <div class="markdown level1 conceptual"></div>
  550. <h5 class="decalaration">Declaration</h5>
  551. <div class="codewrapper">
  552. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent me)</code></pre>
  553. </div>
  554. <h5 class="parameters">Parameters</h5>
  555. <table class="table table-bordered table-striped table-condensed">
  556. <thead>
  557. <tr>
  558. <th>Type</th>
  559. <th>Name</th>
  560. <th>Description</th>
  561. </tr>
  562. </thead>
  563. <tbody>
  564. <tr>
  565. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  566. <td><span class="parametername">me</span></td>
  567. <td></td>
  568. </tr>
  569. </tbody>
  570. </table>
  571. <h5 class="returns">Returns</h5>
  572. <table class="table table-bordered table-striped table-condensed">
  573. <thead>
  574. <tr>
  575. <th>Type</th>
  576. <th>Description</th>
  577. </tr>
  578. </thead>
  579. <tbody>
  580. <tr>
  581. <td><span class="xref">System.Boolean</span></td>
  582. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  583. </tr>
  584. </tbody>
  585. </table>
  586. <h5 class="overrides">Overrides</h5>
  587. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  588. <a id="Terminal_Gui_ScrollBarView_Redraw_" data-uid="Terminal.Gui.ScrollBarView.Redraw*"></a>
  589. <h4 id="Terminal_Gui_ScrollBarView_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.ScrollBarView.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  590. <div class="markdown level1 summary">
  591. Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
  592. </div>
  593. <div class="markdown level1 conceptual"></div>
  594. <h5 class="decalaration">Declaration</h5>
  595. <div class="codewrapper">
  596. <pre><code class="lang-csharp hljs">public override void Redraw(Rect region)</code></pre>
  597. </div>
  598. <h5 class="parameters">Parameters</h5>
  599. <table class="table table-bordered table-striped table-condensed">
  600. <thead>
  601. <tr>
  602. <th>Type</th>
  603. <th>Name</th>
  604. <th>Description</th>
  605. </tr>
  606. </thead>
  607. <tbody>
  608. <tr>
  609. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  610. <td><span class="parametername">region</span></td>
  611. <td></td>
  612. </tr>
  613. </tbody>
  614. </table>
  615. <h5 class="overrides">Overrides</h5>
  616. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  617. <h5 id="Terminal_Gui_ScrollBarView_Redraw_Terminal_Gui_Rect__remarks">Remarks</h5>
  618. <div class="markdown level1 remarks">
  619. <p>
  620. Always use <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">Bounds</a> (view-relative) when calling <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">Redraw(Rect)</a>, NOT <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">Frame</a> (superview-relative).
  621. </p>
  622. <p>
  623. Views should set the color that they want to use on entry, as otherwise this will inherit
  624. the last color that was set globaly on the driver.
  625. </p>
  626. <p>
  627. Overrides of <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">Redraw(Rect)</a> must ensure they do not set <code>Driver.Clip</code> to a clip region
  628. larger than the <code>region</code> parameter.
  629. </p>
  630. </div>
  631. <h3 id="events">Events
  632. </h3>
  633. <h4 id="Terminal_Gui_ScrollBarView_ChangedPosition" data-uid="Terminal.Gui.ScrollBarView.ChangedPosition">ChangedPosition</h4>
  634. <div class="markdown level1 summary">
  635. This event is raised when the position on the scrollbar has changed.
  636. </div>
  637. <div class="markdown level1 conceptual"></div>
  638. <h5 class="decalaration">Declaration</h5>
  639. <div class="codewrapper">
  640. <pre><code class="lang-csharp hljs">public event Action ChangedPosition</code></pre>
  641. </div>
  642. <h5 class="eventType">Event Type</h5>
  643. <table class="table table-bordered table-striped table-condensed">
  644. <thead>
  645. <tr>
  646. <th>Type</th>
  647. <th>Description</th>
  648. </tr>
  649. </thead>
  650. <tbody>
  651. <tr>
  652. <td><span class="xref">System.Action</span></td>
  653. <td></td>
  654. </tr>
  655. </tbody>
  656. </table>
  657. <h3 id="implements">Implements</h3>
  658. <div>
  659. <span class="xref">System.Collections.IEnumerable</span>
  660. </div>
  661. </article>
  662. </div>
  663. <div class="hidden-sm col-md-2" role="complementary">
  664. <div class="sideaffix">
  665. <div class="contribution">
  666. <ul class="nav">
  667. </ul>
  668. </div>
  669. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  670. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  671. </nav>
  672. </div>
  673. </div>
  674. </div>
  675. </div>
  676. <footer>
  677. <div class="grad-bottom"></div>
  678. <div class="footer">
  679. <div class="container">
  680. <span class="pull-right">
  681. <a href="#top">Back to top</a>
  682. </span>
  683. <span>Generated by <strong>DocFX</strong></span>
  684. </div>
  685. </div>
  686. </footer>
  687. </div>
  688. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  689. <script type="text/javascript" src="../../styles/docfx.js"></script>
  690. <script type="text/javascript" src="../../styles/main.js"></script>
  691. </body>
  692. </html>