This documentation is archived and is not being maintained.

MouseGesture.Matches Method

Determines whether MouseGesture matches the input associated with the specified InputEventArgs object.

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

public override bool Matches(
	Object targetElement,
	InputEventArgs inputEventArgs
)

Parameters

targetElement
Type: System.Object
The target.
inputEventArgs
Type: System.Windows.Input.InputEventArgs
The input event data to compare with this gesture.

Return Value

Type: System.Boolean
true if the event data matches this MouseGesture; otherwise, false.

The following example shows how to test whether a MouseGesture matches the input associated with an instance of an InputEventArgs. A MouseDown event handler compares the event data with the MouseGesture by using the Matches method.


private void OnMouseDown(object sender, MouseEventArgs e)
{
    MouseGesture mouseGesture = new MouseGesture(MouseAction.MiddleClick,ModifierKeys.Control);

    if (mouseGesture.Matches(null, e))
    {
        MessageBox.Show("Trapped Mouse Gesture");
    }
}


.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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

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