Table of Contents

Class ScrollBarBase

Namespace
LightningChartLib.WinForms.Charting
Assembly
LightningChart.WinForms.Charting.NET4.dll

Vertical scroll bar. Values use unsigned 64-bit integer value range.

[TypeConverter(typeof(ExpandableObjectConverter))]
public class ScrollBarBase : DraggableObject, IChartNode, IDisposable, IHighlightingItem
Inheritance
ScrollBarBase
Implements
Derived
Inherited Members

Constructors

ScrollBarBase()

Constructor for form editor list editor

public ScrollBarBase()

ScrollBarBase(LightningChart)

Constructor

public ScrollBarBase(LightningChart owner)

Parameters

owner LightningChart

Parent.

Properties

BackgroundFill

Background fill

public Fill BackgroundFill { get; set; }

Property Value

Fill

Border

Border around the bar

public Border Border { get; set; }

Property Value

Border

ButtonOptions

Button options

public ScrollButtonOptions ButtonOptions { get; set; }

Property Value

ScrollButtonOptions

Enabled

Is scrollbar enabled or not

public bool Enabled { get; set; }

Property Value

bool

KeyControlEnabled

Is scrollbar listening to key presses or not

public bool KeyControlEnabled { get; set; }

Property Value

bool

KeyControlFocus

Key control focus rectangle line style.

public LineStyle KeyControlFocus { get; set; }

Property Value

LineStyle

Remarks

Visible only when KeyControlEnabled is true

LargeChange

Large change

public double LargeChange { get; set; }

Property Value

double

Remarks

Set this Maximum + 1 to hide the scroll box

Maximum

Maximum value

public double Maximum { get; set; }

Property Value

double

Minimum

Minimum value

public double Minimum { get; set; }

Property Value

double

Offset

Offset from position set by Alignment property

public PointIntXY Offset { get; set; }

Property Value

PointIntXY

RepeatIntervalMs

Repeat interval when user interactive device primary button is kept down, in milliseconds

public int RepeatIntervalMs { get; set; }

Property Value

int

ScrollBoxOptions

Scroll box options

public ScrollThumbOptions ScrollBoxOptions { get; set; }

Property Value

ScrollThumbOptions

Size

Size.

public SizeDoubleXY Size { get; set; }

Property Value

SizeDoubleXY

Remarks

Width does not apply when Alignment is set to other option than TopLeft

SmallChange

Small change

public double SmallChange { get; set; }

Property Value

double

Value

Value

public double Value { get; set; }

Property Value

double

Visible

Is scrollbar visible or not

public bool Visible { get; set; }

Property Value

bool

WheelChange

User interactive device wheel change. Increment or decrement when wheel has scrolled over the scroll bar.

public double WheelChange { get; set; }

Property Value

double

Methods

Dispose(bool)

Clean up any resources being used.

protected override void Dispose(bool disposing)

Parameters

disposing bool

true if managed resources should be disposed, otherwise false.

IsPositionOver(int, int, bool)

Is mouse over item.

public override bool IsPositionOver(int x, int y, bool useDIP = false)

Parameters

x int

mouse x-coordinate

y int

mouse y-coordinate

useDIP bool

Use DIP instead of pixels as parameters

Returns

bool

true if mouse is over item, false otherwise

Events

Scroll

Occurs when the scroll bar thumb has been moved.

public event ScrollBarBase.ScrollEventHandler Scroll

Event Type

ScrollBarBase.ScrollEventHandler

ValueChanged

Occurs when the Value property has been changed.

public event EventHandler ValueChanged

Event Type

EventHandler