Back to Devexpress

BaseView.CalcHitInfo(Point) Method

windowsforms-devexpress-dot-xtragrid-dot-views-dot-base-dot-baseview-dot-calchitinfo-x28-system-dot-drawing-dot-point-x29.md

latest5.2 KB
Original Source

BaseView.CalcHitInfo(Point) Method

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

Namespace : DevExpress.XtraGrid.Views.Base

Assembly : DevExpress.XtraGrid.v25.2.dll

NuGet Packages : DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

csharp
public BaseHitInfo CalcHitInfo(
    Point pt
)
vb
Public Function CalcHitInfo(
    pt As Point
) As BaseHitInfo

Parameters

NameTypeDescription
ptPoint

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

|

Returns

TypeDescription
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 Views that display real data within the Grid Control. Use the following methods to access these Views with which an end user interacts at runtime.

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.

winforms-grid-move-cell-using-drag-drop/CS/Classes/GridViewHelper.cs#L39

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

winforms-grid-move-cell-using-drag-drop/VB/Classes/GridViewHelper.vb#L35

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

See Also

Hit Information

BaseView Class

BaseView Members

DevExpress.XtraGrid.Views.Base Namespace