DataGridView.HitTest(Int32, Int32) Method

  • Reference

Definition

Namespace:
System.Windows.Forms
Assembly:
System.Windows.Forms.dll

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

public:
 System::Windows::Forms::DataGridView::HitTestInfo ^ HitTest(int x, int y);
public System.Windows.Forms.DataGridView.HitTestInfo HitTest (int x, int y);
member this.HitTest : int * int -> System.Windows.Forms.DataGridView.HitTestInfo
Public Function HitTest (x As Integer, y As Integer) As DataGridView.HitTestInfo

Parameters

x
Int32

The x-coordinate.

y
Int32

The y-coordinate.

Returns

DataGridView.HitTestInfo

A DataGridView.HitTestInfo that contains the location information.

Examples

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 DataGridViewCell clickedCell;

private void dataGridView1_MouseDown(object sender, MouseEventArgs e)
{
// If the user right-clicks a cell, store it for use by the shortcut menu.
    if (e.Button == MouseButtons.Right)
    {
        DataGridView.HitTestInfo hit = dataGridView1.HitTest(e.X, e.Y);
        if (hit.Type == DataGridViewHitTestType.Cell)
        {
            clickedCell =
                dataGridView1.Rows[hit.RowIndex].Cells[hit.ColumnIndex];
        }
    }
}

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

Remarks

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.

Applies to

See also