Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2025-12-28 08:47:59 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
cf6bb2a9ec56c90c024c79d66602f6a41009b90b
Terminal.Gui/docs/api/Terminal.Gui/Terminal.Gui.ScrollBarView.html

728 lines
30 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class ScrollBarView
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class ScrollBarView
">
<meta name="generator" content="docfx 2.54.0.0">
<link rel="shortcut icon" href="../../favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../../">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">
<img id="logo" class="svg" src="../../images/logo48.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Terminal.Gui.ScrollBarView">
<h1 id="Terminal_Gui_ScrollBarView" data-uid="Terminal.Gui.ScrollBarView" class="text-break">Class ScrollBarView
</h1>
<div class="markdown level0 summary">
ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><a class="xref" href="Terminal.Gui.Responder.html">Responder</a></div>
<div class="level2"><a class="xref" href="Terminal.Gui.View.html">View</a></div>
<div class="level3"><span class="xref">ScrollBarView</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">System.Collections.IEnumerable</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Enter">View.Enter</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Leave">View.Leave</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseEnter">View.MouseEnter</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseLeave">View.MouseLeave</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MouseClick">View.MouseClick</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">View.Driver</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Subviews">View.Subviews</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Id">View.Id</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_IsCurrentTop">View.IsCurrentTop</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantMousePositionReports">View.WantMousePositionReports</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_WantContinuousButtonPressed">View.WantContinuousButtonPressed</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Frame">View.Frame</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_GetEnumerator">View.GetEnumerator()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutStyle">View.LayoutStyle</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">View.Bounds</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_X">View.X</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Y">View.Y</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Width">View.Width</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Height">View.Height</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SuperView">View.SuperView</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay">View.SetNeedsDisplay()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetNeedsDisplay_Terminal_Gui_Rect_">View.SetNeedsDisplay(Rect)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ChildNeedsDisplay">View.ChildNeedsDisplay()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View_">View.Add(View)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Add_Terminal_Gui_View___">View.Add(View[])</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_RemoveAll">View.RemoveAll()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Remove_Terminal_Gui_View_">View.Remove(View)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewToFront_Terminal_Gui_View_">View.BringSubviewToFront(View)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewToBack_Terminal_Gui_View_">View.SendSubviewToBack(View)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SendSubviewBackwards_Terminal_Gui_View_">View.SendSubviewBackwards(View)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_BringSubviewForward_Terminal_Gui_View_">View.BringSubviewForward(View)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear">View.Clear()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Clear_Terminal_Gui_Rect_">View.Clear(Rect)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ScreenToView_System_Int32_System_Int32_">View.ScreenToView(Int32, Int32)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClipToBounds">View.ClipToBounds()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetClip_Terminal_Gui_Rect_">View.SetClip(Rect)</a>
</div>
<div>
<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>
</div>
<div>
<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>
</div>
<div>
<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>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Move_System_Int32_System_Int32_">View.Move(Int32, Int32)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_PositionCursor">View.PositionCursor()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_HasFocus">View.HasFocus</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnEnter">View.OnEnter()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnLeave">View.OnLeave()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Focused">View.Focused</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_MostFocused">View.MostFocused</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ColorScheme">View.ColorScheme</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_AddRune_System_Int32_System_Int32_System_Rune_">View.AddRune(Int32, Int32, Rune)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ClearNeedsDisplay">View.ClearNeedsDisplay()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_DrawContent">View.DrawContent</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnDrawContent_Terminal_Gui_Rect_">View.OnDrawContent(Rect)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_SetFocus_Terminal_Gui_View_">View.SetFocus(View)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyPress">View.KeyPress</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessKey_Terminal_Gui_KeyEvent_">View.ProcessKey(KeyEvent)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessHotKey_Terminal_Gui_KeyEvent_">View.ProcessHotKey(KeyEvent)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ProcessColdKey_Terminal_Gui_KeyEvent_">View.ProcessColdKey(KeyEvent)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyDown">View.KeyDown</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyDown_Terminal_Gui_KeyEvent_">View.OnKeyDown(KeyEvent)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_KeyUp">View.KeyUp</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnKeyUp_Terminal_Gui_KeyEvent_">View.OnKeyUp(KeyEvent)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_EnsureFocus">View.EnsureFocus()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusFirst">View.FocusFirst()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusLast">View.FocusLast()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusPrev">View.FocusPrev()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_FocusNext">View.FocusNext()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutComplete">View.LayoutComplete</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_LayoutSubviews">View.LayoutSubviews()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_ToString">View.ToString()</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEnter_Terminal_Gui_MouseEvent_">View.OnMouseEnter(MouseEvent)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseLeave_Terminal_Gui_MouseEvent_">View.OnMouseLeave(MouseEvent)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_OnMouseEvent_Terminal_Gui_MouseEvent_">View.OnMouseEvent(MouseEvent)</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_CanFocus">Responder.CanFocus</a>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.html">Terminal.Gui</a></h6>
<h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
<h5 id="Terminal_Gui_ScrollBarView_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class ScrollBarView : View, IEnumerable</code></pre>
</div>
<h5 id="Terminal_Gui_ScrollBarView_remarks"><strong>Remarks</strong></h5>
<div class="markdown level0 remarks">
<p>
The scrollbar is drawn to be a representation of the Size, assuming that the
scroll position is set at Position.
</p>
<p>
If the region to display the scrollbar is larger than three characters,
arrow indicators are drawn.
</p>
</div>
<h3 id="constructors">Constructors
</h3>
<a id="Terminal_Gui_ScrollBarView__ctor_" data-uid="Terminal.Gui.ScrollBarView.#ctor*"></a>
<h4 id="Terminal_Gui_ScrollBarView__ctor" data-uid="Terminal.Gui.ScrollBarView.#ctor">ScrollBarView()</h4>
<div class="markdown level1 summary">
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.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ScrollBarView()</code></pre>
</div>
<a id="Terminal_Gui_ScrollBarView__ctor_" data-uid="Terminal.Gui.ScrollBarView.#ctor*"></a>
<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>
<div class="markdown level1 summary">
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.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ScrollBarView(int size, int position, bool isVertical)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">size</span></td>
<td>The size that this scrollbar represents.</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">position</span></td>
<td>The position within this scrollbar.</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">isVertical</span></td>
<td>If set to <code>true</code> this is a vertical scrollbar, otherwise, the scrollbar is horizontal.</td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_ScrollBarView__ctor_" data-uid="Terminal.Gui.ScrollBarView.#ctor*"></a>
<h4 id="Terminal_Gui_ScrollBarView__ctor_Terminal_Gui_Rect_" data-uid="Terminal.Gui.ScrollBarView.#ctor(Terminal.Gui.Rect)">ScrollBarView(Rect)</h4>
<div class="markdown level1 summary">
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.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ScrollBarView(Rect rect)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
<td><span class="parametername">rect</span></td>
<td>Frame for the scrollbar.</td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_ScrollBarView__ctor_" data-uid="Terminal.Gui.ScrollBarView.#ctor*"></a>
<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>
<div class="markdown level1 summary">
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.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public ScrollBarView(Rect rect, int size, int position, bool isVertical)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
<td><span class="parametername">rect</span></td>
<td>Frame for the scrollbar.</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">size</span></td>
<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>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">position</span></td>
<td>The position within this scrollbar. Sets the <a class="xref" href="Terminal.Gui.ScrollBarView.html#Terminal_Gui_ScrollBarView_Position">Position</a> property.</td>
</tr>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">isVertical</span></td>
<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>
</tr>
</tbody>
</table>
<h3 id="fields">Fields
</h3>
<h4 id="Terminal_Gui_ScrollBarView_ChangedPosition" data-uid="Terminal.Gui.ScrollBarView.ChangedPosition">ChangedPosition</h4>
<div class="markdown level1 summary">
This event is raised when the position on the scrollbar has changed.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Action ChangedPosition</code></pre>
</div>
<h5 class="fieldValue">Field Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Action</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<a id="Terminal_Gui_ScrollBarView_IsVertical_" data-uid="Terminal.Gui.ScrollBarView.IsVertical*"></a>
<h4 id="Terminal_Gui_ScrollBarView_IsVertical" data-uid="Terminal.Gui.ScrollBarView.IsVertical">IsVertical</h4>
<div class="markdown level1 summary">
If set to <code>true</code> this is a vertical scrollbar, otherwise, the scrollbar is horizontal.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsVertical { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_ScrollBarView_Position_" data-uid="Terminal.Gui.ScrollBarView.Position*"></a>
<h4 id="Terminal_Gui_ScrollBarView_Position" data-uid="Terminal.Gui.ScrollBarView.Position">Position</h4>
<div class="markdown level1 summary">
The position, relative to <a class="xref" href="Terminal.Gui.ScrollBarView.html#Terminal_Gui_ScrollBarView_Size">Size</a>, to set the scrollbar at.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int Position { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td>The position.</td>
</tr>
</tbody>
</table>
<a id="Terminal_Gui_ScrollBarView_Size_" data-uid="Terminal.Gui.ScrollBarView.Size*"></a>
<h4 id="Terminal_Gui_ScrollBarView_Size" data-uid="Terminal.Gui.ScrollBarView.Size">Size</h4>
<div class="markdown level1 summary">
The size of content the scrollbar represents.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int Size { get; set; }</code></pre>
</div>
<h5 class="propertyValue">Property Value</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td>The size.</td>
</tr>
</tbody>
</table>
<h5 id="Terminal_Gui_ScrollBarView_Size_remarks">Remarks</h5>
<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
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>
<h3 id="methods">Methods
</h3>
<a id="Terminal_Gui_ScrollBarView_MouseEvent_" data-uid="Terminal.Gui.ScrollBarView.MouseEvent*"></a>
<h4 id="Terminal_Gui_ScrollBarView_MouseEvent_Terminal_Gui_MouseEvent_" data-uid="Terminal.Gui.ScrollBarView.MouseEvent(Terminal.Gui.MouseEvent)">MouseEvent(MouseEvent)</h4>
<div class="markdown level1 summary">
Method invoked when a mouse event is generated
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override bool MouseEvent(MouseEvent me)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.Gui.MouseEvent.html">MouseEvent</a></td>
<td><span class="parametername">me</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><code>true</code>, if the event was handled, <code>false</code> otherwise.</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Terminal.Gui.Responder.html#Terminal_Gui_Responder_MouseEvent_Terminal_Gui_MouseEvent_">Responder.MouseEvent(MouseEvent)</a></div>
<a id="Terminal_Gui_ScrollBarView_Redraw_" data-uid="Terminal.Gui.ScrollBarView.Redraw*"></a>
<h4 id="Terminal_Gui_ScrollBarView_Redraw_Terminal_Gui_Rect_" data-uid="Terminal.Gui.ScrollBarView.Redraw(Terminal.Gui.Rect)">Redraw(Rect)</h4>
<div class="markdown level1 summary">
Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override void Redraw(Rect region)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
<td><span class="parametername">region</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Redraw_Terminal_Gui_Rect_">View.Redraw(Rect)</a></div>
<h5 id="Terminal_Gui_ScrollBarView_Redraw_Terminal_Gui_Rect__remarks">Remarks</h5>
<div class="markdown level1 remarks">
<p>
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).
</p>
<p>
Views should set the color that they want to use on entry, as otherwise this will inherit
the last color that was set globaly on the driver.
</p>
<p>
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
larger than the <code>region</code> parameter.
</p>
</div>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">System.Collections.IEnumerable</span>
</div>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
</ul>
</div>
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../../styles/docfx.js"></script>
<script type="text/javascript" src="../../styles/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink