GridHitInfo Class

Contains information about a specific point within a Grid View.

Namespace: DevExpress.XtraGrid.Views.Grid.ViewInfo

Assembly: DevExpress.XtraGrid.v17.2.dll

Declaration

C#

public class GridHitInfo :
    BaseHitInfo

VB.NET

Public Class GridHitInfo
    Inherits BaseHitInfo

Related API Members

The following members accept/return GridHitInfo objects:

• GridView.CalcHitInfo(Int32, Int32)
• GridView.CalcHitInfo(Point)
• PopupMenuShowingEventArgs.HitInfo
• RowClickEventArgs.HitInfo

Remarks

GridHitInfo objects can be created by calling the desired View’s GridView.CalcHitInfo method. This method requires the test point as a parameter.

GridHitInfo class properties can be grouped into three logical categories:

• properties identifying the View element that contains the test point. For instance, the GridHitInfo.Column and GridHitInfo.RowHandle properties identify the column and row whose elements are under the test point;
• properties indicating whether the test point resides over a particular View element. For instance, the GridHitInfo.InColumnPanel property indicates whether the test point is over the column header panel;
• the GridHitInfo.HitTest property identifying the type of element located under the test point.

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 moving over a Grid Control with the mouse. 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);
    // 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)
    ' 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 GridHitInfo class.

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#

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

GridHitInfo downHitInfo = null;

how-to-drag-xtragrid-cell-value-in-the-same-manner-as-the-one-ms-excel-provides-e3533/CS/Classes/GridViewHelper.cs#L40

BaseHitInfo baseHI = view.CalcHitInfo(e.Location);
GridHitInfo gridHI = baseHI as GridHitInfo;

how-to-implement-drag-drop-functionality-between-detailview-tabs-like-in-google-chrome-when-e5034/CS/WindowsApplication3/Main.cs#L17

public partial class Main: XtraForm {
    GridHitInfo downHitInfo = null;
    GridHitInfo upHitInfo = null;

how-to-provide-the-capability-to-change-a-column-header-height-e3366/CS/GridControlWithResizingColumnHeader/Custom GridView/MyGridViewInfo.cs#L25

GridHitInfo CalcColumnPanelHitInfo(Point pt, GridHitInfo hi)
{

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;

VB.NET

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

Private downHitInfo As GridHitInfo = Nothing

how-to-drag-xtragrid-cell-value-in-the-same-manner-as-the-one-ms-excel-provides-e3533/VB/Classes/GridViewHelper.vb#L36

Dim baseHI As BaseHitInfo = view.CalcHitInfo(e.Location)
Dim gridHI As GridHitInfo = TryCast(baseHI, GridHitInfo)

how-to-implement-drag-drop-functionality-between-detailview-tabs-like-in-google-chrome-when-e5034/VB/Main.vb#L19

Inherits XtraForm
Private downHitInfo As GridHitInfo = Nothing
Private upHitInfo As GridHitInfo = Nothing

how-to-provide-the-capability-to-change-a-column-header-height-e3366/VB/GridControlWithResizingColumnHeader/Custom GridView/MyGridViewInfo.vb#L24

Private Function CalcColumnPanelHitInfo(ByVal pt As Point, ByVal hi As GridHitInfo) As GridHitInfo
    Dim ci As GridColumnInfoArgs = CalcColumnHitInfo(pt)

drag-and-drop-between-detail-views-when-using-linq-to-sql-e1502/VB/mainForm.vb#L54

End If
Dim hInfo As GridHitInfo = (CType(sender, GridView)).CalcHitInfo(e.Location)
If (Not hInfo.InRowCell) Then

Inheritance

Object

BaseHitInfo

GridHitInfo

BandedGridHitInfo