Show / Hide Table of Contents

Class VerticalScrollBar

Implements a vertical scrollbar.

Inheritance
Object
BaseScreenComponent
VerticalScrollBar
Inherited Members
BaseScreenComponent.rectRestrictedRenderArea
BaseScreenComponent.restrictedRenderAreaCustomParent
BaseScreenComponent.restrictedRenderAreaCoordinateType
BaseScreenComponent.backgroundTexture
BaseScreenComponent.animatedBackgroundTextures
BaseScreenComponent.backgroundTextureLayout
BaseScreenComponent.OnKeyboardEvent
BaseScreenComponent.OnMouseEnter
BaseScreenComponent.OnMouseLeave
BaseScreenComponent.OnMouseMove
BaseScreenComponent.OnMouseDown
BaseScreenComponent.OnMouseUp
BaseScreenComponent.OnMouseClick
BaseScreenComponent.OnMouseDoubleClick
BaseScreenComponent.OnRightMouseDown
BaseScreenComponent.OnRightMouseUp
BaseScreenComponent.OnRightMouseClick
BaseScreenComponent.OnRightMouseDoubleClick
BaseScreenComponent.OnMiddleMouseDown
BaseScreenComponent.OnMiddleMouseUp
BaseScreenComponent.OnMiddleMouseClick
BaseScreenComponent.OnMiddleMouseDoubleClick
BaseScreenComponent.OnMouseScrollUp
BaseScreenComponent.OnMouseScrollDown
BaseScreenComponent.Enabled
BaseScreenComponent.UseFocus
BaseScreenComponent.OverridesHotkeySequences
BaseScreenComponent.Name
BaseScreenComponent.Tag
BaseScreenComponent.Position
BaseScreenComponent.Size
BaseScreenComponent.RootSize
BaseScreenComponent.Parent
BaseScreenComponent.Rectangle
BaseScreenComponent.HorizontalAlignment
BaseScreenComponent.VerticalAlignment
BaseScreenComponent.RestrictedRenderAreaCoordinateType
BaseScreenComponent.RectRestrictedRenderArea
BaseScreenComponent.RestrictedRenderAreaCustomParent
BaseScreenComponent.UseRestrictedRenderArea
BaseScreenComponent.CustomMousePosition
BaseScreenComponent.MousePosition
BaseScreenComponent.LastMousePosition
BaseScreenComponent.ScaledMousePosition
BaseScreenComponent.BackgroundColor
BaseScreenComponent.MouseOverBackgroundColor
BaseScreenComponent.BackgroundColorTexture
BaseScreenComponent.BackgroundTexture
BaseScreenComponent.BackgroundCroppedRect
BaseScreenComponent.AnimatedBackgroundTextures
BaseScreenComponent.AnimationDelayInSeconds
BaseScreenComponent.BackgroundTextureLayout
BaseScreenComponent.InteriorWidth
BaseScreenComponent.InteriorHeight
BaseScreenComponent.Scale
BaseScreenComponent.AutoSize
BaseScreenComponent.LocalScale
BaseScreenComponent.ToolTip
BaseScreenComponent.ToolTipText
BaseScreenComponent.SuppressToolTip
BaseScreenComponent.MinAutoScale
BaseScreenComponent.MaxAutoScale
BaseScreenComponent.MouseOverComponent
BaseScreenComponent.TopMargin
BaseScreenComponent.BottomMargin
BaseScreenComponent.LeftMargin
BaseScreenComponent.RightMargin
BaseScreenComponent.ScreenToLocal(Vector2)
BaseScreenComponent.ScreenToLocal(Rect)
BaseScreenComponent.GotFocus()
BaseScreenComponent.LostFocus()
BaseScreenComponent.TriggerMouseClick()
BaseScreenComponent.KeyboardEvent(Event)
BaseScreenComponent.RightMouseClick(Vector2)
BaseScreenComponent.MiddleMouseClick(Vector2)
BaseScreenComponent.MouseDoubleClick(Vector2)
BaseScreenComponent.RightMouseDoubleClick(Vector2)
BaseScreenComponent.MiddleMouseDoubleClick(Vector2)
BaseScreenComponent.MouseEnter()
BaseScreenComponent.MouseLeave(BaseScreenComponent)
BaseScreenComponent.MouseMove(Int32, Int32)
BaseScreenComponent.Dispose()
BaseScreenComponent.SetMargins(Margins, Int32)
BaseScreenComponent.OffsetFrom(BaseScreenComponent, Sides, Int32)
BaseScreenComponent.SetFocus()
BaseScreenComponent.HasFocus()
Namespace: DaggerfallWorkshop.Game.UserInterface
Assembly: Assembly-CSharp.dll
Syntax
public class VerticalScrollBar : BaseScreenComponent, IDisposable

Constructors

| Improve this Doc View Source

VerticalScrollBar()

Declaration
public VerticalScrollBar()

Properties

| Improve this Doc View Source

DisplayUnits

The maximum number of visible units (pixels, rows, etc.) at any one time.

Declaration
public int DisplayUnits { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

DraggingThumb

Gets flag set when user dragging thumb.

Declaration
public bool DraggingThumb { get; }
Property Value
Type Description
Boolean
| Improve this Doc View Source

ScrollIndex

The current scroll position in units.

Declaration
public int ScrollIndex { get; set; }
Property Value
Type Description
Int32
| Improve this Doc View Source

TotalUnits

The total number of units (pixels, rows, etc.) represented by this scrollbar.

Declaration
public int TotalUnits { get; set; }
Property Value
Type Description
Int32

Methods

| Improve this Doc View Source

Draw()

Declaration
public override void Draw()
Overrides
BaseScreenComponent.Draw()
| Improve this Doc View Source

MouseClick(Vector2)

Declaration
protected override void MouseClick(Vector2 clickPosition)
Parameters
Type Name Description
Vector2 clickPosition
Overrides
BaseScreenComponent.MouseClick(Vector2)
| Improve this Doc View Source

MouseScrollDown()

Declaration
protected override void MouseScrollDown()
Overrides
BaseScreenComponent.MouseScrollDown()
| Improve this Doc View Source

MouseScrollUp()

Declaration
protected override void MouseScrollUp()
Overrides
BaseScreenComponent.MouseScrollUp()
| Improve this Doc View Source

Reset(Int32, Int32, Int32)

Resets scroll properties without triggering events.

Declaration
public void Reset(int displayUnits = 0, int totalUnits = 0, int scrollIndex = 0)
Parameters
Type Name Description
Int32 displayUnits
Int32 totalUnits
Int32 scrollIndex
| Improve this Doc View Source

SetScrollIndexWithoutRaisingScrollEvent(Int32)

Declaration
public void SetScrollIndexWithoutRaisingScrollEvent(int value)
Parameters
Type Name Description
Int32 value
| Improve this Doc View Source

Update()

Declaration
public override void Update()
Overrides
BaseScreenComponent.Update()

Events

| Improve this Doc View Source

OnScroll

Declaration
public event VerticalScrollBar.OnScrollHandler OnScroll
Event Type
Type Description
VerticalScrollBar.OnScrollHandler
  • Improve this Doc
  • View Source
In This Article
  • Constructors
    • VerticalScrollBar()
  • Properties
    • DisplayUnits
    • DraggingThumb
    • ScrollIndex
    • TotalUnits
  • Methods
    • Draw()
    • MouseClick(Vector2)
    • MouseScrollDown()
    • MouseScrollUp()
    • Reset(Int32, Int32, Int32)
    • SetScrollIndexWithoutRaisingScrollEvent(Int32)
    • Update()
  • Events
    • OnScroll
Back to top Generated by DocFX