Terminal.Gui.ScrollBarView.html 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822
  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.56.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="../../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.IDisposable</span></div>
  89. <div><span class="xref">System.ComponentModel.ISupportInitializeNotification</span></div>
  90. <div><span class="xref">System.ComponentModel.ISupportInitialize</span></div>
  91. </div>
  92. <div class="inheritedMembers">
  93. <h5>Inherited Members</h5>
  94. <div>
  95. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Added">View.Added</a>
  96. </div>
  97. <div>
  98. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Removed">View.Removed</a>
  99. </div>
  100. <div>
  101. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  102. </div>
  103. <div>
  104. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  105. </div>
  106. <div>
  107. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  108. </div>
  109. <div>
  110. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  111. </div>
  112. <div>
  113. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  114. </div>
  115. <div>
  116. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKey">View.HotKey</a>
  117. </div>
  118. <div>
  119. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">View.HotKeySpecifier</a>
  120. </div>
  121. <div>
  122. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Data">View.Data</a>
  123. </div>
  124. <div>
  125. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  126. </div>
  127. <div>
  128. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  129. </div>
  130. <div>
  131. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">View.TabIndexes</a>
  132. </div>
  133. <div>
  134. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndex">View.TabIndex</a>
  135. </div>
  136. <div>
  137. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabStop">View.TabStop</a>
  138. </div>
  139. <div>
  140. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocus">View.CanFocus</a>
  141. </div>
  142. <div>
  143. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  144. </div>
  145. <div>
  146. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  147. </div>
  148. <div>
  149. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  150. </div>
  151. <div>
  152. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  153. </div>
  154. <div>
  155. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  156. </div>
  157. <div>
  158. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  159. </div>
  160. <div>
  161. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  162. </div>
  163. <div>
  164. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  165. </div>
  166. <div>
  167. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  168. </div>
  169. <div>
  170. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  171. </div>
  172. <div>
  173. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  174. </div>
  175. <div>
  176. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  177. </div>
  178. <div>
  179. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  180. </div>
  181. <div>
  182. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  183. </div>
  184. <div>
  185. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
  186. </div>
  187. <div>
  188. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  189. </div>
  190. <div>
  191. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  192. </div>
  193. <div>
  194. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  195. </div>
  196. <div>
  197. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  198. </div>
  199. <div>
  200. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  201. </div>
  202. <div>
  203. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  204. </div>
  205. <div>
  206. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  207. </div>
  208. <div>
  209. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  210. </div>
  211. <div>
  212. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  213. </div>
  214. <div>
  215. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  216. </div>
  217. <div>
  218. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  219. </div>
  220. <div>
  221. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  222. </div>
  223. <div>
  224. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  225. </div>
  226. <div>
  227. <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>
  228. </div>
  229. <div>
  230. <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>
  231. </div>
  232. <div>
  233. <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>
  234. </div>
  235. <div>
  236. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
  237. </div>
  238. <div>
  239. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a>
  240. </div>
  241. <div>
  242. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  243. </div>
  244. <div>
  245. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnAdded_Terminal_Gui_View_">View.OnAdded(View)</a>
  246. </div>
  247. <div>
  248. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnRemoved_Terminal_Gui_View_">View.OnRemoved(View)</a>
  249. </div>
  250. <div>
  251. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter_Terminal_Gui_View_">View.OnEnter(View)</a>
  252. </div>
  253. <div>
  254. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave_Terminal_Gui_View_">View.OnLeave(View)</a>
  255. </div>
  256. <div>
  257. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  258. </div>
  259. <div>
  260. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  261. </div>
  262. <div>
  263. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  264. </div>
  265. <div>
  266. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  267. </div>
  268. <div>
  269. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  270. </div>
  271. <div>
  272. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  273. </div>
  274. <div>
  275. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  276. </div>
  277. <div>
  278. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus">View.SetFocus()</a>
  279. </div>
  280. <div>
  281. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  282. </div>
  283. <div>
  284. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a>
  285. </div>
  286. <div>
  287. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  288. </div>
  289. <div>
  290. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  291. </div>
  292. <div>
  293. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  294. </div>
  295. <div>
  296. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  297. </div>
  298. <div>
  299. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  300. </div>
  301. <div>
  302. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  303. </div>
  304. <div>
  305. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  306. </div>
  307. <div>
  308. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  309. </div>
  310. <div>
  311. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  312. </div>
  313. <div>
  314. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  315. </div>
  316. <div>
  317. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  318. </div>
  319. <div>
  320. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStarted">View.LayoutStarted</a>
  321. </div>
  322. <div>
  323. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  324. </div>
  325. <div>
  326. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Initialized">View.Initialized</a>
  327. </div>
  328. <div>
  329. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  330. </div>
  331. <div>
  332. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">View.Text</a>
  333. </div>
  334. <div>
  335. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">View.TextAlignment</a>
  336. </div>
  337. <div>
  338. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsInitialized">View.IsInitialized</a>
  339. </div>
  340. <div>
  341. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  342. </div>
  343. <div>
  344. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  345. </div>
  346. <div>
  347. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  348. </div>
  349. <div>
  350. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  351. </div>
  352. <div>
  353. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseClick_Terminal_Gui_View_MouseEventArgs_">View.OnMouseClick(View.MouseEventArgs)</a>
  354. </div>
  355. <div>
  356. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Dispose_System_Boolean_">View.Dispose(Boolean)</a>
  357. </div>
  358. <div>
  359. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BeginInit">View.BeginInit()</a>
  360. </div>
  361. <div>
  362. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EndInit">View.EndInit()</a>
  363. </div>
  364. <div>
  365. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Visible">View.Visible</a>
  366. </div>
  367. <div>
  368. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
  369. </div>
  370. <div>
  371. <span class="xref">System.Object.Equals(System.Object)</span>
  372. </div>
  373. <div>
  374. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  375. </div>
  376. <div>
  377. <span class="xref">System.Object.GetHashCode()</span>
  378. </div>
  379. <div>
  380. <span class="xref">System.Object.GetType()</span>
  381. </div>
  382. <div>
  383. <span class="xref">System.Object.MemberwiseClone()</span>
  384. </div>
  385. <div>
  386. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  387. </div>
  388. </div>
  389. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  390. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  391. <h5 id="Terminal_Gui_ScrollBarView_syntax">Syntax</h5>
  392. <div class="codewrapper">
  393. <pre><code class="lang-csharp hljs">public class ScrollBarView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize</code></pre>
  394. </div>
  395. <h5 id="Terminal_Gui_ScrollBarView_remarks"><strong>Remarks</strong></h5>
  396. <div class="markdown level0 remarks">
  397. <p>
  398. The scrollbar is drawn to be a representation of the Size, assuming that the
  399. scroll position is set at Position.
  400. </p>
  401. <p>
  402. If the region to display the scrollbar is larger than three characters,
  403. arrow indicators are drawn.
  404. </p>
  405. </div>
  406. <h3 id="constructors">Constructors
  407. </h3>
  408. <a id="Terminal_Gui_ScrollBarView__ctor_" data-uid="Terminal.Gui.ScrollBarView.#ctor*"></a>
  409. <h4 id="Terminal_Gui_ScrollBarView__ctor" data-uid="Terminal.Gui.ScrollBarView.#ctor">ScrollBarView()</h4>
  410. <div class="markdown level1 summary">
  411. 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.
  412. </div>
  413. <div class="markdown level1 conceptual"></div>
  414. <h5 class="decalaration">Declaration</h5>
  415. <div class="codewrapper">
  416. <pre><code class="lang-csharp hljs">public ScrollBarView()</code></pre>
  417. </div>
  418. <a id="Terminal_Gui_ScrollBarView__ctor_" data-uid="Terminal.Gui.ScrollBarView.#ctor*"></a>
  419. <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>
  420. <div class="markdown level1 summary">
  421. 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.
  422. </div>
  423. <div class="markdown level1 conceptual"></div>
  424. <h5 class="decalaration">Declaration</h5>
  425. <div class="codewrapper">
  426. <pre><code class="lang-csharp hljs">public ScrollBarView(int size, int position, bool isVertical)</code></pre>
  427. </div>
  428. <h5 class="parameters">Parameters</h5>
  429. <table class="table table-bordered table-striped table-condensed">
  430. <thead>
  431. <tr>
  432. <th>Type</th>
  433. <th>Name</th>
  434. <th>Description</th>
  435. </tr>
  436. </thead>
  437. <tbody>
  438. <tr>
  439. <td><span class="xref">System.Int32</span></td>
  440. <td><span class="parametername">size</span></td>
  441. <td>The size that this scrollbar represents.</td>
  442. </tr>
  443. <tr>
  444. <td><span class="xref">System.Int32</span></td>
  445. <td><span class="parametername">position</span></td>
  446. <td>The position within this scrollbar.</td>
  447. </tr>
  448. <tr>
  449. <td><span class="xref">System.Boolean</span></td>
  450. <td><span class="parametername">isVertical</span></td>
  451. <td>If set to <code>true</code> this is a vertical scrollbar, otherwise, the scrollbar is horizontal.</td>
  452. </tr>
  453. </tbody>
  454. </table>
  455. <a id="Terminal_Gui_ScrollBarView__ctor_" data-uid="Terminal.Gui.ScrollBarView.#ctor*"></a>
  456. <h4 id="Terminal_Gui_ScrollBarView__ctor_Terminal_Gui_Rect_" data-uid="Terminal.Gui.ScrollBarView.#ctor(Terminal.Gui.Rect)">ScrollBarView(Rect)</h4>
  457. <div class="markdown level1 summary">
  458. 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.
  459. </div>
  460. <div class="markdown level1 conceptual"></div>
  461. <h5 class="decalaration">Declaration</h5>
  462. <div class="codewrapper">
  463. <pre><code class="lang-csharp hljs">public ScrollBarView(Rect rect)</code></pre>
  464. </div>
  465. <h5 class="parameters">Parameters</h5>
  466. <table class="table table-bordered table-striped table-condensed">
  467. <thead>
  468. <tr>
  469. <th>Type</th>
  470. <th>Name</th>
  471. <th>Description</th>
  472. </tr>
  473. </thead>
  474. <tbody>
  475. <tr>
  476. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  477. <td><span class="parametername">rect</span></td>
  478. <td>Frame for the scrollbar.</td>
  479. </tr>
  480. </tbody>
  481. </table>
  482. <a id="Terminal_Gui_ScrollBarView__ctor_" data-uid="Terminal.Gui.ScrollBarView.#ctor*"></a>
  483. <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>
  484. <div class="markdown level1 summary">
  485. 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.
  486. </div>
  487. <div class="markdown level1 conceptual"></div>
  488. <h5 class="decalaration">Declaration</h5>
  489. <div class="codewrapper">
  490. <pre><code class="lang-csharp hljs">public ScrollBarView(Rect rect, int size, int position, bool isVertical)</code></pre>
  491. </div>
  492. <h5 class="parameters">Parameters</h5>
  493. <table class="table table-bordered table-striped table-condensed">
  494. <thead>
  495. <tr>
  496. <th>Type</th>
  497. <th>Name</th>
  498. <th>Description</th>
  499. </tr>
  500. </thead>
  501. <tbody>
  502. <tr>
  503. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  504. <td><span class="parametername">rect</span></td>
  505. <td>Frame for the scrollbar.</td>
  506. </tr>
  507. <tr>
  508. <td><span class="xref">System.Int32</span></td>
  509. <td><span class="parametername">size</span></td>
  510. <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>
  511. </tr>
  512. <tr>
  513. <td><span class="xref">System.Int32</span></td>
  514. <td><span class="parametername">position</span></td>
  515. <td>The position within this scrollbar. Sets the <a class="xref" href="Terminal.Gui.ScrollBarView.html#Terminal_Gui_ScrollBarView_Position">Position</a> property.</td>
  516. </tr>
  517. <tr>
  518. <td><span class="xref">System.Boolean</span></td>
  519. <td><span class="parametername">isVertical</span></td>
  520. <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>
  521. </tr>
  522. </tbody>
  523. </table>
  524. <h3 id="properties">Properties
  525. </h3>
  526. <a id="Terminal_Gui_ScrollBarView_Host_" data-uid="Terminal.Gui.ScrollBarView.Host*"></a>
  527. <h4 id="Terminal_Gui_ScrollBarView_Host" data-uid="Terminal.Gui.ScrollBarView.Host">Host</h4>
  528. <div class="markdown level1 summary">
  529. Get or sets the view that host this <a class="xref" href="Terminal.Gui.ScrollView.html">ScrollView</a>
  530. </div>
  531. <div class="markdown level1 conceptual"></div>
  532. <h5 class="decalaration">Declaration</h5>
  533. <div class="codewrapper">
  534. <pre><code class="lang-csharp hljs">public ScrollView Host { get; }</code></pre>
  535. </div>
  536. <h5 class="propertyValue">Property Value</h5>
  537. <table class="table table-bordered table-striped table-condensed">
  538. <thead>
  539. <tr>
  540. <th>Type</th>
  541. <th>Description</th>
  542. </tr>
  543. </thead>
  544. <tbody>
  545. <tr>
  546. <td><a class="xref" href="Terminal.Gui.ScrollView.html">ScrollView</a></td>
  547. <td></td>
  548. </tr>
  549. </tbody>
  550. </table>
  551. <a id="Terminal_Gui_ScrollBarView_IsVertical_" data-uid="Terminal.Gui.ScrollBarView.IsVertical*"></a>
  552. <h4 id="Terminal_Gui_ScrollBarView_IsVertical" data-uid="Terminal.Gui.ScrollBarView.IsVertical">IsVertical</h4>
  553. <div class="markdown level1 summary">
  554. If set to <code>true</code> this is a vertical scrollbar, otherwise, the scrollbar is horizontal.
  555. </div>
  556. <div class="markdown level1 conceptual"></div>
  557. <h5 class="decalaration">Declaration</h5>
  558. <div class="codewrapper">
  559. <pre><code class="lang-csharp hljs">public bool IsVertical { get; set; }</code></pre>
  560. </div>
  561. <h5 class="propertyValue">Property Value</h5>
  562. <table class="table table-bordered table-striped table-condensed">
  563. <thead>
  564. <tr>
  565. <th>Type</th>
  566. <th>Description</th>
  567. </tr>
  568. </thead>
  569. <tbody>
  570. <tr>
  571. <td><span class="xref">System.Boolean</span></td>
  572. <td></td>
  573. </tr>
  574. </tbody>
  575. </table>
  576. <a id="Terminal_Gui_ScrollBarView_Position_" data-uid="Terminal.Gui.ScrollBarView.Position*"></a>
  577. <h4 id="Terminal_Gui_ScrollBarView_Position" data-uid="Terminal.Gui.ScrollBarView.Position">Position</h4>
  578. <div class="markdown level1 summary">
  579. The position, relative to <a class="xref" href="Terminal.Gui.ScrollBarView.html#Terminal_Gui_ScrollBarView_Size">Size</a>, to set the scrollbar at.
  580. </div>
  581. <div class="markdown level1 conceptual"></div>
  582. <h5 class="decalaration">Declaration</h5>
  583. <div class="codewrapper">
  584. <pre><code class="lang-csharp hljs">public int Position { get; set; }</code></pre>
  585. </div>
  586. <h5 class="propertyValue">Property Value</h5>
  587. <table class="table table-bordered table-striped table-condensed">
  588. <thead>
  589. <tr>
  590. <th>Type</th>
  591. <th>Description</th>
  592. </tr>
  593. </thead>
  594. <tbody>
  595. <tr>
  596. <td><span class="xref">System.Int32</span></td>
  597. <td>The position.</td>
  598. </tr>
  599. </tbody>
  600. </table>
  601. <a id="Terminal_Gui_ScrollBarView_Size_" data-uid="Terminal.Gui.ScrollBarView.Size*"></a>
  602. <h4 id="Terminal_Gui_ScrollBarView_Size" data-uid="Terminal.Gui.ScrollBarView.Size">Size</h4>
  603. <div class="markdown level1 summary">
  604. The size of content the scrollbar represents.
  605. </div>
  606. <div class="markdown level1 conceptual"></div>
  607. <h5 class="decalaration">Declaration</h5>
  608. <div class="codewrapper">
  609. <pre><code class="lang-csharp hljs">public int Size { get; set; }</code></pre>
  610. </div>
  611. <h5 class="propertyValue">Property Value</h5>
  612. <table class="table table-bordered table-striped table-condensed">
  613. <thead>
  614. <tr>
  615. <th>Type</th>
  616. <th>Description</th>
  617. </tr>
  618. </thead>
  619. <tbody>
  620. <tr>
  621. <td><span class="xref">System.Int32</span></td>
  622. <td>The size.</td>
  623. </tr>
  624. </tbody>
  625. </table>
  626. <h5 id="Terminal_Gui_ScrollBarView_Size_remarks">Remarks</h5>
  627. <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
  628. 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>
  629. <h3 id="methods">Methods
  630. </h3>
  631. <a id="Terminal_Gui_ScrollBarView_MouseEvent_" data-uid="Terminal.Gui.ScrollBarView.MouseEvent*"></a>
  632. <h4 id="Terminal_Gui_ScrollBarView_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.ScrollBarView.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  633. <div class="markdown level1 summary">
  634. Method invoked when a mouse event is generated
  635. </div>
  636. <div class="markdown level1 conceptual"></div>
  637. <h5 class="decalaration">Declaration</h5>
  638. <div class="codewrapper">
  639. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent me)</code></pre>
  640. </div>
  641. <h5 class="parameters">Parameters</h5>
  642. <table class="table table-bordered table-striped table-condensed">
  643. <thead>
  644. <tr>
  645. <th>Type</th>
  646. <th>Name</th>
  647. <th>Description</th>
  648. </tr>
  649. </thead>
  650. <tbody>
  651. <tr>
  652. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  653. <td><span class="parametername">me</span></td>
  654. <td></td>
  655. </tr>
  656. </tbody>
  657. </table>
  658. <h5 class="returns">Returns</h5>
  659. <table class="table table-bordered table-striped table-condensed">
  660. <thead>
  661. <tr>
  662. <th>Type</th>
  663. <th>Description</th>
  664. </tr>
  665. </thead>
  666. <tbody>
  667. <tr>
  668. <td><span class="xref">System.Boolean</span></td>
  669. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  670. </tr>
  671. </tbody>
  672. </table>
  673. <h5 class="overrides">Overrides</h5>
  674. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  675. <a id="Terminal_Gui_ScrollBarView_Redraw_" data-uid="Terminal.Gui.ScrollBarView.Redraw*"></a>
  676. <h4 id="Terminal_Gui_ScrollBarView_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.ScrollBarView.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  677. <div class="markdown level1 summary">
  678. Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
  679. </div>
  680. <div class="markdown level1 conceptual"></div>
  681. <h5 class="decalaration">Declaration</h5>
  682. <div class="codewrapper">
  683. <pre><code class="lang-csharp hljs">public override void Redraw(Rect region)</code></pre>
  684. </div>
  685. <h5 class="parameters">Parameters</h5>
  686. <table class="table table-bordered table-striped table-condensed">
  687. <thead>
  688. <tr>
  689. <th>Type</th>
  690. <th>Name</th>
  691. <th>Description</th>
  692. </tr>
  693. </thead>
  694. <tbody>
  695. <tr>
  696. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  697. <td><span class="parametername">region</span></td>
  698. <td></td>
  699. </tr>
  700. </tbody>
  701. </table>
  702. <h5 class="overrides">Overrides</h5>
  703. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  704. <h5 id="Terminal_Gui_ScrollBarView_Redraw_Terminal_Gui_Rect__remarks">Remarks</h5>
  705. <div class="markdown level1 remarks">
  706. <p>
  707. 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).
  708. </p>
  709. <p>
  710. Views should set the color that they want to use on entry, as otherwise this will inherit
  711. the last color that was set globally on the driver.
  712. </p>
  713. <p>
  714. 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
  715. larger than the <code>region</code> parameter.
  716. </p>
  717. </div>
  718. <h3 id="events">Events
  719. </h3>
  720. <h4 id="Terminal_Gui_ScrollBarView_ChangedPosition" data-uid="Terminal.Gui.ScrollBarView.ChangedPosition">ChangedPosition</h4>
  721. <div class="markdown level1 summary">
  722. This event is raised when the position on the scrollbar has changed.
  723. </div>
  724. <div class="markdown level1 conceptual"></div>
  725. <h5 class="decalaration">Declaration</h5>
  726. <div class="codewrapper">
  727. <pre><code class="lang-csharp hljs">public event Action ChangedPosition</code></pre>
  728. </div>
  729. <h5 class="eventType">Event Type</h5>
  730. <table class="table table-bordered table-striped table-condensed">
  731. <thead>
  732. <tr>
  733. <th>Type</th>
  734. <th>Description</th>
  735. </tr>
  736. </thead>
  737. <tbody>
  738. <tr>
  739. <td><span class="xref">System.Action</span></td>
  740. <td></td>
  741. </tr>
  742. </tbody>
  743. </table>
  744. <h3 id="implements">Implements</h3>
  745. <div>
  746. <span class="xref">System.IDisposable</span>
  747. </div>
  748. <div>
  749. <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
  750. </div>
  751. <div>
  752. <span class="xref">System.ComponentModel.ISupportInitialize</span>
  753. </div>
  754. </article>
  755. </div>
  756. <div class="hidden-sm col-md-2" role="complementary">
  757. <div class="sideaffix">
  758. <div class="contribution">
  759. <ul class="nav">
  760. </ul>
  761. </div>
  762. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  763. <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
  764. </nav>
  765. </div>
  766. </div>
  767. </div>
  768. </div>
  769. <footer>
  770. <div class="grad-bottom"></div>
  771. <div class="footer">
  772. <div class="container">
  773. <span class="pull-right">
  774. <a href="#top">Back to top</a>
  775. </span>
  776. <span>Generated by <strong>DocFX</strong></span>
  777. </div>
  778. </div>
  779. </footer>
  780. </div>
  781. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  782. <script type="text/javascript" src="../../styles/docfx.js"></script>
  783. <script type="text/javascript" src="../../styles/main.js"></script>
  784. </body>
  785. </html>