MouseButtonEventArgs Class

Reference

Definition

Namespace:: System.Windows.Input

Assembly:: PresentationCore.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides data for mouse button related events.

public ref class MouseButtonEventArgs : System::Windows::Input::MouseEventArgs

public class MouseButtonEventArgs : System.Windows.Input.MouseEventArgs

type MouseButtonEventArgs = class
    inherit MouseEventArgs

Public Class MouseButtonEventArgs
Inherits MouseEventArgs

Inheritance: Object

EventArgs

RoutedEventArgs

InputEventArgs

MouseEventArgs
MouseButtonEventArgs

Examples

The following example creates a mouse button event handler that changes the color of the object that raised the event. The color chosen depends on the mouse button which was pressed. The ChangedButton property is checked to determine which button was pressed.

private void MouseButtonDownHandler(object sender, MouseButtonEventArgs e)
{
    Control src = e.Source as Control;

    if (src != null)
    {
        switch (e.ChangedButton)
        {
            case MouseButton.Left:
                src.Background = Brushes.Green;
                break;
            case MouseButton.Middle:
                src.Background = Brushes.Red;
                break;
            case MouseButton.Right:
                src.Background = Brushes.Yellow;
                break;
            case MouseButton.XButton1:
                src.Background = Brushes.Brown;
                break;
            case MouseButton.XButton2:
                src.Background = Brushes.Purple;
                break;
            default:
                break;
        }
    }
}

Private Sub MouseButtonDownHandler(ByVal sender As Object, ByVal e As MouseButtonEventArgs)
    Dim src As Control = TryCast(e.Source, Control)

    If src IsNot Nothing Then
        Select Case e.ChangedButton
            Case MouseButton.Left
                src.Background = Brushes.Green
            Case MouseButton.Middle
                src.Background = Brushes.Red
            Case MouseButton.Right
                src.Background = Brushes.Yellow
            Case MouseButton.XButton1
                src.Background = Brushes.Brown
            Case MouseButton.XButton2
                src.Background = Brushes.Purple
            Case Else
        End Select
    End If
End Sub

Remarks

MouseButtonEventArgs is used with the following events: MouseDown, MouseUp, MouseLeftButtonDown, MouseLeftButtonUp, MouseRightButtonDown, MouseRightButtonUp, and the corresponding tunneling events.

The Mouse class provides additional properties and methods for determining the state of the mouse.

Constructors

MouseButtonEventArgs(MouseDevice, Int32, MouseButton, StylusDevice)	Initializes a new instance of the MouseButtonEventArgs class by using the specified MouseDevice, timestamp, MouseButton, and StylusDevice. .
MouseButtonEventArgs(MouseDevice, Int32, MouseButton)	Initializes a new instance of the MouseButtonEventArgs class by using the specified MouseDevice, timestamp, and MouseButton.

Properties

ButtonState	Gets the state of the button associated with the event.
ChangedButton	Gets the button associated with the event.
ClickCount	Gets the number of times the button was clicked.
Device	Gets the input device that initiated this event. (Inherited from InputEventArgs)
Handled	Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. (Inherited from RoutedEventArgs)
LeftButton	Gets the current state of the left mouse button. (Inherited from MouseEventArgs)
MiddleButton	Gets the current state of the middle mouse button. (Inherited from MouseEventArgs)
MouseDevice	Gets the mouse device associated with this event. (Inherited from MouseEventArgs)
OriginalSource	Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. (Inherited from RoutedEventArgs)
RightButton	Gets the current state of the right mouse button. (Inherited from MouseEventArgs)
RoutedEvent	Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. (Inherited from RoutedEventArgs)
Source	Gets or sets a reference to the object that raised the event. (Inherited from RoutedEventArgs)
StylusDevice	Gets the stylus device associated with this event. (Inherited from MouseEventArgs)
Timestamp	Gets the time when this event occurred. (Inherited from InputEventArgs)
XButton1	Gets the current state of the first extended mouse button. (Inherited from MouseEventArgs)
XButton2	Gets the state of the second extended mouse button. (Inherited from MouseEventArgs)

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetPosition(IInputElement)	Returns the position of the mouse pointer relative to the specified element. (Inherited from MouseEventArgs)
GetType()	Gets the Type of the current instance. (Inherited from Object)
InvokeEventHandler(Delegate, Object)	Invokes event handlers in a type-specific way, which can increase event system efficiency.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnSetSource(Object)	When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. (Inherited from RoutedEventArgs)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Jaa