DataGridView.HitTest Method (Int32, Int32)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns location information, such as row and column indices, given x- and y-coordinates.

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

Public Function HitTest (
	x As Integer,
	y As Integer
) As DataGridView.HitTestInfo

Parameters

x
Type: System.Int32

The x-coordinate.

y
Type: System.Int32

The y-coordinate.

Return Value

Type: System.Windows.Forms.DataGridView.HitTestInfo

A DataGridView.HitTestInfo that contains the location information.

You can use this method to determine which part of the DataGridView control is located at the specified coordinates. For example, you can call this method—specifying the coordinates of a mouse click—to determine the row and column indexes of the clicked cell or whether a header cell or scroll bar was clicked.

The following code example illustrates the use of this method. This example is part of a larger example available in the Columns property reference topic.

Private clickedCell As DataGridViewCell

Private Sub dataGridView1_MouseDown(ByVal sender As Object, _
    ByVal e As MouseEventArgs) Handles dataGridView1.MouseDown

    ' If the user right-clicks a cell, store it for use by the 
    ' shortcut menu.
    If e.Button = MouseButtons.Right Then
        Dim hit As DataGridView.HitTestInfo = _
            dataGridView1.HitTest(e.X, e.Y)
        If hit.Type = DataGridViewHitTestType.Cell Then
            clickedCell = _
                dataGridView1.Rows(hit.RowIndex).Cells(hit.ColumnIndex)
        End If
    End If

End Sub

.NET Framework
Available since 2.0
Return to top
Show: