OnScroll Method (UltraScrollBar)

Raises the Scroll event when the Value property changes.

Syntax

Visual Basic

'Declaration
 
Protected Overridable Sub OnScroll( _
   ByVal e As ScrollEventArgs _
) 

C#

protected virtual void OnScroll( 
   ScrollEventArgs e
)

Parameters

e

An System.Windows.Forms.ScrollEventArgs that provides data for the event.

Remarks

Raising an event invokes the event handler through a delegate.

The OnScroll method also allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

Notes to Inheritors: When overriding OnScroll in a derived class, be sure to call the base class's OnScroll method so that registered delegates receive the event.

Example

The following sample code illustrates the information available in the UltraScrollBar's Scroll event.

For an overview of how to handle events in Visual Basic or Visual C#, see Event Handlers in Visual Basic and Visual C#. For specific information and code examples illustrating how to consume events in your application, see Consuming Events in the .NET Framework Developer's Guide.

Visual Basic

Imports Infragistics.Win
Imports Infragistics.Win.UltraWinScrollBar

Private Sub ultraScrollBar1_Scroll(ByVal sender As System.Object, ByVal e As System.Windows.Forms.ScrollEventArgs) Handles ultraScrollBar1.Scroll

    Dim scrollbar As UltraScrollBar = sender

    If scrollbar.Orientation = Orientation.Vertical Then
        Debug.WriteLine("Vertical scrollbar scrolled")
    Else
        Debug.WriteLine("Horizontal scrollbar scrolled")
    End If

    Debug.WriteLine("ScrollEventType: " + e.Type.ToString())
    Debug.WriteLine("Scrolled to: " + e.NewValue.ToString())

End Sub

C#

using System.Diagnostics;
using Infragistics.Win;
using Infragistics.Win.UltraWinScrollBar;

private void ultraScrollBar1_Scroll(object sender, System.Windows.Forms.ScrollEventArgs e)
{

	UltraScrollBar scrollbar = sender as UltraScrollBar;

	if ( scrollbar.Orientation == Orientation.Vertical )
		Debug.WriteLine( "Vertical scrollbar scrolled");
	else
		Debug.WriteLine( "Horizontal scrollbar scrolled");

	Debug.WriteLine( "ScrollEventType: " + e.Type.ToString());
	Debug.WriteLine( "Scrolled to: " + e.NewValue.ToString());

}

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2