Class VerticalScrollBar
Implements a vertical scrollbar.
Inheritance
VerticalScrollBar
Assembly: Assembly-CSharp.dll
public class VerticalScrollBar : BaseScreenComponent, IDisposable
Constructors
|
Improve this Doc
View Source
Declaration
public VerticalScrollBar()
Properties
|
Improve this Doc
View Source
The maximum number of visible units (pixels, rows, etc.) at any one time.
Declaration
public int DisplayUnits { get; set; }
Property Value
|
Improve this Doc
View Source
Gets flag set when user dragging thumb.
Declaration
public bool DraggingThumb { get; }
Property Value
|
Improve this Doc
View Source
The current scroll position in units.
Declaration
public int ScrollIndex { get; set; }
Property Value
|
Improve this Doc
View Source
The total number of units (pixels, rows, etc.) represented by this scrollbar.
Declaration
public int TotalUnits { get; set; }
Property Value
Methods
|
Improve this Doc
View Source
Declaration
public override void Draw()
Overrides
|
Improve this Doc
View Source
Declaration
protected override void MouseClick(Vector2 clickPosition)
Parameters
Type |
Name |
Description |
Vector2 |
clickPosition |
|
Overrides
|
Improve this Doc
View Source
Declaration
protected override void MouseScrollDown()
Overrides
|
Improve this Doc
View Source
Declaration
protected override void MouseScrollUp()
Overrides
|
Improve this Doc
View Source
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
Declaration
public void SetScrollIndexWithoutRaisingScrollEvent(int value)
Parameters
Type |
Name |
Description |
Int32 |
value |
|
|
Improve this Doc
View Source
Declaration
public override void Update()
Overrides
Events
|
Improve this Doc
View Source
Declaration
public event VerticalScrollBar.OnScrollHandler OnScroll
Event Type