Class ScrollBarBase

The base ScrollBarBase class. This is not intended to be derived outside of the Binarymission scrollbars assembly.

Namespace: Binarymission.WinForms.Controls.ScrollBars

Assembly: Binarymission.WinForms.Controls.ScrollBars.dll

Syntax

public abstract class ScrollBarBase : Control

Constructors

ScrollBarBase()

Declaration

protected ScrollBarBase()

ScrollBarBase(IScrollersDockHost)

Declaration

protected ScrollBarBase(IScrollersDockHost parentInstanceUsingThisScrollerInstance)

Parameters

Type	Name	Description
IScrollersDockHost	parentInstanceUsingThisScrollerInstance

Fields

_earlierScrolledPosition

Declaration

protected double _earlierScrolledPosition

Field Value

Type	Description
Double

_executeNavigationEvent

Declaration

protected bool _executeNavigationEvent

Field Value

Type	Description
Boolean

_gripperArtefactHeight

Declaration

protected int _gripperArtefactHeight

Field Value

Type	Description
Int32

_gripperArtefactWidth

Declaration

protected int _gripperArtefactWidth

Field Value

Type	Description
Int32

_largeChange

Declaration

protected int _largeChange

Field Value

Type	Description
Int32

_maximumScrollRange

Declaration

protected int _maximumScrollRange

Field Value

Type	Description
Int32

_minimumScrollRange

Declaration

protected int _minimumScrollRange

Field Value

Type	Description
Int32

_parentInstanceUsingThisScrollerInstance

Declaration

protected readonly Control _parentInstanceUsingThisScrollerInstance

Field Value

Type	Description
Control

_performCarefulSizing

Declaration

protected bool _performCarefulSizing

Field Value

Type	Description
Boolean

_scrollPosition

Declaration

protected double _scrollPosition

Field Value

Type	Description
Double

_scrollServiceTargetControl

Declaration

protected Control _scrollServiceTargetControl

Field Value

Type	Description
Control

_shouldAutoScrolingActionEnd

Declaration

protected bool _shouldAutoScrolingActionEnd

Field Value

Type	Description
Boolean

_smallChange

Declaration

protected int _smallChange

Field Value

Type	Description
Int32

_usingSibling

Declaration

protected bool _usingSibling

Field Value

Type	Description
Boolean

Properties

EarlierScrollPosition

Gets the earlier scroll position.

Declaration

public double EarlierScrollPosition { get; }

HorizontalScrollBarHeight

Gets or sets the height of the horizontal scroll bar.

Declaration

public virtual int HorizontalScrollBarHeight { get; set; }

IsDrawingCustomThumbImage

Declaration

protected bool IsDrawingCustomThumbImage { get; set; }

LargeChange

Gets or sets the large change.

Declaration

public int LargeChange { get; set; }

MaximumScrollRange

Gets or sets the maximum scroll range.

Declaration

public int MaximumScrollRange { get; set; }

MinimumScrollRange

Gets or sets the minimum scroll range.

Declaration

public int MinimumScrollRange { get; set; }

PaddingGap

Gets or sets the padding gap.

Declaration

public int PaddingGap { get; set; }

Position

Gets or sets the current scroll position.

Declaration

public double Position { get; set; }

ScrollBarNavigationButtonRenderer

Gets or sets a custom scroll bar renderer for painting the navigation button and their content.

Declaration

public IScrollBarNavigationButtonRenderer ScrollBarNavigationButtonRenderer { get; set; }

ScrollBarRenderingConfigurator

Gets or sets the scroll bar rendering configurator.

Declaration

public ScrollBarRenderingConfigurator ScrollBarRenderingConfigurator { get; set; }

ScrollBarThumbGripperRenderer

Gets or sets a custom scroll bar renderer for painting the thumb gripper.

Declaration

public IScrollBarThumbGripperRenderer ScrollBarThumbGripperRenderer { get; set; }

ScrollBarThumbRenderer

Gets or sets a custom scroll bar renderer for painting the thumb.

Declaration

public IScrollBarThumbRenderer ScrollBarThumbRenderer { get; set; }

ScrollBarTrackRenderer

Gets or sets a custom scroll bar renderer for painting the track.

Declaration

public IScrollBarTrackRenderer ScrollBarTrackRenderer { get; set; }

ScrollServiceTargetControl

Gets or sets the scroll service target control.

Declaration

public Control ScrollServiceTargetControl { get; set; }

ShouldAutomaticallyPositionScroller

Gets or sets a value indicating whether the control should automatically position scroller.

Declaration

public bool ShouldAutomaticallyPositionScroller { get; set; }

Remarks

If set to true, the scroll bar controls will automatically dock to the parent control (to its right for vertical mode, and bottom for horizontal mode).

SmallChange

Gets or sets the small change.

Declaration

public int SmallChange { get; set; }

VerticalScrollBarWidth

Gets or sets the width of the vertical scroll bar.

Declaration

public virtual int VerticalScrollBarWidth { get; set; }

Methods

DrawScrollNavigator(Graphics, Rectangle, ArrowDrawingArtefact, ControlVisualState)

Declaration

protected virtual void DrawScrollNavigator(Graphics graphicsInstance, Rectangle targetRectangle, ArrowDrawingArtefact arrowDrawingArtefact, ControlVisualState controlVisualState)

Parameters

Type	Name	Description
Graphics	graphicsInstance
Rectangle	targetRectangle
ArrowDrawingArtefact	arrowDrawingArtefact
ControlVisualState	controlVisualState

DrawThumbArtefactConditional(Graphics, ControlVisualState)

Declaration

protected virtual void DrawThumbArtefactConditional(Graphics graphicsInstance, ControlVisualState controlVisualState)

Parameters

Type	Name	Description
Graphics	graphicsInstance
ControlVisualState	controlVisualState

GetThumbArtefactRectangle()

Declaration

protected virtual Rectangle GetThumbArtefactRectangle()

Returns

Type	Description
Rectangle

IsInputKey(Keys)

Declaration

protected override bool IsInputKey(Keys keyData)

Parameters

Type	Name	Description
Keys	keyData

Returns

Type	Description
Boolean

OnHandleCreated(EventArgs)

Declaration

protected override void OnHandleCreated(EventArgs e)

Parameters

Type	Name	Description
EventArgs	e

OnKeyDown(KeyEventArgs)

Declaration

protected override void OnKeyDown(KeyEventArgs e)

Parameters

Type	Name	Description
KeyEventArgs	e

OnKeyUp(KeyEventArgs)

Declaration

protected override void OnKeyUp(KeyEventArgs e)

Parameters

Type	Name	Description
KeyEventArgs	e

OnMouseWheel(MouseEventArgs)

Declaration

protected override void OnMouseWheel(MouseEventArgs e)

Parameters

Type	Name	Description
MouseEventArgs	e

OnPaint(PaintEventArgs)

Declaration

protected override void OnPaint(PaintEventArgs e)

Parameters

Type	Name	Description
PaintEventArgs	e

OnParentChanged(EventArgs)

Declaration

protected override void OnParentChanged(EventArgs e)

Parameters

Type	Name	Description
EventArgs	e

OnTabStopChanged(EventArgs)

Declaration

protected override void OnTabStopChanged(EventArgs e)

Parameters

Type	Name	Description
EventArgs	e

PaintBackground(Graphics)

Declaration

protected virtual void PaintBackground(Graphics g)

Parameters

Type	Name	Description
Graphics	g

PaintScrollBar(Graphics)

Declaration

protected virtual void PaintScrollBar(Graphics g)

Parameters

Type	Name	Description
Graphics	g

PerformSizeRefresh()

Declaration

protected virtual void PerformSizeRefresh()

WndProc(ref Message)

Declaration

protected override void WndProc(ref Message m)

Parameters

Type	Name	Description
Message	m

Events

HorizontalScrollBarHeightChanged

Occurs when horizontal scroll bar height changes.

Declaration

public event EventHandler HorizontalScrollBarHeightChanged

Event Type

Type	Description
EventHandler

PositionChanged

Occurs when the scroll position changed.

Declaration

public event EventHandler<PositionChangedArgs> PositionChanged

Event Type

Type	Description
EventHandler<PositionChangedArgs>

VerticalScrollBarWidthChanged

Occurs when vertical scroll bar width changes.

Declaration

public event EventHandler VerticalScrollBarWidthChanged

Event Type

Type	Description
EventHandler