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.

ScrollBarView(View, Boolean, Boolean)

Initializes a new instance of the ScrollBarView class using Computed layout.
Declaration
public ScrollBarView(View host, bool isVertical, bool showBothScrollIndicator = true)
Parameters
Type Name Description
View host The view that will host this scrollbar.
System.Boolean isVertical If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal.
System.Boolean showBothScrollIndicator If set to true (default) will have the other scrollbar, otherwise will have only one.

Properties

AutoHideScrollBars

If true the vertical/horizontal scroll bars won't be showed if it's not needed.
Declaration
public bool AutoHideScrollBars { get; set; }
Property Value
Type Description
System.Boolean

Host

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

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

KeepContentAlwaysInViewport

Get or sets if the view-port is kept always visible in the area of this ScrollBarView
Declaration
public bool KeepContentAlwaysInViewport { get; set; }
Property Value
Type Description
System.Boolean

OtherScrollBarView

Represent a vertical or horizontal ScrollBarView other than this.
Declaration
public ScrollBarView OtherScrollBarView { get; set; }
Property Value
Type Description
ScrollBarView

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.

ShowScrollIndicator

Gets or sets the visibility for the vertical or horizontal scroll indicator.
Declaration
public bool ShowScrollIndicator { get; set; }
Property Value
Type Description
System.Boolean true if show vertical or horizontal scroll indicator; otherwise, false.

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 View the Size is set to the appropriate dimension of Host.

Methods

MouseEvent(MouseEvent)

Declaration
public override bool MouseEvent(MouseEvent me)
Parameters
Type Name Description
MouseEvent me
Returns
Type Description
System.Boolean
Overrides

OnChangedPosition()

Virtual method to invoke the ChangedPosition action event.
Declaration
public virtual void OnChangedPosition()

OnEnter(View)

Declaration
public override bool OnEnter(View view)
Parameters
Type Name Description
View view
Returns
Type Description
System.Boolean
Overrides

Redraw(Rect)

Declaration
public override void Redraw(Rect region)
Parameters
Type Name Description
Rect region
Overrides

Refresh()

Only used for a hosted view that will update and redraw the scrollbars.
Declaration
public virtual void Refresh()

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