MouseWheelEventArgs Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

Provides data for the MouseWheel routed event.

Inheritance Hierarchy

System.Object
  System.EventArgs
    System.Windows.RoutedEventArgs
      System.Windows.Input.MouseEventArgs
        System.Windows.Input.MouseWheelEventArgs

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

Syntax

'Declaration
Public NotInheritable Class MouseWheelEventArgs _
    Inherits MouseEventArgs
public sealed class MouseWheelEventArgs : MouseEventArgs

The MouseWheelEventArgs type exposes the following members.

Properties

  Name Description
Public propertySupported by Silverlight for Windows Phone Delta Gets a value that indicates the amount that the mouse wheel rotated relative to its starting state or to the last occurrence of the event.
Public propertySupported by Silverlight for Windows Phone Handled Gets or sets a value that marks the routed event as handled, and prevents most handlers along the event route from rehandling the same event.
Public propertySupported by Silverlight for Windows Phone OriginalSource Gets a reference to the object that raised the event. (Inherited from RoutedEventArgs.)
Public propertySupported by Silverlight for Windows Phone StylusDevice Gets an object that reports stylus device information, such as the collection of stylus points associated with the input. (Inherited from MouseEventArgs.)

Top

Methods

  Name Description
Public methodSupported by Silverlight for Windows Phone Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows Phone Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone GetPosition Returns the x- and y-coordinates of the mouse pointer position, optionally evaluated against a coordinate origin of a supplied UIElement. (Inherited from MouseEventArgs.)
Public methodSupported by Silverlight for Windows Phone GetType Gets the Type of the current instance. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows Phone MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

Because MouseWheel is a routed event, it can invoke handlers on objects other than the object that raised the event. For more information about routed events, see Events Overview for Silverlight. MouseWheelEventArgs has a Handled property, which enables marking the event as handled and shortens the event route in all but exceptional handling cases.

Handling the events that are generated by the mouse wheel might also involve handling HTML Document Object Model (DOM) events. For more information, see Mouse Wheel Input.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

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

See Also

Reference