DataGrid+HitTestInfo.xml

<Type Name="DataGrid+HitTestInfo" FullName="System.Windows.Forms.DataGrid+HitTestInfo">
  <TypeSignature Language="C#" Value="public sealed class DataGrid.HitTestInfo" />
  <TypeSignature Language="ILAsm" Value=".class nested public auto ansi sealed beforefieldinit DataGrid/HitTestInfo extends System.Object" />
  <TypeSignature Language="DocId" Value="T:System.Windows.Forms.DataGrid.HitTestInfo" />
  <TypeSignature Language="VB.NET" Value="Public NotInheritable Class DataGrid.HitTestInfo" />
  <TypeSignature Language="F#" Value="type DataGrid.HitTestInfo = class" />
  <TypeSignature Language="C++ CLI" Value="public: ref class DataGrid::HitTestInfo sealed" />
  <AssemblyInfo>
    <AssemblyName>System.Windows.Forms</AssemblyName>
    <AssemblyVersion>1.0.5000.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
    <AssemblyVersion>4.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Contains information about a part of the <see cref="T:System.Windows.Forms.DataGrid" /> at a specified coordinate. This class cannot be inherited.</summary>
    <remarks>
      <format type="text/markdown"><![CDATA[  
  
## Remarks  
 The <xref:System.Windows.Forms.DataGrid.HitTestInfo> class, in conjunction with the <xref:System.Windows.Forms.DataGrid.HitTest%2A> method of the <xref:System.Windows.Forms.DataGrid> control, is used to determine which part of a <xref:System.Windows.Forms.DataGrid> control the user has clicked. The <xref:System.Windows.Forms.DataGrid.HitTestInfo> class contains the row, column, and part of the grid that was clicked. See the <xref:System.Windows.Forms.DataGrid.HitTestType> enumeration returned by the <xref:System.Windows.Forms.DataGrid.HitTestInfo.Type%2A> property for a complete list of grid parts.  
  
 To return a <xref:System.Windows.Forms.DataGrid.HitTestInfo>, invoke the <xref:System.Windows.Forms.DataGrid.HitTest%2A> method from the <xref:System.Windows.Forms.Control.MouseDown> event of <xref:System.Windows.Forms.DataGrid> control. Pass the `x` and `y` properties of the <xref:System.Windows.Forms.MouseEventArgs> to the <xref:System.Windows.Forms.DataGrid.HitTest%2A> method.  
  
   
  
## Examples  
 The following example uses the <xref:System.Windows.Forms.DataGrid.HitTest%2A> method in a <xref:System.Windows.Forms.Control.MouseDown> event to return the <xref:System.Windows.Forms.DataGrid.HitTestInfo> object. The row, column, and part of the grid are then printed.  
  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/Classic DataGrid.HitTestInfo Example/CPP/source.cpp" id="Snippet1":::
 :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/DataGrid+HitTestInfo/Overview/source.cs" id="Snippet1":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic DataGrid.HitTestInfo Example/VB/source.vb" id="Snippet1":::  
  
 ]]></format>
    </remarks>
    <altmember cref="P:System.Windows.Forms.DataGrid.CurrentCell" />
    <altmember cref="M:System.Windows.Forms.DataGrid.GetCellBounds(System.Int32,System.Int32)" />
    <altmember cref="M:System.Windows.Forms.DataGrid.HitTest(System.Int32,System.Int32)" />
    <altmember cref="T:System.Windows.Forms.DataGrid.HitTestType" />
  </Docs>
  <Members>
    <Member MemberName="Column">
      <MemberSignature Language="C#" Value="public int Column { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 Column" />
      <MemberSignature Language="DocId" Value="P:System.Windows.Forms.DataGrid.HitTestInfo.Column" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Column As Integer" />
      <MemberSignature Language="F#" Value="member this.Column : int" Usage="System.Windows.Forms.DataGrid.HitTestInfo.Column" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property int Column { int get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Windows.Forms</AssemblyName>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the number of the column the user has clicked.</summary>
        <value>The number of the column.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 If the coordinate is not a cell, the property returns -1.  
  
   
  
## Examples  
 The following example prints the numbers of the clicked row and column by calling the <xref:System.Windows.Forms.DataGrid.HitTest%2A> method from within the <xref:System.Windows.Forms.Control.MouseDown> event of a <xref:System.Windows.Forms.DataGrid?displayProperty=nameWithType> control. This returns a <xref:System.Windows.Forms.DataGrid.HitTestInfo> object.  
  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/Classic DataGrid.HitTestInfo.Column Example/CPP/source.cpp" id="Snippet1":::
 :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/DataGrid+HitTestInfo/Column/source.cs" id="Snippet1":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic DataGrid.HitTestInfo.Column Example/VB/source.vb" id="Snippet1":::  
  
 ]]></format>
        </remarks>
        <altmember cref="T:System.Windows.Forms.DataGrid" />
        <altmember cref="T:System.Windows.Forms.DataGrid.HitTestType" />
        <altmember cref="M:System.Windows.Forms.DataGrid.HitTest(System.Int32,System.Int32)" />
      </Docs>
    </Member>
    <Member MemberName="Equals">
      <MemberSignature Language="C#" Value="public override bool Equals (object value);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object value) cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Windows.Forms.DataGrid.HitTestInfo.Equals(System.Object)" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (value As Object) As Boolean" />
      <MemberSignature Language="F#" Value="override this.Equals : obj -&gt; bool" Usage="hitTestInfo.Equals value" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; override bool Equals(System::Object ^ value);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Windows.Forms</AssemblyName>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="value" Type="System.Object" />
      </Parameters>
      <Docs>
        <param name="value">The second object to compare, typed as <see cref="T:System.Object" />.</param>
        <summary>Indicates whether two objects are identical.</summary>
        <returns>
          <see langword="true" /> if the objects are equal; otherwise, <see langword="false" />.</returns>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Examples  
 The following example tests whether the user is clicking an area of the grid that is not valid.  
  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/Classic DataGrid.HitTestInfo.Nowhere Example/CPP/source.cpp" id="Snippet1":::
 :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/DataGrid+HitTestInfo/Equals/source.cs" id="Snippet1":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic DataGrid.HitTestInfo.Nowhere Example/VB/source.vb" id="Snippet1":::  
  
 ]]></format>
        </remarks>
        <altmember cref="M:System.Windows.Forms.DataGrid.HitTest(System.Int32,System.Int32)" />
        <altmember cref="T:System.Windows.Forms.DataGrid" />
        <altmember cref="F:System.Windows.Forms.DataGrid.HitTestInfo.Nowhere" />
      </Docs>
    </Member>
    <Member MemberName="GetHashCode">
      <MemberSignature Language="C#" Value="public override int GetHashCode ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Windows.Forms.DataGrid.HitTestInfo.GetHashCode" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
      <MemberSignature Language="F#" Value="override this.GetHashCode : unit -&gt; int" Usage="hitTestInfo.GetHashCode " />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; override int GetHashCode();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Windows.Forms</AssemblyName>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Gets the hash code for the <see cref="T:System.Windows.Forms.DataGrid.HitTestInfo" /> instance.</summary>
        <returns>The hash code for this instance.</returns>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 This method overrides <xref:System.Object.GetHashCode%2A>.  
  
   
  
## Examples  
 The following example prints the hash code of the <xref:System.Windows.Forms.DataGrid.HitTestInfo>.  
  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/Classic DataGrid.HitTestInfo.GetHashCode Example/CPP/source.cpp" id="Snippet1":::
 :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/DataGrid+HitTestInfo/GetHashCode/source.cs" id="Snippet1":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic DataGrid.HitTestInfo.GetHashCode Example/VB/source.vb" id="Snippet1":::  
  
 ]]></format>
        </remarks>
        <altmember cref="T:System.Windows.Forms.DataGrid" />
        <altmember cref="T:System.Windows.Forms.DataGrid.HitTestType" />
        <altmember cref="M:System.Windows.Forms.DataGrid.HitTest(System.Int32,System.Int32)" />
      </Docs>
    </Member>
    <Member MemberName="Nowhere">
      <MemberSignature Language="C#" Value="public static readonly System.Windows.Forms.DataGrid.HitTestInfo Nowhere;" />
      <MemberSignature Language="ILAsm" Value=".field public static initonly class System.Windows.Forms.DataGrid/HitTestInfo Nowhere" />
      <MemberSignature Language="DocId" Value="F:System.Windows.Forms.DataGrid.HitTestInfo.Nowhere" />
      <MemberSignature Language="VB.NET" Value="Public Shared ReadOnly Nowhere As DataGrid.HitTestInfo " />
      <MemberSignature Language="F#" Value=" staticval mutable Nowhere : System.Windows.Forms.DataGrid.HitTestInfo" Usage="System.Windows.Forms.DataGrid.HitTestInfo.Nowhere" />
      <MemberSignature Language="C++ CLI" Value="public: static initonly System::Windows::Forms::DataGrid::HitTestInfo ^ Nowhere;" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Windows.Forms</AssemblyName>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Windows.Forms.DataGrid+HitTestInfo</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Indicates that a coordinate corresponds to part of the <see cref="T:System.Windows.Forms.DataGrid" /> control that is not functioning.</summary>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 Other parts of the <xref:System.Windows.Forms.DataGrid?displayProperty=nameWithType>, such as the <xref:System.Windows.Forms.DataGrid.HitTestType.Caption>, can return useful information. If the part of the grid has no function (such as the gray area behind a sparsely populated grid table), the <xref:System.Windows.Forms.DataGrid.HitTestInfo.Nowhere> field is returned.  
  
   
  
## Examples  
 The following example tests whether the user is clicking an area of the grid that is not valid.  
  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/Classic DataGrid.HitTestInfo.Nowhere Example/CPP/source.cpp" id="Snippet1":::
 :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/DataGrid+HitTestInfo/Equals/source.cs" id="Snippet1":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic DataGrid.HitTestInfo.Nowhere Example/VB/source.vb" id="Snippet1":::  
  
 ]]></format>
        </remarks>
        <altmember cref="T:System.Windows.Forms.DataGrid" />
        <altmember cref="M:System.Windows.Forms.DataGrid.HitTestInfo.Equals(System.Object)" />
        <altmember cref="T:System.Windows.Forms.DataGrid.HitTestType" />
        <altmember cref="M:System.Windows.Forms.DataGrid.HitTest(System.Int32,System.Int32)" />
      </Docs>
    </Member>
    <Member MemberName="Row">
      <MemberSignature Language="C#" Value="public int Row { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 Row" />
      <MemberSignature Language="DocId" Value="P:System.Windows.Forms.DataGrid.HitTestInfo.Row" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Row As Integer" />
      <MemberSignature Language="F#" Value="member this.Row : int" Usage="System.Windows.Forms.DataGrid.HitTestInfo.Row" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property int Row { int get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Windows.Forms</AssemblyName>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the number of the row the user has clicked.</summary>
        <value>The number of the clicked row.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Remarks  
 If the coordinate is not a cell, the property returns -1. If the coordinate is a <xref:System.Windows.Forms.DataGrid.HitTestType.RowHeader>, the property returns the row number of the header, but the <xref:System.Windows.Forms.DataGrid.HitTestInfo.Column%2A> property will return -1.  
  
   
  
## Examples  
 The following example prints the number of the clicked row and column by calling the <xref:System.Windows.Forms.DataGrid.HitTest%2A> method from within the <xref:System.Windows.Forms.Control.MouseDown> event of a <xref:System.Windows.Forms.DataGrid?displayProperty=nameWithType> control. This returns a <xref:System.Windows.Forms.DataGrid.HitTestInfo> object.  
  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/Classic DataGrid.HitTestInfo.Row Example/CPP/source.cpp" id="Snippet1":::
 :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/DataGrid+HitTestInfo/Row/source.cs" id="Snippet1":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic DataGrid.HitTestInfo.Row Example/VB/source.vb" id="Snippet1":::  
  
 ]]></format>
        </remarks>
        <altmember cref="T:System.Windows.Forms.DataGrid" />
        <altmember cref="T:System.Windows.Forms.DataGrid.HitTestType" />
        <altmember cref="M:System.Windows.Forms.DataGrid.HitTest(System.Int32,System.Int32)" />
      </Docs>
    </Member>
    <Member MemberName="ToString">
      <MemberSignature Language="C#" Value="public override string ToString ();" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
      <MemberSignature Language="DocId" Value="M:System.Windows.Forms.DataGrid.HitTestInfo.ToString" />
      <MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
      <MemberSignature Language="F#" Value="override this.ToString : unit -&gt; string" Usage="hitTestInfo.ToString " />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; override System::String ^ ToString();" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Windows.Forms</AssemblyName>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.String</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>Gets the type, row number, and column number.</summary>
        <returns>The type, row number, and column number.</returns>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Examples  
 The following example prints the type, row number, and column number when the user clicks the <xref:System.Windows.Forms.DataGrid?displayProperty=nameWithType>.  
  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/Classic DataGrid.HitTestInfo.ToString Example/CPP/source.cpp" id="Snippet1":::
 :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/DataGrid+HitTestInfo/ToString/source.cs" id="Snippet1":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic DataGrid.HitTestInfo.ToString Example/VB/source.vb" id="Snippet1":::  
  
 ]]></format>
        </remarks>
        <altmember cref="T:System.Windows.Forms.DataGrid" />
        <altmember cref="T:System.Windows.Forms.DataGrid.HitTestType" />
        <altmember cref="M:System.Windows.Forms.DataGrid.HitTest(System.Int32,System.Int32)" />
      </Docs>
    </Member>
    <Member MemberName="Type">
      <MemberSignature Language="C#" Value="public System.Windows.Forms.DataGrid.HitTestType Type { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance valuetype System.Windows.Forms.DataGrid/HitTestType Type" />
      <MemberSignature Language="DocId" Value="P:System.Windows.Forms.DataGrid.HitTestInfo.Type" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Type As DataGrid.HitTestType" />
      <MemberSignature Language="F#" Value="member this.Type : System.Windows.Forms.DataGrid.HitTestType" Usage="System.Windows.Forms.DataGrid.HitTestInfo.Type" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Windows::Forms::DataGrid::HitTestType Type { System::Windows::Forms::DataGrid::HitTestType get(); };" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>System.Windows.Forms</AssemblyName>
        <AssemblyVersion>1.0.5000.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
        <AssemblyVersion>4.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute FrameworkAlternate="netframework-4.0">
          <AttributeName Language="C#">[get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
          <AttributeName Language="F#">[&lt;get: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")&gt;]</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Windows.Forms.DataGrid+HitTestType</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets the part of the <see cref="T:System.Windows.Forms.DataGrid" /> control, other than the row or column, that was clicked.</summary>
        <value>One of the <see cref="T:System.Windows.Forms.DataGrid.HitTestType" /> enumerations.</value>
        <remarks>
          <format type="text/markdown"><![CDATA[  
  
## Examples  
 The following example prints the clicked part of the grid by calling the <xref:System.Windows.Forms.DataGrid.HitTest%2A> method from within the <xref:System.Windows.Forms.Control.MouseDown> event of a <xref:System.Windows.Forms.DataGrid?displayProperty=nameWithType> control. This returns a <xref:System.Windows.Forms.DataGrid.HitTestInfo> object.  
  
 :::code language="cpp" source="~/snippets/cpp/VS_Snippets_Winforms/Classic DataGrid.HitTestInfo.Type Example/CPP/source.cpp" id="Snippet1":::
 :::code language="csharp" source="~/snippets/csharp/System.Windows.Forms/DataGrid+HitTestInfo/Type/source.cs" id="Snippet1":::
 :::code language="vb" source="~/snippets/visualbasic/VS_Snippets_Winforms/Classic DataGrid.HitTestInfo.Type Example/VB/source.vb" id="Snippet1":::  
  
 ]]></format>
        </remarks>
        <altmember cref="T:System.Windows.Forms.DataGrid" />
        <altmember cref="T:System.Windows.Forms.DataGrid.HitTestType" />
        <altmember cref="M:System.Windows.Forms.DataGrid.HitTest(System.Int32,System.Int32)" />
      </Docs>
    </Member>
  </Members>
</Type>