Class ScrollBarView

Namespace: Terminal.Gui

Assembly: Terminal.Gui.dll

ScrollBarViews are views that display a 1-character scrollbar, either horizontal or vertical

public class ScrollBarView : View, IDisposable, ISupportInitializeNotification, ISupportInitialize

Inheritance: object

Responder

View

ScrollBarView

Implements: IDisposable

ISupportInitializeNotification

ISupportInitialize

Inherited Members: View.Added

View.Removed

View.Enter

View.Leave

View.MouseEnter

View.MouseLeave

View.MouseClick

View.CanFocusChanged

View.EnabledChanged

View.VisibleChanged

View.HotKeyChanged

View.HotKey

View.HotKeySpecifier

View.Shortcut

View.ShortcutTag

View.ShortcutAction

View.Data

View.Driver

View.Subviews

View.TabIndexes

View.TabIndex

View.TabStop

View.CanFocus

View.Id

View.IsCurrentTop

View.WantMousePositionReports

View.WantContinuousButtonPressed

View.Frame

View.LayoutStyle

View.Bounds

View.X

View.Y

View.Width

View.Height

View.ForceValidatePosDim

View.GetMinWidthHeight(out Size)

View.SetMinWidthHeight()

View.TextFormatter

View.SuperView

View.UpdateTextFormatterText()

View.ProcessResizeView()

View.SetNeedsDisplay()

View.ClearLayoutNeeded()

View.SetNeedsDisplay(Rect)

View.SetChildNeedsDisplay()

View.Add(View)

View.Add(params View[])

View.RemoveAll()

View.Remove(View)

View.BringSubviewToFront(View)

View.SendSubviewToBack(View)

View.SendSubviewBackwards(View)

View.BringSubviewForward(View)

View.Clear()

View.Clear(Rect)

View.ScreenToView(int, int)

View.ClipToBounds()

View.SetClip(Rect)

View.DrawFrame(Rect, int, bool)

View.DrawHotString(ustring, Attribute, Attribute)

View.DrawHotString(ustring, bool, ColorScheme)

View.Move(int, int, bool)

View.PositionCursor()

View.HasFocus

View.OnAdded(View)

View.OnRemoved(View)

View.OnLeave(View)

View.Focused

View.MostFocused

View.ColorScheme

View.AddRune(int, int, Rune)

View.ClearNeedsDisplay()

View.DrawContent

View.OnDrawContent(Rect)

View.DrawContentComplete

View.OnDrawContentComplete(Rect)

View.SetFocus()

View.KeyPress

View.ProcessKey(KeyEvent)

View.InvokeKeybindings(KeyEvent)

View.AddKeyBinding(Key, params Command[])

View.ReplaceKeyBinding(Key, Key)

View.ContainsKeyBinding(Key)

View.ClearKeybindings()

View.ClearKeybinding(Key)

View.ClearKeybinding(params Command[])

View.AddCommand(Command, Func<bool?>)

View.GetSupportedCommands()

View.GetKeyFromCommand(params Command[])

View.ProcessHotKey(KeyEvent)

View.ProcessColdKey(KeyEvent)

View.KeyDown

View.OnKeyDown(KeyEvent)

View.KeyUp

View.OnKeyUp(KeyEvent)

View.EnsureFocus()

View.FocusFirst()

View.FocusLast()

View.FocusPrev()

View.FocusNext()

View.LayoutStarted

View.LayoutComplete

View.Initialized

View.LayoutSubviews()

View.Text

View.AutoSize

View.PreserveTrailingSpaces

View.TextAlignment

View.VerticalTextAlignment

View.TextDirection

View.IsInitialized

View.IsAdded

View.Enabled

View.ClearOnVisibleFalse

View.Visible

View.Border

View.IgnoreBorderPropertyOnRedraw

View.ToString()

View.GetAutoSize()

View.GetHotKeySpecifierLength(bool)

View.GetTextFormatterBoundsSize()

View.GetBoundsTextFormatterSize()

View.OnMouseEnter(MouseEvent)

View.OnMouseLeave(MouseEvent)

View.OnMouseEvent(MouseEvent)

View.OnMouseClick(View.MouseEventArgs)

View.OnCanFocusChanged()

View.OnEnabledChanged()

View.OnVisibleChanged()

View.Dispose(bool)

View.BeginInit()

View.EndInit()

View.SetWidth(int, out int)

View.SetHeight(int, out int)

View.GetCurrentWidth(out int)

View.GetCurrentHeight(out int)

View.GetNormalColor()

View.GetFocusColor()

View.GetHotNormalColor()

View.GetTopSuperView()

Responder.Dispose()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

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.

ScrollBarView(int, int, bool): Initializes a new instance of the ScrollBarView class using Computed layout.

ScrollBarView(Rect): Initializes a new instance of the ScrollBarView class using Absolute layout.

ScrollBarView(Rect, int, int, bool): Initializes a new instance of the ScrollBarView class using Absolute layout.

ScrollBarView(View, bool, bool): Initializes a new instance of the ScrollBarView class using Computed layout.

Properties

AutoHideScrollBars: If true the vertical/horizontal scroll bars won't be showed if it's not needed.

Host: Get or sets the view that host this View

IsVertical: If set to true this is a vertical scrollbar, otherwise, the scrollbar is horizontal.

KeepContentAlwaysInViewport: Get or sets if the view-port is kept always visible in the area of this ScrollBarView

OtherScrollBarView: Represent a vertical or horizontal ScrollBarView other than this.

Position: The position, relative to Size, to set the scrollbar at.

ShowScrollIndicator: Gets or sets the visibility for the vertical or horizontal scroll indicator.

Size: The size of content the scrollbar represents.

Methods

MouseEvent(MouseEvent): Method invoked when a mouse event is generated

OnChangedPosition(): Virtual method to invoke the ChangedPosition action event.

OnEnter(View): Method invoked when a view gets focus.

Redraw(Rect): Redraws this view and its subviews; only redraws the views that have been flagged for a re-display.

Refresh(): Only used for a hosted view that will update and redraw the scrollbars.

Events