111 lines
6.6 KiB
XML
111 lines
6.6 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<Type Name="HandledMouseEventArgs" FullName="System.Windows.Forms.HandledMouseEventArgs">
|
|
<TypeSignature Language="C#" Value="public class HandledMouseEventArgs : System.Windows.Forms.MouseEventArgs" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>System.Windows.Forms</AssemblyName>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
<Base>
|
|
<BaseTypeName>System.Windows.Forms.MouseEventArgs</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Docs>
|
|
<since version=".NET 2.0" />
|
|
<remarks>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>You will want to use <see cref="T:System.Windows.Forms.HandledMouseEventArgs" /> primarily when developing a control that needs to handle mouse wheel events itself, and prevent them from being seen by the control's immediate parent container. <see cref="T:System.Windows.Forms.HandledMouseEventArgs" /> is not passed directly by <see cref="T:System.Windows.Forms.MouseEventHandler" /> when it handles the <see cref="E:System.Windows.Forms.Control.MouseWheel" /> event. Rather, <see cref="T:System.Windows.Forms.MouseEventHandler" /> uses a <see cref="T:System.Windows.Forms.MouseEventArgs" />, which you must cast to a <see cref="T:System.Windows.Forms.HandledMouseEventArgs" /> in order to cancel an occurrence of <see cref="E:System.Windows.Forms.Control.MouseWheel" />. </para>
|
|
</remarks>
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Allows a custom control to prevent the <see cref="E:System.Windows.Forms.Control.MouseWheel" /> event from being sent to its parent container.</para>
|
|
</summary>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public HandledMouseEventArgs (System.Windows.Forms.MouseButtons button, int clicks, int x, int y, int delta);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="button" Type="System.Windows.Forms.MouseButtons" />
|
|
<Parameter Name="clicks" Type="System.Int32" />
|
|
<Parameter Name="x" Type="System.Int32" />
|
|
<Parameter Name="y" Type="System.Int32" />
|
|
<Parameter Name="delta" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Windows.Forms.HandledMouseEventArgs" /> class with the specified mouse button, number of mouse button clicks, horizontal and vertical screen coordinates, and the change of mouse pointer position.</para>
|
|
</summary>
|
|
<param name="button">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.MouseButtons" /> values indicating which mouse button was pressed. </param>
|
|
<param name="clicks">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The number of times a mouse button was pressed. </param>
|
|
<param name="x">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The x-coordinate of a mouse click, in pixels. </param>
|
|
<param name="y">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The y-coordinate of a mouse click, in pixels. </param>
|
|
<param name="delta">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A signed count of the number of detents the wheel has rotated. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public HandledMouseEventArgs (System.Windows.Forms.MouseButtons button, int clicks, int x, int y, int delta, bool defaultHandledValue);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<Parameters>
|
|
<Parameter Name="button" Type="System.Windows.Forms.MouseButtons" />
|
|
<Parameter Name="clicks" Type="System.Int32" />
|
|
<Parameter Name="x" Type="System.Int32" />
|
|
<Parameter Name="y" Type="System.Int32" />
|
|
<Parameter Name="delta" Type="System.Int32" />
|
|
<Parameter Name="defaultHandledValue" Type="System.Boolean" />
|
|
</Parameters>
|
|
<Docs>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Initializes a new instance of the <see cref="T:System.Windows.Forms.HandledMouseEventArgs" /> class with the specified mouse button, number of mouse button clicks, horizontal and vertical screen coordinates, the change of mouse pointer position, and the value indicating whether the event is handled.</para>
|
|
</summary>
|
|
<param name="button">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Windows.Forms.MouseButtons" /> values indicating which mouse button was pressed. </param>
|
|
<param name="clicks">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The number of times a mouse button was pressed. </param>
|
|
<param name="x">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The x-coordinate of a mouse click, in pixels. </param>
|
|
<param name="y">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />The y-coordinate of a mouse click, in pixels. </param>
|
|
<param name="delta">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />A signed count of the number of detents the wheel has rotated. </param>
|
|
<param name="defaultHandledValue">
|
|
<attribution license="cc4" from="Microsoft" modified="false" />true if the event is handled; otherwise, false. </param>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
<Member MemberName="Handled">
|
|
<MemberSignature Language="C#" Value="public bool Handled { set; get; }" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Docs>
|
|
<value>To be added.</value>
|
|
<remarks>To be added.</remarks>
|
|
<since version=".NET 2.0" />
|
|
<summary>
|
|
<attribution license="cc4" from="Microsoft" modified="false" />
|
|
<para>Gets or sets whether this event should be forwarded to the control's parent container.</para>
|
|
</summary>
|
|
</Docs>
|
|
<AssemblyInfo>
|
|
<AssemblyVersion>2.0.0.0</AssemblyVersion>
|
|
</AssemblyInfo>
|
|
</Member>
|
|
</Members>
|
|
</Type> |