BaseView.CalcHitInfo(Point) Method

Returns information about the View elements located at the specified point.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

public BaseHitInfo CalcHitInfo(
    Point pt
)

VB.NET

Public Function CalcHitInfo(
    pt As Point
) As BaseHitInfo

Parameters

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

Returns

Type	Description
BaseHitInfo	A BaseHitInfo class descendant that contains information about the View elements located at the test point.

Remarks

Use the CalcHitInfo method to determine which element is located at a specific 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.

When called for card, grid and Banded Grid Views this method returns the CardHitInfo, GridHitInfo and BandedGridHitInfo objects respectively. Refer to these topics 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.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference 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#

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

(view as GridView).GridControl.Cursor = Cursors.Default;
BaseHitInfo baseHI = view.CalcHitInfo(e.Location);
GridHitInfo gridHI = baseHI as GridHitInfo;

VB.NET

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

TryCast(view, GridView).GridControl.Cursor = Cursors.Default
Dim baseHI As BaseHitInfo = view.CalcHitInfo(e.Location)
Dim gridHI As GridHitInfo = TryCast(baseHI, GridHitInfo)