Class ScrollBarView

ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical
Inheritance
System.Object
Responder
View
ScrollBarView
Implements
System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Terminal.Gui
Assembly: Terminal.Gui.dll
Syntax
public class ScrollBarView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize
Remarks

The scrollbar is drawn to be a representation of the Size, assuming that the scroll position is set at Position.

If the region to display the scrollbar is larger than three characters, arrow indicators are drawn.

Constructors

ScrollBarView()

Initializes a new instance of the ScrollBarView class using Computed layout.
Declaration
public ScrollBarView()

ScrollBarView(Int32, Int32, Boolean)

Initializes a new instance of the ScrollBarView class using Computed layout.
Declaration
public ScrollBarView(int size, int position, bool isVertical)
Parameters
Type Name Description
System.Int32 size The size that this scrollbar represents.
System.Int32 position The position within this scrollbar.
System.Boolean isVertical If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal.

ScrollBarView(Rect)

Initializes a new instance of the ScrollBarView class using Absolute layout.
Declaration
public ScrollBarView(Rect rect)
Parameters
Type Name Description
Rect rect Frame for the scrollbar.

ScrollBarView(Rect, Int32, Int32, Boolean)

Initializes a new instance of the ScrollBarView class using Absolute layout.
Declaration
public ScrollBarView(Rect rect, int size, int position, bool isVertical)
Parameters
Type Name Description
Rect rect Frame for the scrollbar.
System.Int32 size The size that this scrollbar represents. Sets the Size property.
System.Int32 position The position within this scrollbar. Sets the Position property.
System.Boolean isVertical If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal. Sets the IsVertical property.

Properties

Host

Get or sets the view that host this ScrollView
Declaration
public ScrollView Host { get; }
Property Value
Type Description
ScrollView

IsVertical

If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal.
Declaration
public bool IsVertical { get; set; }
Property Value
Type Description
System.Boolean

Position

The position, relative to Size, to set the scrollbar at.
Declaration
public int Position { get; set; }
Property Value
Type Description
System.Int32 The position.

Size

The size of content the scrollbar represents.
Declaration
public int Size { get; set; }
Property Value
Type Description
System.Int32 The size.
Remarks
The Size is typically the size of the virtual content. E.g. when a Scrollbar is part of a ScrollView the Size is set to the appropriate dimension of ContentSize.

Methods

MouseEvent(MouseEvent)

Method invoked when a mouse event is generated
Declaration
public override bool MouseEvent(MouseEvent me)
Parameters
Type Name Description
MouseEvent me
Returns
Type Description
System.Boolean true, if the event was handled, false otherwise.
Overrides

Redraw(Rect)

Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.
Declaration
public override void Redraw(Rect region)
Parameters
Type Name Description
Rect region
Overrides
Remarks

Always use Bounds (view-relative) when calling Redraw(Rect), NOT Frame (superview-relative).

Views should set the color that they want to use on entry, as otherwise this will inherit the last color that was set globally on the driver.

Overrides of Redraw(Rect) must ensure they do not set Driver.Clip to a clip region larger than the region parameter.

Events

ChangedPosition

This event is raised when the position on the scrollbar has changed.
Declaration
public event Action ChangedPosition
Event Type
Type Description
System.Action

Implements

System.IDisposable
System.ComponentModel.ISupportInitializeNotification
System.ComponentModel.ISupportInitialize