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
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.
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();
}
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.