-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
MouseEventHandler.xml
81 lines (61 loc) · 4.88 KB
/
MouseEventHandler.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<Type Name="MouseEventHandler" FullName="System.Windows.Input.MouseEventHandler">
<TypeSignature Language="C#" Value="public delegate void MouseEventHandler(object sender, MouseEventArgs e);" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed MouseEventHandler extends System.MulticastDelegate" />
<TypeSignature Language="DocId" Value="T:System.Windows.Input.MouseEventHandler" />
<TypeSignature Language="VB.NET" Value="Public Delegate Sub MouseEventHandler(sender As Object, e As MouseEventArgs)" />
<TypeSignature Language="F#" Value="type MouseEventHandler = delegate of obj * MouseEventArgs -> unit" />
<TypeSignature Language="C++ CLI" Value="public delegate void MouseEventHandler(System::Object ^ sender, MouseEventArgs ^ e);" />
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
</Base>
<Parameters>
<Parameter Name="sender" Type="System.Object" />
<Parameter Name="e" Type="System.Windows.Input.MouseEventArgs" />
</Parameters>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Docs>
<param name="sender">The object where the event handler is attached.</param>
<param name="e">The event data.</param>
<summary>Represents the method that will handle mouse related routed events that do not specifically involve mouse buttons or the mouse wheel; for example, <see cref="E:System.Windows.UIElement.MouseMove" />.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This delegate is used with the following attached events:
- <xref:System.Windows.Input.Mouse.GotMouseCapture?displayProperty=nameWithType>
- <xref:System.Windows.Input.Mouse.LostMouseCapture?displayProperty=nameWithType>
- <xref:System.Windows.Input.Mouse.MouseEnter?displayProperty=nameWithType>
- <xref:System.Windows.Input.Mouse.MouseLeave?displayProperty=nameWithType>
- <xref:System.Windows.Input.Mouse.MouseMove?displayProperty=nameWithType>
- <xref:System.Windows.Input.Mouse.PreviewMouseMove?displayProperty=nameWithType>
This delegate is used with the following routed events. These routed events forward the previously listed attached events to make them more accessible to the general element model in WPF.
- <xref:System.Windows.UIElement.MouseEnter?displayProperty=nameWithType>
- <xref:System.Windows.UIElement.MouseLeave?displayProperty=nameWithType>
- <xref:System.Windows.UIElement.MouseMove?displayProperty=nameWithType>
- <xref:System.Windows.UIElement.PreviewMouseMove?displayProperty=nameWithType>
- <xref:System.Windows.ContentElement.MouseEnter?displayProperty=nameWithType>
- <xref:System.Windows.ContentElement.MouseLeave?displayProperty=nameWithType>
- <xref:System.Windows.ContentElement.MouseMove?displayProperty=nameWithType>
- <xref:System.Windows.ContentElement.PreviewMouseMove?displayProperty=nameWithType>
The attached events and the base element routed events share their event data, and the bubbling and tunneling versions of the routed events also share event data. This can affect the handled characteristics of the event as it travels the event route. For details, see [Input Overview](/dotnet/framework/wpf/advanced/input-overview).
Other than the <xref:System.Windows.RoutedEventArgs> properties that are relevant for all routed events, the most interesting properties of <xref:System.Windows.Input.MouseEventArgs> that you might use in a <xref:System.Windows.Input.MouseEventHandler> implementation are several properties that expose the current button state, such as <xref:System.Windows.Input.MouseEventArgs.LeftButton%2A> and <xref:System.Windows.Input.MouseEventArgs.MouseDevice%2A>. <xref:System.Windows.Input.MouseEventArgs.MouseDevice%2A> is useful particularly because you can check <xref:System.Windows.Input.MouseDevice.Captured%2A> on it.
Note that events that specifically deal with mouse button events use a different delegate, <xref:System.Windows.Input.MouseButtonEventHandler>. The mouse button properties are available on <xref:System.Windows.Input.MouseEventArgs> in case there are input modes or interactions that involve the buttons even if you are handling a non-button event.
]]></format>
</remarks>
<altmember cref="T:System.Windows.Input.MouseEventArgs" />
<altmember cref="T:System.Windows.Input.MouseButtonEventHandler" />
<altmember cref="T:System.Windows.Input.MouseButtonEventArgs" />
<altmember cref="T:System.Windows.Input.Mouse" />
</Docs>
</Type>