ScrollEventArgs Class

Provides data for the Scroll event.

System.Object
  System.EventArgs
    System.Windows.Forms.ScrollEventArgs

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

'Declaration
<ComVisibleAttribute(True)> _
Public Class ScrollEventArgs _
	Inherits EventArgs

The ScrollEventArgs type exposes the following members.

  NameDescription
Public methodScrollEventArgs(ScrollEventType, Int32)Initializes a new instance of the ScrollEventArgs class using the given values for the Type and NewValue properties.
Public methodScrollEventArgs(ScrollEventType, Int32, Int32)Initializes a new instance of the ScrollEventArgs class using the given values for the Type, OldValue, and NewValue properties.
Public methodScrollEventArgs(ScrollEventType, Int32, ScrollOrientation)Initializes a new instance of the ScrollEventArgs class using the given values for the Type, NewValue, and ScrollOrientation properties.
Public methodScrollEventArgs(ScrollEventType, Int32, Int32, ScrollOrientation)Initializes a new instance of the ScrollEventArgs class using the given values for the Type, OldValue, NewValue, and ScrollOrientation properties.
Top

  NameDescription
Public propertyNewValueGets or sets the new Value of the scroll bar.
Public propertyOldValueGets the old Value of the scroll bar.
Public propertyScrollOrientationGets the scroll bar orientation that raised the Scroll event.
Public propertyTypeGets the type of scroll event that occurred.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

The Scroll event occurs when the user changes the value of the scroll bar. This event can result from a variety of actions, such as clicking a scroll bar arrow, pressing the UP ARROW or DOWN ARROW, or dragging the scroll box. The ScrollEventArgs specifies the type of scroll event that occurred and the new value of the scroll bar. Use the ScrollOrientation property to determine the scroll bar orientation for the Scroll event.

The Scroll event occurs for the DataGridView, ScrollableControl, ScrollBar, and DataGrid controls.

The following code example demonstrates the use of this member.

    Private Sub AddMyScrollEventHandlers()
        ' Create and initialize a VScrollBar. 
        Dim vScrollBar1 As New VScrollBar()

        ' Add event handlers for the OnScroll and OnValueChanged events. 
        AddHandler vScrollBar1.Scroll, AddressOf Me.vScrollBar1_Scroll
        AddHandler vScrollBar1.ValueChanged, AddressOf Me.vScrollBar1_ValueChanged
    End Sub     

    ' Create the ValueChanged event handler. 
    Private Sub vScrollBar1_ValueChanged(sender As Object, e As EventArgs)
        ' Display the new value in the label.
        label1.Text = "vScrollBar Value:(OnValueChanged Event) " & _
            vScrollBar1.Value.ToString()
    End Sub     

    ' Create the Scroll event handler. 
    Private Sub vScrollBar1_Scroll(sender As Object, e As ScrollEventArgs)
        ' Display the new value in the label.
        label1.Text = "VScrollBar Value:(OnScroll Event) " & _
            e.NewValue.ToString()
    End Sub     

    Private Sub button1_Click(sender As Object, e As EventArgs)
        ' Add 40 to the Value property if it will not exceed the Maximum value. 
        If vScrollBar1.Value + 40 < vScrollBar1.Maximum Then
            vScrollBar1.Value = vScrollBar1.Value + 40
        End If 
    End Sub

.NET Framework

Supported in: 4.6, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft