GridView.CalcHitInfo(Point) Method

Returns information about View elements located at a specified point.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

public GridHitInfo CalcHitInfo(
    Point pt
)

VB.NET

Public Function CalcHitInfo(
    pt As Point
) As GridHitInfo

Parameters

Name	Type	Description
pt	Point	A Point structure specifying test point coordinates relative to the grid control’s top-left corner.

Returns

Type	Description
GridHitInfo	A GridHitInfo object that contains information about View elements located at the test point.

Remarks

Use the CalcHitInfo method to determine which element is located at a specified point. For instance, this can be used when handling the View’s Click event to determine which element was clicked. In such instances, you will pass the current mouse pointer’s coordinates as the method’s parameter.

Please refer to the GridHitInfo class description for details on what information is provided by the method’s return value. The Hit Information topic provides general information on obtaining and using hit information.

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the CalcHitInfo member must not be invoked for these Views. The CalcHitInfo member can only be used with real Views that are displayed within the Grid Control. The real Views with which an end-user interacts at runtime can be accessed using the following methods.

• GridControl.MainView - returns the top most View in a grid;
• GridControl.FocusedView - returns the focused View;
• GridControl.DefaultView - returns the currently maximized View;
• the sender parameter of View specific events;
• GridView.GetDetailView - returns a detail clone View for a specific master row.

Example

The following sample code shows how to identify the element located at a specific point using the GridView.CalcHitInfo method.

In the example, the CalcHitInfo method is called when you move the cursor over a Grid Control. The name of the current View element is displayed in the form’s caption.

C#

using DevExpress.XtraGrid;
using DevExpress.XtraGrid.Views.Base;
using DevExpress.XtraGrid.Views.Base.ViewInfo;
using DevExpress.XtraGrid.Views.Grid.ViewInfo;
// ...
private void gridControl1_MouseMove(object sender, MouseEventArgs e) {
    GridControl grid = sender as GridControl;
    if (grid == null) return;
    // Get a View at the current point.
    BaseView view = grid.GetViewAt(e.Location);
    if (view == null) return;
    // Retrieve information on the current View element.
    BaseHitInfo baseHI = view.CalcHitInfo(e.Location);
    GridHitInfo gridHI = baseHI as GridHitInfo;
    if (gridHI != null)
        Text = gridHI.HitTest.ToString();
}

VB.NET

Imports DevExpress.XtraGrid
Imports DevExpress.XtraGrid.Views.Base
Imports DevExpress.XtraGrid.Views.Base.ViewInfo
Imports DevExpress.XtraGrid.Views.Grid.ViewInfo
' ...
Private Sub GridControl1_MouseMove(ByVal sender As System.Object, _
  ByVal e As System.Windows.Forms.MouseEventArgs) _
  Handles GridControl1.MouseMove
    Dim grid As GridControl = sender
    If grid Is Nothing Then
        Return
    End If
    ' Get a View at the current point.
    Dim view As BaseView = grid.GetViewAt(e.Location)
    If view Is Nothing Then
        Return
    End If
    ' Retrieve information on the current View element.
    Dim baseHI As BaseHitInfo = view.CalcHitInfo(e.Location)
    Dim gridHI As GridHitInfo = TryCast(baseHI, GridHitInfo)
    If Not gridHI Is Nothing Then
        Text = gridHI.HitTest.ToString()
    End If
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the CalcHitInfo(Point) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

winforms-grid-custom-button-in-column-header/CS/WindowsApplication3/ColumnHeaderExtender.cs#L52

void OnMouseUp(object sender, MouseEventArgs e) {
    GridHitInfo hitInfo = view.CalcHitInfo(e.Location);
    if(hitInfo.HitTest != GridHitTest.Column) return;

how-to-provide-sorting-functionality-for-the-grid-that-allows-drag-and-drop-row-reordering-e3149/CS/E3149/Form1.cs#L319

GridHitInfo hitInfo = view.CalcHitInfo(new Point(e.X, e.Y));
if ( Control.ModifierKeys != Keys.None )

drag-and-drop-between-detail-views-when-using-linq-to-sql-e1502/CS/mainForm.cs#L53

if (e.Button != MouseButtons.Left) return;
GridHitInfo hInfo = ((GridView)sender).CalcHitInfo(e.Location);
if (!hInfo.InRowCell) return;

how-to-drop-a-grid-column-header-onto-another-control-e4912/CS/Form1.cs#L32

var gridView = sender as GridView;
var hi = gridView.CalcHitInfo(gridView.GridControl.PointToClient(Cursor.Position));
if (hi.HitTest != GridHitTest.None && hi.HitTest != GridHitTest.Column) {

how-to-enable-editing-in-a-group-row-so-it-is-possible-to-change-child-cell-values-e3036/CS/WindowsApplication3/GroupEditProvider.cs#L93

{
    GridHitInfo hitInfo = view.CalcHitInfo(e.Location);
    if (hitInfo.HitTest == GridHitTest.Row && view.IsGroupRow(hitInfo.RowHandle))

VB.NET

winforms-grid-custom-button-in-column-header/VB/WindowsApplication3/ColumnHeaderExtender.vb#L52

Private Sub OnMouseUp(ByVal sender As Object, ByVal e As MouseEventArgs)
    Dim hitInfo As GridHitInfo = view.CalcHitInfo(e.Location)
    If hitInfo.HitTest <> GridHitTest.Column Then

how-to-provide-sorting-functionality-for-the-grid-that-allows-drag-and-drop-row-reordering-e3149/VB/E3149/Form1.vb#L300

Dim hitInfo As GridHitInfo = view.CalcHitInfo(New Point(e.X, e.Y))
If Control.ModifierKeys <> Keys.None Then

how-to-drop-a-grid-column-header-onto-another-control-e4912/VB/Form1.vb#L34

Dim gridView = TryCast(sender, GridView)
Dim hi = gridView.CalcHitInfo(gridView.GridControl.PointToClient(Cursor.Position))
If hi.HitTest <> GridHitTest.None AndAlso hi.HitTest <> GridHitTest.Column Then

how-to-enable-editing-in-a-group-row-so-it-is-possible-to-change-child-cell-values-e3036/VB/WindowsApplication3/GroupEditProvider.vb#L93

Private Sub OnMouseMove(ByVal sender As Object, ByVal e As MouseEventArgs)
    Dim hitInfo As GridHitInfo = view.CalcHitInfo(e.Location)
    If hitInfo.HitTest = GridHitTest.Row AndAlso view.IsGroupRow(hitInfo.RowHandle) Then

how-to-edit-multiple-values-in-gridview-at-the-same-time-e2779/VB/MultiSelectionEditingHelper.vb#L27

If GetInSelectedCell(e) Then
    Dim hi As GridHitInfo = view.CalcHitInfo(e.Location)
    If view.FocusedRowHandle = hi.RowHandle Then