PivotGridControl.CalcHitInfo(Point) Method

Returns information on the grid elements located at the specified point.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v19.1.dll

Declaration

C#

public PivotGridHitInfo CalcHitInfo(
    Point hitPoint
)

VB.NET

Public Function CalcHitInfo(
    hitPoint As Point
) As PivotGridHitInfo

Parameters

Name	Type	Description
hitPoint	Point	A Point structure which specifies the test point coordinates relative to the Pivot Grid Control’s top-left corner.

Returns

Type	Description
PivotGridHitInfo	A PivotGridHitInfo object which contains information about the grid elements located at the test point.

Remarks

Use the CalcHitInfo method to determine which element is located at the specified point. For instance, this can be used when handling the Pivot Grid Control’s Click event to determine which element was clicked. In such cases, pass the current mouse pointer’s coordinates as the method’s parameter.

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.

VB.NET

how-to-reorder-pivotgrid-rows-and-columns-by-drag-and-drop-e4545/VB/ReorderHelper.vb#L186

If e.Button = System.Windows.Forms.MouseButtons.Left Then
    Dim hi As PivotGridHitInfo = targetPivot_Renamed.CalcHitInfo(e.Location)
    If hi.HitTest = PivotGridHitTest.Value Then

how-to-drop-a-grid-column-header-onto-another-control-e4912/VB/Helpers/DragDrop/PivotGridControlHelper.vb#L12

Public Overrides Sub DropObjectCore(ByVal columnFieldName As String, ByVal location As System.Drawing.Point, ByVal control As PivotGridControl)
    Dim hitInfo = control.CalcHitInfo(control.PointToClient(location))
    If hitInfo.HeadersAreaInfo Is Nothing Then

how-to-provide-custom-date-time-group-intervals-and-preserve-correct-sort-order-e2726/VB/WindowsApplication21/Form1.vb#L72

Private Sub pivotGridControl1_MouseClick(ByVal sender As Object, ByVal e As MouseEventArgs) Handles pivotGridControl1.MouseClick
    Dim hitInfo As PivotGridHitInfo = pivotGridControl1.CalcHitInfo(e.Location)
    If hitInfo.HitTest = PivotGridHitTest.Value AndAlso hitInfo.ValueInfo IsNot Nothing Then

how-to-implement-sorting-for-a-custom-cell-value-e2149/VB/ImplementSortingforaCustomCellValue/Form1.vb#L167

Private Sub pivotGridControl1_MouseClick(ByVal sender As Object, ByVal e As MouseEventArgs) Handles pivotGridControl1.MouseClick
    Dim hi As PivotGridHitInfo = pivotGridControl1.CalcHitInfo(e.Location)
    If hi.HitTest = PivotGridHitTest.Value AndAlso hi.ValueInfo.IsColumn Then

how-to-replace-the-default-filter-popup-with-a-custom-one-e4897/VB/Form1.vb#L48

Private Sub pivotGridControl1_MouseDown(ByVal sender As Object, ByVal e As MouseEventArgs) Handles pivotGridControl1.MouseDown
    Dim hi As PivotGridHitInfo = pivotGridControl1.CalcHitInfo(e.Location)
    If hi.HitTest = PivotGridHitTest.HeadersArea AndAlso hi.HeaderField IsNot Nothing AndAlso hi.HeadersAreaInfo.HeaderHitTest = PivotGridHeaderHitTest.Filter AndAlso hi.HeaderField.Area <> PivotArea.DataArea Then

C#

how-to-drop-a-grid-column-header-onto-another-control-e4912/CS/Helpers/DragDrop/PivotGridControlHelper.cs#L10

public override void DropObjectCore(string columnFieldName, System.Drawing.Point location, PivotGridControl control) {
    var hitInfo = control.CalcHitInfo(control.PointToClient(location));
    if (hitInfo.HeadersAreaInfo == null) {

how-to-provide-custom-date-time-group-intervals-and-preserve-correct-sort-order-e2726/CS/WindowsApplication21/Form1.cs#L77

{
    PivotGridHitInfo hitInfo = pivotGridControl1.CalcHitInfo(e.Location);
    if (hitInfo.HitTest == PivotGridHitTest.Value && hitInfo.ValueInfo != null)

how-to-implement-sorting-for-a-custom-cell-value-e2149/CS/ImplementSortingforaCustomCellValue/Form1.cs#L164

private void pivotGridControl1_MouseClick(object sender, MouseEventArgs e) {
    PivotGridHitInfo hi = pivotGridControl1.CalcHitInfo(e.Location);
    if(hi.HitTest == PivotGridHitTest.Value && hi.ValueInfo.IsColumn) {

how-to-replace-the-default-filter-popup-with-a-custom-one-e4897/CS/E4669CS/Form1.cs#L50

{
    PivotGridHitInfo hi = pivotGridControl1.CalcHitInfo(e.Location);
    if (hi.HitTest == PivotGridHitTest.HeadersArea && hi.HeaderField != null && hi.HeadersAreaInfo.HeaderHitTest == PivotGridHeaderHitTest.Filter && hi.HeaderField.Area != PivotArea.DataArea)

invoke-summary-type-menu-when-user-hovers-over-the-field-header-with-a-mouse-e2351/CS/WindowsApplication34/Form1.cs#L96

PivotGridControl pivot = (PivotGridControl)sender;
PivotGridHitInfo hitInfo = pivot.CalcHitInfo(e.Location);
if (hitInfo.HitTest != PivotGridHitTest.HeadersArea) return;