Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ScrollEventArgs Class

 

Provides data for the Scroll event.

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

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

[ComVisibleAttribute(true)]
public class ScrollEventArgs : EventArgs

NameDescription
System_CAPS_pubmethodScrollEventArgs(ScrollEventType, Int32)

Initializes a new instance of the ScrollEventArgs class using the given values for the Type and NewValue properties.

System_CAPS_pubmethodScrollEventArgs(ScrollEventType, Int32, Int32)

Initializes a new instance of the ScrollEventArgs class using the given values for the Type, OldValue, and NewValue properties.

System_CAPS_pubmethodScrollEventArgs(ScrollEventType, Int32, Int32, ScrollOrientation)

Initializes a new instance of the ScrollEventArgs class using the given values for the Type, OldValue, NewValue, and ScrollOrientation properties.

System_CAPS_pubmethodScrollEventArgs(ScrollEventType, Int32, ScrollOrientation)

Initializes a new instance of the ScrollEventArgs class using the given values for the Type, NewValue, and ScrollOrientation properties.

NameDescription
System_CAPS_pubpropertyNewValue

Gets or sets the new Value of the scroll bar.

System_CAPS_pubpropertyOldValue

Gets the old Value of the scroll bar.

System_CAPS_pubpropertyScrollOrientation

Gets the scroll bar orientation that raised the Scroll event.

System_CAPS_pubpropertyType

Gets the type of scroll event that occurred.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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 void AddMyScrollEventHandlers()
 {
    // Create and initialize a VScrollBar.
    VScrollBar vScrollBar1 = new VScrollBar();

    // Add event handlers for the OnScroll and OnValueChanged events.
    vScrollBar1.Scroll += new ScrollEventHandler(
       this.vScrollBar1_Scroll);
    vScrollBar1.ValueChanged += new EventHandler(
       this.vScrollBar1_ValueChanged); 
 }

 // Create the ValueChanged event handler.
 private void vScrollBar1_ValueChanged(Object sender, 
                                       EventArgs e)
 {
     // Display the new value in the label.
     label1.Text = "vScrollBar Value:(OnValueChanged Event) " + vScrollBar1.Value.ToString();
 }

 // Create the Scroll event handler.
 private void vScrollBar1_Scroll(Object sender, 
                                 ScrollEventArgs e)
 {
     // Display the new value in the label.
     label1.Text = "VScrollBar Value:(OnScroll Event) " + e.NewValue.ToString();
 }

 private void button1_Click(Object sender, 
                           EventArgs e)
 {
    // Add 40 to the Value property if it will not exceed the Maximum value.
    if (vScrollBar1.Value + 40 < vScrollBar1.Maximum)
    {
        vScrollBar1.Value = vScrollBar1.Value + 40;
    }
 }

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: