CardView.CalcHitInfo(Point) Method

Returns information about View elements located at a specified point.

Namespace: DevExpress.XtraGrid.Views.Card

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

public CardHitInfo CalcHitInfo(
    Point pt
)

VB.NET

Public Function CalcHitInfo(
    pt As Point
) As CardHitInfo

Parameters

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

Returns

Type	Description
CardHitInfo	A CardHitInfo 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 CardHitInfo 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 code demonstrates how to determine over which element of the Card View the mouse pointer is located.

C#

using System.Windows.Forms;

private void gridControl1_MouseMove(object sender, MouseEventArgs e) {
      DevExpress.XtraGrid.Views.Card.ViewInfo.CardHitInfo chi = 
        cardView1.CalcHitInfo(new System.Drawing.Point(e.X, e.Y));
      string elementName = chi.HitTest.ToString();
}

VB.NET

Imports System.Windows.Forms

Private Sub GridControl1_MouseMove(ByVal sender As System.Object, _
  ByVal e As MouseEventArgs) Handles GridControl1.MouseMove
      Dim Chi = CardView1.CalcHitInfo(New System.Drawing.Point(e.X, e.Y))
      Dim ElementName As String = Chi.HitTest.ToString()
End Sub

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-highlight-fields-in-cardview-e276/CS/Form1.cs#L220

CardView view = sender as CardView;
CardHitInfo info = view.CalcHitInfo(new Point(e.X, e.Y));
GridCell c = new GridCell(info.RowHandle, info.Column);

VB.NET

how-to-highlight-fields-in-cardview-e276/VB/Form1.vb#L213

Dim view As CardView = TryCast(sender, CardView)
Dim info As CardHitInfo = view.CalcHitInfo(New Point(e.X, e.Y))
Dim c As GridCell = New GridCell(info.RowHandle, info.Column)