Terminal.Gui.ScrollBarView.html 48 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115
  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.59.3.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">Search Results for <span></span></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></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 class="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_GetMinWidthHeight_Terminal_Gui_Size__">View.GetMinWidthHeight(Size)</a>
  96. </div>
  97. <div>
  98. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetMinWidthHeight">View.SetMinWidthHeight()</a>
  99. </div>
  100. <div>
  101. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_UpdateTextFormatterText">View.UpdateTextFormatterText()</a>
  102. </div>
  103. <div>
  104. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessResizeView">View.ProcessResizeView()</a>
  105. </div>
  106. <div>
  107. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
  108. </div>
  109. <div>
  110. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearLayoutNeeded">View.ClearLayoutNeeded()</a>
  111. </div>
  112. <div>
  113. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
  114. </div>
  115. <div>
  116. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetChildNeedsDisplay">View.SetChildNeedsDisplay()</a>
  117. </div>
  118. <div>
  119. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
  120. </div>
  121. <div>
  122. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
  123. </div>
  124. <div>
  125. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
  126. </div>
  127. <div>
  128. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
  129. </div>
  130. <div>
  131. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
  132. </div>
  133. <div>
  134. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
  135. </div>
  136. <div>
  137. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
  138. </div>
  139. <div>
  140. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
  141. </div>
  142. <div>
  143. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
  144. </div>
  145. <div>
  146. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
  147. </div>
  148. <div>
  149. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
  150. </div>
  151. <div>
  152. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
  153. </div>
  154. <div>
  155. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
  156. </div>
  157. <div>
  158. <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>
  159. </div>
  160. <div>
  161. <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>
  162. </div>
  163. <div>
  164. <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>
  165. </div>
  166. <div>
  167. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_System_Boolean_">View.Move(Int32, Int32, Boolean)</a>
  168. </div>
  169. <div>
  170. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a>
  171. </div>
  172. <div>
  173. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnAdded_Terminal_Gui_View_">View.OnAdded(View)</a>
  174. </div>
  175. <div>
  176. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnRemoved_Terminal_Gui_View_">View.OnRemoved(View)</a>
  177. </div>
  178. <div>
  179. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave_Terminal_Gui_View_">View.OnLeave(View)</a>
  180. </div>
  181. <div>
  182. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
  183. </div>
  184. <div>
  185. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
  186. </div>
  187. <div>
  188. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
  189. </div>
  190. <div>
  191. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContentComplete_Terminal_Gui_Rect_">View.OnDrawContentComplete(Rect)</a>
  192. </div>
  193. <div>
  194. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus">View.SetFocus()</a>
  195. </div>
  196. <div>
  197. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a>
  198. </div>
  199. <div>
  200. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_InvokeKeybindings_Terminal_Gui_KeyEvent_">View.InvokeKeybindings(KeyEvent)</a>
  201. </div>
  202. <div>
  203. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddKeyBinding_Terminal_Gui_Key_Terminal_Gui_Command_">View.AddKeyBinding(Key, Command)</a>
  204. </div>
  205. <div>
  206. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ReplaceKeyBinding_Terminal_Gui_Key_Terminal_Gui_Key_">View.ReplaceKeyBinding(Key, Key)</a>
  207. </div>
  208. <div>
  209. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ContainsKeyBinding_Terminal_Gui_Key_">View.ContainsKeyBinding(Key)</a>
  210. </div>
  211. <div>
  212. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybindings">View.ClearKeybindings()</a>
  213. </div>
  214. <div>
  215. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Key_">View.ClearKeybinding(Key)</a>
  216. </div>
  217. <div>
  218. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearKeybinding_Terminal_Gui_Command_">View.ClearKeybinding(Command)</a>
  219. </div>
  220. <div>
  221. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddCommand_Terminal_Gui_Command_System_Func_System_Nullable_System_Boolean___">View.AddCommand(Command, Func&lt;Nullable&lt;Boolean&gt;&gt;)</a>
  222. </div>
  223. <div>
  224. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetSupportedCommands">View.GetSupportedCommands()</a>
  225. </div>
  226. <div>
  227. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetKeyFromCommand_Terminal_Gui_Command_">View.GetKeyFromCommand(Command)</a>
  228. </div>
  229. <div>
  230. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
  231. </div>
  232. <div>
  233. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
  234. </div>
  235. <div>
  236. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
  237. </div>
  238. <div>
  239. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
  240. </div>
  241. <div>
  242. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
  243. </div>
  244. <div>
  245. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
  246. </div>
  247. <div>
  248. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
  249. </div>
  250. <div>
  251. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
  252. </div>
  253. <div>
  254. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
  255. </div>
  256. <div>
  257. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
  258. </div>
  259. <div>
  260. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
  261. </div>
  262. <div>
  263. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetAutoSize">View.GetAutoSize()</a>
  264. </div>
  265. <div>
  266. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetHotKeySpecifierLength_System_Boolean_">View.GetHotKeySpecifierLength(Boolean)</a>
  267. </div>
  268. <div>
  269. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTextFormatterBoundsSize">View.GetTextFormatterBoundsSize()</a>
  270. </div>
  271. <div>
  272. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetBoundsTextFormatterSize">View.GetBoundsTextFormatterSize()</a>
  273. </div>
  274. <div>
  275. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
  276. </div>
  277. <div>
  278. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
  279. </div>
  280. <div>
  281. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
  282. </div>
  283. <div>
  284. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseClick_Terminal_Gui_View_MouseEventArgs_">View.OnMouseClick(View.MouseEventArgs)</a>
  285. </div>
  286. <div>
  287. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnCanFocusChanged">View.OnCanFocusChanged()</a>
  288. </div>
  289. <div>
  290. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnabledChanged">View.OnEnabledChanged()</a>
  291. </div>
  292. <div>
  293. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnVisibleChanged">View.OnVisibleChanged()</a>
  294. </div>
  295. <div>
  296. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Dispose_System_Boolean_">View.Dispose(Boolean)</a>
  297. </div>
  298. <div>
  299. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BeginInit">View.BeginInit()</a>
  300. </div>
  301. <div>
  302. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EndInit">View.EndInit()</a>
  303. </div>
  304. <div>
  305. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetWidth_System_Int32_System_Int32__">View.SetWidth(Int32, Int32)</a>
  306. </div>
  307. <div>
  308. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetHeight_System_Int32_System_Int32__">View.SetHeight(Int32, Int32)</a>
  309. </div>
  310. <div>
  311. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentWidth_System_Int32__">View.GetCurrentWidth(Int32)</a>
  312. </div>
  313. <div>
  314. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetCurrentHeight_System_Int32__">View.GetCurrentHeight(Int32)</a>
  315. </div>
  316. <div>
  317. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetNormalColor">View.GetNormalColor()</a>
  318. </div>
  319. <div>
  320. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetTopSuperView">View.GetTopSuperView()</a>
  321. </div>
  322. <div>
  323. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKey">View.HotKey</a>
  324. </div>
  325. <div>
  326. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeySpecifier">View.HotKeySpecifier</a>
  327. </div>
  328. <div>
  329. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Shortcut">View.Shortcut</a>
  330. </div>
  331. <div>
  332. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutTag">View.ShortcutTag</a>
  333. </div>
  334. <div>
  335. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ShortcutAction">View.ShortcutAction</a>
  336. </div>
  337. <div>
  338. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Data">View.Data</a>
  339. </div>
  340. <div>
  341. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
  342. </div>
  343. <div>
  344. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
  345. </div>
  346. <div>
  347. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndexes">View.TabIndexes</a>
  348. </div>
  349. <div>
  350. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabIndex">View.TabIndex</a>
  351. </div>
  352. <div>
  353. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TabStop">View.TabStop</a>
  354. </div>
  355. <div>
  356. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocus">View.CanFocus</a>
  357. </div>
  358. <div>
  359. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
  360. </div>
  361. <div>
  362. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
  363. </div>
  364. <div>
  365. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
  366. </div>
  367. <div>
  368. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
  369. </div>
  370. <div>
  371. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
  372. </div>
  373. <div>
  374. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
  375. </div>
  376. <div>
  377. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
  378. </div>
  379. <div>
  380. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
  381. </div>
  382. <div>
  383. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
  384. </div>
  385. <div>
  386. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
  387. </div>
  388. <div>
  389. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
  390. </div>
  391. <div>
  392. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ForceValidatePosDim">View.ForceValidatePosDim</a>
  393. </div>
  394. <div>
  395. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextFormatter">View.TextFormatter</a>
  396. </div>
  397. <div>
  398. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
  399. </div>
  400. <div>
  401. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
  402. </div>
  403. <div>
  404. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
  405. </div>
  406. <div>
  407. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
  408. </div>
  409. <div>
  410. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
  411. </div>
  412. <div>
  413. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Text">View.Text</a>
  414. </div>
  415. <div>
  416. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AutoSize">View.AutoSize</a>
  417. </div>
  418. <div>
  419. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PreserveTrailingSpaces">View.PreserveTrailingSpaces</a>
  420. </div>
  421. <div>
  422. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextAlignment">View.TextAlignment</a>
  423. </div>
  424. <div>
  425. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VerticalTextAlignment">View.VerticalTextAlignment</a>
  426. </div>
  427. <div>
  428. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_TextDirection">View.TextDirection</a>
  429. </div>
  430. <div>
  431. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsInitialized">View.IsInitialized</a>
  432. </div>
  433. <div>
  434. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsAdded">View.IsAdded</a>
  435. </div>
  436. <div>
  437. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enabled">View.Enabled</a>
  438. </div>
  439. <div>
  440. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Visible">View.Visible</a>
  441. </div>
  442. <div>
  443. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Border">View.Border</a>
  444. </div>
  445. <div>
  446. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Added">View.Added</a>
  447. </div>
  448. <div>
  449. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Removed">View.Removed</a>
  450. </div>
  451. <div>
  452. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
  453. </div>
  454. <div>
  455. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
  456. </div>
  457. <div>
  458. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
  459. </div>
  460. <div>
  461. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
  462. </div>
  463. <div>
  464. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
  465. </div>
  466. <div>
  467. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_CanFocusChanged">View.CanFocusChanged</a>
  468. </div>
  469. <div>
  470. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnabledChanged">View.EnabledChanged</a>
  471. </div>
  472. <div>
  473. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_VisibleChanged">View.VisibleChanged</a>
  474. </div>
  475. <div>
  476. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HotKeyChanged">View.HotKeyChanged</a>
  477. </div>
  478. <div>
  479. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
  480. </div>
  481. <div>
  482. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContentComplete">View.DrawContentComplete</a>
  483. </div>
  484. <div>
  485. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
  486. </div>
  487. <div>
  488. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
  489. </div>
  490. <div>
  491. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
  492. </div>
  493. <div>
  494. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStarted">View.LayoutStarted</a>
  495. </div>
  496. <div>
  497. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
  498. </div>
  499. <div>
  500. <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Initialized">View.Initialized</a>
  501. </div>
  502. <div>
  503. <a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_Dispose">Responder.Dispose()</a>
  504. </div>
  505. </div>
  506. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
  507. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  508. <h5 id="Terminal_Gui_ScrollBarView_syntax">Syntax</h5>
  509. <div class="codewrapper">
  510. <pre><code class="lang-csharp hljs">public class ScrollBarView : View</code></pre>
  511. </div>
  512. <h5 id="Terminal_Gui_ScrollBarView_remarks"><strong>Remarks</strong></h5>
  513. <div class="markdown level0 remarks">
  514. <p>
  515. The scrollbar is drawn to be a representation of the Size, assuming that the
  516. scroll position is set at Position.
  517. </p>
  518. <p>
  519. If the region to display the scrollbar is larger than three characters,
  520. arrow indicators are drawn.
  521. </p>
  522. </div>
  523. <h3 id="constructors">Constructors
  524. </h3>
  525. <a id="Terminal_Gui_ScrollBarView__ctor_" data-uid="Terminal.Gui.ScrollBarView.#ctor*"></a>
  526. <h4 id="Terminal_Gui_ScrollBarView__ctor" data-uid="Terminal.Gui.ScrollBarView.#ctor">ScrollBarView()</h4>
  527. <div class="markdown level1 summary">
  528. 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.
  529. </div>
  530. <div class="markdown level1 conceptual"></div>
  531. <h5 class="decalaration">Declaration</h5>
  532. <div class="codewrapper">
  533. <pre><code class="lang-csharp hljs">public ScrollBarView()</code></pre>
  534. </div>
  535. <a id="Terminal_Gui_ScrollBarView__ctor_" data-uid="Terminal.Gui.ScrollBarView.#ctor*"></a>
  536. <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>
  537. <div class="markdown level1 summary">
  538. 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.
  539. </div>
  540. <div class="markdown level1 conceptual"></div>
  541. <h5 class="decalaration">Declaration</h5>
  542. <div class="codewrapper">
  543. <pre><code class="lang-csharp hljs">public ScrollBarView(int size, int position, bool isVertical)</code></pre>
  544. </div>
  545. <h5 class="parameters">Parameters</h5>
  546. <table class="table table-bordered table-striped table-condensed">
  547. <thead>
  548. <tr>
  549. <th>Type</th>
  550. <th>Name</th>
  551. <th>Description</th>
  552. </tr>
  553. </thead>
  554. <tbody>
  555. <tr>
  556. <td><span class="xref">System.Int32</span></td>
  557. <td><span class="parametername">size</span></td>
  558. <td>The size that this scrollbar represents.</td>
  559. </tr>
  560. <tr>
  561. <td><span class="xref">System.Int32</span></td>
  562. <td><span class="parametername">position</span></td>
  563. <td>The position within this scrollbar.</td>
  564. </tr>
  565. <tr>
  566. <td><span class="xref">System.Boolean</span></td>
  567. <td><span class="parametername">isVertical</span></td>
  568. <td>If set to <code>true</code> this is a vertical scrollbar, otherwise, the scrollbar is horizontal.</td>
  569. </tr>
  570. </tbody>
  571. </table>
  572. <a id="Terminal_Gui_ScrollBarView__ctor_" data-uid="Terminal.Gui.ScrollBarView.#ctor*"></a>
  573. <h4 id="Terminal_Gui_ScrollBarView__ctor_Terminal_Gui_Rect_" data-uid="Terminal.Gui.ScrollBarView.#ctor(Terminal.Gui.Rect)">ScrollBarView(Rect)</h4>
  574. <div class="markdown level1 summary">
  575. 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.
  576. </div>
  577. <div class="markdown level1 conceptual"></div>
  578. <h5 class="decalaration">Declaration</h5>
  579. <div class="codewrapper">
  580. <pre><code class="lang-csharp hljs">public ScrollBarView(Rect rect)</code></pre>
  581. </div>
  582. <h5 class="parameters">Parameters</h5>
  583. <table class="table table-bordered table-striped table-condensed">
  584. <thead>
  585. <tr>
  586. <th>Type</th>
  587. <th>Name</th>
  588. <th>Description</th>
  589. </tr>
  590. </thead>
  591. <tbody>
  592. <tr>
  593. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  594. <td><span class="parametername">rect</span></td>
  595. <td>Frame for the scrollbar.</td>
  596. </tr>
  597. </tbody>
  598. </table>
  599. <a id="Terminal_Gui_ScrollBarView__ctor_" data-uid="Terminal.Gui.ScrollBarView.#ctor*"></a>
  600. <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>
  601. <div class="markdown level1 summary">
  602. 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.
  603. </div>
  604. <div class="markdown level1 conceptual"></div>
  605. <h5 class="decalaration">Declaration</h5>
  606. <div class="codewrapper">
  607. <pre><code class="lang-csharp hljs">public ScrollBarView(Rect rect, int size, int position, bool isVertical)</code></pre>
  608. </div>
  609. <h5 class="parameters">Parameters</h5>
  610. <table class="table table-bordered table-striped table-condensed">
  611. <thead>
  612. <tr>
  613. <th>Type</th>
  614. <th>Name</th>
  615. <th>Description</th>
  616. </tr>
  617. </thead>
  618. <tbody>
  619. <tr>
  620. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  621. <td><span class="parametername">rect</span></td>
  622. <td>Frame for the scrollbar.</td>
  623. </tr>
  624. <tr>
  625. <td><span class="xref">System.Int32</span></td>
  626. <td><span class="parametername">size</span></td>
  627. <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>
  628. </tr>
  629. <tr>
  630. <td><span class="xref">System.Int32</span></td>
  631. <td><span class="parametername">position</span></td>
  632. <td>The position within this scrollbar. Sets the <a class="xref" href="Terminal.Gui.ScrollBarView.html#Terminal_Gui_ScrollBarView_Position">Position</a> property.</td>
  633. </tr>
  634. <tr>
  635. <td><span class="xref">System.Boolean</span></td>
  636. <td><span class="parametername">isVertical</span></td>
  637. <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>
  638. </tr>
  639. </tbody>
  640. </table>
  641. <a id="Terminal_Gui_ScrollBarView__ctor_" data-uid="Terminal.Gui.ScrollBarView.#ctor*"></a>
  642. <h4 id="Terminal_Gui_ScrollBarView__ctor_Terminal_Gui_View_System_Boolean_System_Boolean_" data-uid="Terminal.Gui.ScrollBarView.#ctor(Terminal.Gui.View,System.Boolean,System.Boolean)">ScrollBarView(View, Boolean, Boolean)</h4>
  643. <div class="markdown level1 summary">
  644. 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.
  645. </div>
  646. <div class="markdown level1 conceptual"></div>
  647. <h5 class="decalaration">Declaration</h5>
  648. <div class="codewrapper">
  649. <pre><code class="lang-csharp hljs">public ScrollBarView(View host, bool isVertical, bool showBothScrollIndicator = true)</code></pre>
  650. </div>
  651. <h5 class="parameters">Parameters</h5>
  652. <table class="table table-bordered table-striped table-condensed">
  653. <thead>
  654. <tr>
  655. <th>Type</th>
  656. <th>Name</th>
  657. <th>Description</th>
  658. </tr>
  659. </thead>
  660. <tbody>
  661. <tr>
  662. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  663. <td><span class="parametername">host</span></td>
  664. <td>The view that will host this scrollbar.</td>
  665. </tr>
  666. <tr>
  667. <td><span class="xref">System.Boolean</span></td>
  668. <td><span class="parametername">isVertical</span></td>
  669. <td>If set to <code>true</code> this is a vertical scrollbar, otherwise, the scrollbar is horizontal.</td>
  670. </tr>
  671. <tr>
  672. <td><span class="xref">System.Boolean</span></td>
  673. <td><span class="parametername">showBothScrollIndicator</span></td>
  674. <td>If set to <code>true (default)</code> will have the other scrollbar, otherwise will have only one.</td>
  675. </tr>
  676. </tbody>
  677. </table>
  678. <h3 id="properties">Properties
  679. </h3>
  680. <a id="Terminal_Gui_ScrollBarView_AutoHideScrollBars_" data-uid="Terminal.Gui.ScrollBarView.AutoHideScrollBars*"></a>
  681. <h4 id="Terminal_Gui_ScrollBarView_AutoHideScrollBars" data-uid="Terminal.Gui.ScrollBarView.AutoHideScrollBars">AutoHideScrollBars</h4>
  682. <div class="markdown level1 summary">
  683. If true the vertical/horizontal scroll bars won&apos;t be showed if it&apos;s not needed.
  684. </div>
  685. <div class="markdown level1 conceptual"></div>
  686. <h5 class="decalaration">Declaration</h5>
  687. <div class="codewrapper">
  688. <pre><code class="lang-csharp hljs">public bool AutoHideScrollBars { get; set; }</code></pre>
  689. </div>
  690. <h5 class="propertyValue">Property Value</h5>
  691. <table class="table table-bordered table-striped table-condensed">
  692. <thead>
  693. <tr>
  694. <th>Type</th>
  695. <th>Description</th>
  696. </tr>
  697. </thead>
  698. <tbody>
  699. <tr>
  700. <td><span class="xref">System.Boolean</span></td>
  701. <td></td>
  702. </tr>
  703. </tbody>
  704. </table>
  705. <a id="Terminal_Gui_ScrollBarView_Host_" data-uid="Terminal.Gui.ScrollBarView.Host*"></a>
  706. <h4 id="Terminal_Gui_ScrollBarView_Host" data-uid="Terminal.Gui.ScrollBarView.Host">Host</h4>
  707. <div class="markdown level1 summary">
  708. Get or sets the view that host this <a class="xref" href="Terminal.Gui.View.html">View</a>
  709. </div>
  710. <div class="markdown level1 conceptual"></div>
  711. <h5 class="decalaration">Declaration</h5>
  712. <div class="codewrapper">
  713. <pre><code class="lang-csharp hljs">public View Host { get; }</code></pre>
  714. </div>
  715. <h5 class="propertyValue">Property Value</h5>
  716. <table class="table table-bordered table-striped table-condensed">
  717. <thead>
  718. <tr>
  719. <th>Type</th>
  720. <th>Description</th>
  721. </tr>
  722. </thead>
  723. <tbody>
  724. <tr>
  725. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  726. <td></td>
  727. </tr>
  728. </tbody>
  729. </table>
  730. <a id="Terminal_Gui_ScrollBarView_IsVertical_" data-uid="Terminal.Gui.ScrollBarView.IsVertical*"></a>
  731. <h4 id="Terminal_Gui_ScrollBarView_IsVertical" data-uid="Terminal.Gui.ScrollBarView.IsVertical">IsVertical</h4>
  732. <div class="markdown level1 summary">
  733. If set to <code>true</code> this is a vertical scrollbar, otherwise, the scrollbar is horizontal.
  734. </div>
  735. <div class="markdown level1 conceptual"></div>
  736. <h5 class="decalaration">Declaration</h5>
  737. <div class="codewrapper">
  738. <pre><code class="lang-csharp hljs">public bool IsVertical { get; set; }</code></pre>
  739. </div>
  740. <h5 class="propertyValue">Property Value</h5>
  741. <table class="table table-bordered table-striped table-condensed">
  742. <thead>
  743. <tr>
  744. <th>Type</th>
  745. <th>Description</th>
  746. </tr>
  747. </thead>
  748. <tbody>
  749. <tr>
  750. <td><span class="xref">System.Boolean</span></td>
  751. <td></td>
  752. </tr>
  753. </tbody>
  754. </table>
  755. <a id="Terminal_Gui_ScrollBarView_KeepContentAlwaysInViewport_" data-uid="Terminal.Gui.ScrollBarView.KeepContentAlwaysInViewport*"></a>
  756. <h4 id="Terminal_Gui_ScrollBarView_KeepContentAlwaysInViewport" data-uid="Terminal.Gui.ScrollBarView.KeepContentAlwaysInViewport">KeepContentAlwaysInViewport</h4>
  757. <div class="markdown level1 summary">
  758. Get or sets if the view-port is kept always visible in the area of this <a class="xref" href="Terminal.Gui.ScrollBarView.html">ScrollBarView</a>
  759. </div>
  760. <div class="markdown level1 conceptual"></div>
  761. <h5 class="decalaration">Declaration</h5>
  762. <div class="codewrapper">
  763. <pre><code class="lang-csharp hljs">public bool KeepContentAlwaysInViewport { get; set; }</code></pre>
  764. </div>
  765. <h5 class="propertyValue">Property Value</h5>
  766. <table class="table table-bordered table-striped table-condensed">
  767. <thead>
  768. <tr>
  769. <th>Type</th>
  770. <th>Description</th>
  771. </tr>
  772. </thead>
  773. <tbody>
  774. <tr>
  775. <td><span class="xref">System.Boolean</span></td>
  776. <td></td>
  777. </tr>
  778. </tbody>
  779. </table>
  780. <a id="Terminal_Gui_ScrollBarView_OtherScrollBarView_" data-uid="Terminal.Gui.ScrollBarView.OtherScrollBarView*"></a>
  781. <h4 id="Terminal_Gui_ScrollBarView_OtherScrollBarView" data-uid="Terminal.Gui.ScrollBarView.OtherScrollBarView">OtherScrollBarView</h4>
  782. <div class="markdown level1 summary">
  783. Represent a vertical or horizontal ScrollBarView other than this.
  784. </div>
  785. <div class="markdown level1 conceptual"></div>
  786. <h5 class="decalaration">Declaration</h5>
  787. <div class="codewrapper">
  788. <pre><code class="lang-csharp hljs">public ScrollBarView OtherScrollBarView { get; set; }</code></pre>
  789. </div>
  790. <h5 class="propertyValue">Property Value</h5>
  791. <table class="table table-bordered table-striped table-condensed">
  792. <thead>
  793. <tr>
  794. <th>Type</th>
  795. <th>Description</th>
  796. </tr>
  797. </thead>
  798. <tbody>
  799. <tr>
  800. <td><a class="xref" href="Terminal.Gui.ScrollBarView.html">ScrollBarView</a></td>
  801. <td></td>
  802. </tr>
  803. </tbody>
  804. </table>
  805. <a id="Terminal_Gui_ScrollBarView_Position_" data-uid="Terminal.Gui.ScrollBarView.Position*"></a>
  806. <h4 id="Terminal_Gui_ScrollBarView_Position" data-uid="Terminal.Gui.ScrollBarView.Position">Position</h4>
  807. <div class="markdown level1 summary">
  808. The position, relative to <a class="xref" href="Terminal.Gui.ScrollBarView.html#Terminal_Gui_ScrollBarView_Size">Size</a>, to set the scrollbar at.
  809. </div>
  810. <div class="markdown level1 conceptual"></div>
  811. <h5 class="decalaration">Declaration</h5>
  812. <div class="codewrapper">
  813. <pre><code class="lang-csharp hljs">public int Position { get; set; }</code></pre>
  814. </div>
  815. <h5 class="propertyValue">Property Value</h5>
  816. <table class="table table-bordered table-striped table-condensed">
  817. <thead>
  818. <tr>
  819. <th>Type</th>
  820. <th>Description</th>
  821. </tr>
  822. </thead>
  823. <tbody>
  824. <tr>
  825. <td><span class="xref">System.Int32</span></td>
  826. <td>The position.</td>
  827. </tr>
  828. </tbody>
  829. </table>
  830. <a id="Terminal_Gui_ScrollBarView_ShowScrollIndicator_" data-uid="Terminal.Gui.ScrollBarView.ShowScrollIndicator*"></a>
  831. <h4 id="Terminal_Gui_ScrollBarView_ShowScrollIndicator" data-uid="Terminal.Gui.ScrollBarView.ShowScrollIndicator">ShowScrollIndicator</h4>
  832. <div class="markdown level1 summary">
  833. Gets or sets the visibility for the vertical or horizontal scroll indicator.
  834. </div>
  835. <div class="markdown level1 conceptual"></div>
  836. <h5 class="decalaration">Declaration</h5>
  837. <div class="codewrapper">
  838. <pre><code class="lang-csharp hljs">public bool ShowScrollIndicator { get; set; }</code></pre>
  839. </div>
  840. <h5 class="propertyValue">Property Value</h5>
  841. <table class="table table-bordered table-striped table-condensed">
  842. <thead>
  843. <tr>
  844. <th>Type</th>
  845. <th>Description</th>
  846. </tr>
  847. </thead>
  848. <tbody>
  849. <tr>
  850. <td><span class="xref">System.Boolean</span></td>
  851. <td><code>true</code> if show vertical or horizontal scroll indicator; otherwise, <code>false</code>.</td>
  852. </tr>
  853. </tbody>
  854. </table>
  855. <a id="Terminal_Gui_ScrollBarView_Size_" data-uid="Terminal.Gui.ScrollBarView.Size*"></a>
  856. <h4 id="Terminal_Gui_ScrollBarView_Size" data-uid="Terminal.Gui.ScrollBarView.Size">Size</h4>
  857. <div class="markdown level1 summary">
  858. The size of content the scrollbar represents.
  859. </div>
  860. <div class="markdown level1 conceptual"></div>
  861. <h5 class="decalaration">Declaration</h5>
  862. <div class="codewrapper">
  863. <pre><code class="lang-csharp hljs">public int Size { get; set; }</code></pre>
  864. </div>
  865. <h5 class="propertyValue">Property Value</h5>
  866. <table class="table table-bordered table-striped table-condensed">
  867. <thead>
  868. <tr>
  869. <th>Type</th>
  870. <th>Description</th>
  871. </tr>
  872. </thead>
  873. <tbody>
  874. <tr>
  875. <td><span class="xref">System.Int32</span></td>
  876. <td>The size.</td>
  877. </tr>
  878. </tbody>
  879. </table>
  880. <h5 id="Terminal_Gui_ScrollBarView_Size_remarks">Remarks</h5>
  881. <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
  882. part of a <a class="xref" href="Terminal.Gui.View.html">View</a> the Size is set to the appropriate dimension of <a class="xref" href="Terminal.Gui.ScrollBarView.html#Terminal_Gui_ScrollBarView_Host">Host</a>.</div>
  883. <h3 id="methods">Methods
  884. </h3>
  885. <a id="Terminal_Gui_ScrollBarView_MouseEvent_" data-uid="Terminal.Gui.ScrollBarView.MouseEvent*"></a>
  886. <h4 id="Terminal_Gui_ScrollBarView_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.ScrollBarView.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
  887. <div class="markdown level1 summary">
  888. Method invoked when a mouse event is generated
  889. </div>
  890. <div class="markdown level1 conceptual"></div>
  891. <h5 class="decalaration">Declaration</h5>
  892. <div class="codewrapper">
  893. <pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent me)</code></pre>
  894. </div>
  895. <h5 class="parameters">Parameters</h5>
  896. <table class="table table-bordered table-striped table-condensed">
  897. <thead>
  898. <tr>
  899. <th>Type</th>
  900. <th>Name</th>
  901. <th>Description</th>
  902. </tr>
  903. </thead>
  904. <tbody>
  905. <tr>
  906. <td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
  907. <td><span class="parametername">me</span></td>
  908. <td></td>
  909. </tr>
  910. </tbody>
  911. </table>
  912. <h5 class="returns">Returns</h5>
  913. <table class="table table-bordered table-striped table-condensed">
  914. <thead>
  915. <tr>
  916. <th>Type</th>
  917. <th>Description</th>
  918. </tr>
  919. </thead>
  920. <tbody>
  921. <tr>
  922. <td><span class="xref">System.Boolean</span></td>
  923. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  924. </tr>
  925. </tbody>
  926. </table>
  927. <h5 class="overrides">Overrides</h5>
  928. <div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
  929. <a id="Terminal_Gui_ScrollBarView_OnChangedPosition_" data-uid="Terminal.Gui.ScrollBarView.OnChangedPosition*"></a>
  930. <h4 id="Terminal_Gui_ScrollBarView_OnChangedPosition" data-uid="Terminal.Gui.ScrollBarView.OnChangedPosition">OnChangedPosition()</h4>
  931. <div class="markdown level1 summary">
  932. Virtual method to invoke the <a class="xref" href="Terminal.Gui.ScrollBarView.html#Terminal_Gui_ScrollBarView_ChangedPosition">ChangedPosition</a> action event.
  933. </div>
  934. <div class="markdown level1 conceptual"></div>
  935. <h5 class="decalaration">Declaration</h5>
  936. <div class="codewrapper">
  937. <pre><code class="lang-csharp hljs">public virtual void OnChangedPosition()</code></pre>
  938. </div>
  939. <a id="Terminal_Gui_ScrollBarView_OnEnter_" data-uid="Terminal.Gui.ScrollBarView.OnEnter*"></a>
  940. <h4 id="Terminal_Gui_ScrollBarView_OnEnter_Terminal_Gui_View_" data-uid="Terminal.Gui.ScrollBarView.OnEnter(Terminal.Gui.View)">OnEnter(View)</h4>
  941. <div class="markdown level1 summary">
  942. Method invoked when a view gets focus.
  943. </div>
  944. <div class="markdown level1 conceptual"></div>
  945. <h5 class="decalaration">Declaration</h5>
  946. <div class="codewrapper">
  947. <pre><code class="lang-csharp hljs">public override bool OnEnter(View view)</code></pre>
  948. </div>
  949. <h5 class="parameters">Parameters</h5>
  950. <table class="table table-bordered table-striped table-condensed">
  951. <thead>
  952. <tr>
  953. <th>Type</th>
  954. <th>Name</th>
  955. <th>Description</th>
  956. </tr>
  957. </thead>
  958. <tbody>
  959. <tr>
  960. <td><a class="xref" href="Terminal.Gui.View.html">View</a></td>
  961. <td><span class="parametername">view</span></td>
  962. <td>The view that is losing focus.</td>
  963. </tr>
  964. </tbody>
  965. </table>
  966. <h5 class="returns">Returns</h5>
  967. <table class="table table-bordered table-striped table-condensed">
  968. <thead>
  969. <tr>
  970. <th>Type</th>
  971. <th>Description</th>
  972. </tr>
  973. </thead>
  974. <tbody>
  975. <tr>
  976. <td><span class="xref">System.Boolean</span></td>
  977. <td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
  978. </tr>
  979. </tbody>
  980. </table>
  981. <h5 class="overrides">Overrides</h5>
  982. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter_Terminal_Gui_View_">View.OnEnter(View)</a></div>
  983. <a id="Terminal_Gui_ScrollBarView_Redraw_" data-uid="Terminal.Gui.ScrollBarView.Redraw*"></a>
  984. <h4 id="Terminal_Gui_ScrollBarView_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.ScrollBarView.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
  985. <div class="markdown level1 summary">
  986. Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
  987. </div>
  988. <div class="markdown level1 conceptual"></div>
  989. <h5 class="decalaration">Declaration</h5>
  990. <div class="codewrapper">
  991. <pre><code class="lang-csharp hljs">public override void Redraw(Rect region)</code></pre>
  992. </div>
  993. <h5 class="parameters">Parameters</h5>
  994. <table class="table table-bordered table-striped table-condensed">
  995. <thead>
  996. <tr>
  997. <th>Type</th>
  998. <th>Name</th>
  999. <th>Description</th>
  1000. </tr>
  1001. </thead>
  1002. <tbody>
  1003. <tr>
  1004. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  1005. <td><span class="parametername">region</span></td>
  1006. <td></td>
  1007. </tr>
  1008. </tbody>
  1009. </table>
  1010. <h5 class="overrides">Overrides</h5>
  1011. <div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
  1012. <h5 id="Terminal_Gui_ScrollBarView_Redraw_Terminal_Gui_Rect__remarks">Remarks</h5>
  1013. <div class="markdown level1 remarks">
  1014. <p>
  1015. 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).
  1016. </p>
  1017. <p>
  1018. Views should set the color that they want to use on entry, as otherwise this will inherit
  1019. the last color that was set globally on the driver.
  1020. </p>
  1021. <p>
  1022. 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
  1023. larger than the <code>region</code> parameter.
  1024. </p>
  1025. </div>
  1026. <a id="Terminal_Gui_ScrollBarView_Refresh_" data-uid="Terminal.Gui.ScrollBarView.Refresh*"></a>
  1027. <h4 id="Terminal_Gui_ScrollBarView_Refresh" data-uid="Terminal.Gui.ScrollBarView.Refresh">Refresh()</h4>
  1028. <div class="markdown level1 summary">
  1029. Only used for a hosted view that will update and redraw the scrollbars.
  1030. </div>
  1031. <div class="markdown level1 conceptual"></div>
  1032. <h5 class="decalaration">Declaration</h5>
  1033. <div class="codewrapper">
  1034. <pre><code class="lang-csharp hljs">public virtual void Refresh()</code></pre>
  1035. </div>
  1036. <h3 id="events">Events
  1037. </h3>
  1038. <h4 id="Terminal_Gui_ScrollBarView_ChangedPosition" data-uid="Terminal.Gui.ScrollBarView.ChangedPosition">ChangedPosition</h4>
  1039. <div class="markdown level1 summary">
  1040. This event is raised when the position on the scrollbar has changed.
  1041. </div>
  1042. <div class="markdown level1 conceptual"></div>
  1043. <h5 class="decalaration">Declaration</h5>
  1044. <div class="codewrapper">
  1045. <pre><code class="lang-csharp hljs">public event Action ChangedPosition</code></pre>
  1046. </div>
  1047. <h5 class="eventType">Event Type</h5>
  1048. <table class="table table-bordered table-striped table-condensed">
  1049. <thead>
  1050. <tr>
  1051. <th>Type</th>
  1052. <th>Description</th>
  1053. </tr>
  1054. </thead>
  1055. <tbody>
  1056. <tr>
  1057. <td><span class="xref">System.Action</span></td>
  1058. <td></td>
  1059. </tr>
  1060. </tbody>
  1061. </table>
  1062. <h3 id="implements">Implements</h3>
  1063. <div>
  1064. <span class="xref">System.IDisposable</span>
  1065. </div>
  1066. <div>
  1067. <span class="xref">System.ComponentModel.ISupportInitializeNotification</span>
  1068. </div>
  1069. <div>
  1070. <span class="xref">System.ComponentModel.ISupportInitialize</span>
  1071. </div>
  1072. </article>
  1073. </div>
  1074. <div class="hidden-sm col-md-2" role="complementary">
  1075. <div class="sideaffix">
  1076. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  1077. <h5>In This Article</h5>
  1078. <div></div>
  1079. </nav>
  1080. </div>
  1081. </div>
  1082. </div>
  1083. </div>
  1084. <footer>
  1085. <div class="grad-bottom"></div>
  1086. <div class="footer">
  1087. <div class="container">
  1088. <span class="pull-right">
  1089. <a href="#top">Back to top</a>
  1090. </span>
  1091. <span>Generated by <strong>DocFX</strong></span>
  1092. </div>
  1093. </div>
  1094. </footer>
  1095. </div>
  1096. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  1097. <script type="text/javascript" src="../../styles/docfx.js"></script>
  1098. <script type="text/javascript" src="../../styles/main.js"></script>
  1099. </body>
  1100. </html>