Class HybridScrollControl

Represents a class that acts as a hybrid between Syncfusions scroller and windows scroller.

Inheritance
System.Object
ScrollControl
HybridScrollControl
IntelliScrollableControl
Inherited Members
Namespace: Syncfusion.Windows.Forms.Edit
Assembly: Syncfusion.Edit.Windows.dll
Syntax
public abstract class HybridScrollControl : ScrollControl

Constructors

HybridScrollControl()

Initializes a new instance of the HybridScrollControl class.

Declaration
public HybridScrollControl()

Properties

AutoScrollPosition

Gets or sets the position of the scroller.

Declaration
public virtual Point AutoScrollPosition { get; set; }
Property Value
Type
System.Drawing.Point

AutoScrollRectangle

Rectangle for autoscrolling.

Declaration
protected virtual Rectangle AutoScrollRectangle { get; }
Property Value
Type
System.Drawing.Rectangle

DefaultCursor

Gets or sets the custom cursor for mouse pointer.

Declaration
public Cursor DefaultCursor { get; set; }
Property Value
Type
System.Windows.Forms.Cursor

DisableHorizontalScroller

Gets or sets a value indicating whether the horizontal scroller should be disabled.

Declaration
public bool DisableHorizontalScroller { get; set; }
Property Value
Type
System.Boolean

DisableVerticalScroller

Gets or sets a value indicating whether the vertical scroller should be disabled.

Declaration
public bool DisableVerticalScroller { get; set; }
Property Value
Type
System.Boolean

FastScrollingStep

Gets or sets the step of fast scrolling.

Declaration
public int FastScrollingStep { get; set; }
Property Value
Type
System.Int32

FastScrollOffset

Gets or sets the distance in pixels from the control`s border, where fast autoscrolling starts. using FastScrollingStep instead of SlowScrollingStep.

Declaration
public int FastScrollOffset { get; set; }
Property Value
Type
System.Int32

IsAutoScrolling

Gets value, indicating whether control is now in autoscroll mode.

Declaration
protected bool IsAutoScrolling { get; }
Property Value
Type
System.Boolean

ScrollOffsetBottom

Gets or sets the bottom offset scroll.

Declaration
public int ScrollOffsetBottom { get; set; }
Property Value
Type
System.Int32

ScrollOffsetLeft

Gets or sets the left offset scroll.

Declaration
public int ScrollOffsetLeft { get; set; }
Property Value
Type
System.Int32

ScrollOffsetRight

Gets or sets the right offset scroll.

Declaration
public int ScrollOffsetRight { get; set; }
Property Value
Type
System.Int32

ScrollOffsetTop

Gets or sets the top offset scroll.

Declaration
public int ScrollOffsetTop { get; set; }
Property Value
Type
System.Int32

SlowScrollingStep

Gets or sets the step of slow scrolling.

Declaration
public int SlowScrollingStep { get; set; }
Property Value
Type
System.Int32

VirtualSize

Gets or sets the virtual size of control.

Declaration
public Size VirtualSize { get; set; }
Property Value
Type
System.Drawing.Size
Remarks

If control's client area is smaller then virtual size, then scrollers will be visible.

Methods

AfterAutoScroll()

Called after scrolling by timer on every timer tick.

Declaration
protected virtual void AfterAutoScroll()

BeforeAutoScroll(Int32)

Called before scrolling by timer on every timer tick.

Declaration
protected virtual void BeforeAutoScroll(int yOffset)
Parameters
Type Name Description
System.Int32 yOffset

Offset by y.

CheckIfCanStartAutoscroll()

Checks whether Autoscrolling can be started when user presses mouse button down.

Declaration
protected virtual bool CheckIfCanStartAutoscroll()
Returns
Type Description
System.Boolean

If return value is true, autoscrolling will be allowed.

CorrectPosition()

Corrects scrollers position.

Declaration
protected virtual void CorrectPosition()

OnHScroll(Object, ScrollEventArgs)

Processes horizontal scroll event.

Declaration
protected override void OnHScroll(object sender, ScrollEventArgs se)
Parameters
Type Name Description
System.Object sender

Sender.
System.Windows.Forms.ScrollEventArgs se

ScrollEventArgs.
Overrides

OnLostFocus(EventArgs)

Stops scrolling.

Declaration
protected override void OnLostFocus(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

EventArgs.
Overrides

OnMouseDown(MouseEventArgs)

Enables autoscrolling.

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

MouseEventArgs.

OnMouseMove(MouseEventArgs)

Starts or stops timer depending on the position of the mouse.

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

MouseEventArgs.

OnMouseUp(MouseEventArgs)

Disables autoscrolling.

Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

MouseEventArgs.

OnMouseWheel(MouseEventArgs)

Handles mouse wheel processing for our scrollbars.

Declaration
protected override void OnMouseWheel(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

MouseEventArgs.

OnResize(EventArgs)

Handler of the WM_SIZE event.

Declaration
protected override void OnResize(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

EventArgs.
Remarks

On window resize scrollers are updated: their maximum size changes and their page size changes.

OnVScroll(Object, ScrollEventArgs)

Processes vertical scroll event.

Declaration
protected override void OnVScroll(object sender, ScrollEventArgs se)
Parameters
Type Name Description
System.Object sender

Sender.
System.Windows.Forms.ScrollEventArgs se

ScrollEventArgs.
Overrides

ScrollLines(HybridScrollControl.ScrollDirection, Single)

Scrolls control vertically by specified amount of lines.

Declaration
protected abstract void ScrollLines(HybridScrollControl.ScrollDirection direction, float fLinesCount)
Parameters
Type Name Description
HybridScrollControl.ScrollDirection direction

Direction of scrolling.
System.Single fLinesCount

Count of lines to scroll. Must be always positive.

ScrollLines(Single)

Scrolls control vertically by specified amount of lines.

Declaration
protected void ScrollLines(float fLinesCount)
Parameters
Type Name Description
System.Single fLinesCount

Count of lines to scroll.

ScrollWindow(Int32, Int32)

Scrolls window by specified amounts of pixels.

Declaration
protected void ScrollWindow(int xAmount, int yAmount)
Parameters
Type Name Description
System.Int32 xAmount

X amount to scroll.
System.Int32 yAmount

Y amount to scroll.

UpdateScrollBarsSize()

Updates size and page size of the scrollbars.

Declaration
protected virtual void UpdateScrollBarsSize()

UpdateScrollBarsVisibility()

Updates visibility of the ScrollBars.

Declaration
protected virtual void UpdateScrollBarsVisibility()