PivotGridHitInfo Class

Contains information about a specific point within a PivotGridControl.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v17.2.dll

Declaration

C#

public class PivotGridHitInfo

VB.NET

Public Class PivotGridHitInfo

Related API Members

The following members accept/return PivotGridHitInfo objects:

• PivotFieldTooltipShowingEventArgs.HitInfo
• PivotGridControl.CalcHitInfo(Point)
• PivotGridMenuItemClickEventArgs.HitInfo
• PopupMenuShowingEventArgs.HitInfo

Remarks

PivotGridHitInfo objects can be created by calling the Pivot Grid Control’s PivotGridControl.CalcHitInfo method. This method takes the test point as a parameter.

PivotGridHitInfo class properties can be grouped into two categories:

• the properties that identify the visual element which contains the test point. For instance, the PivotGridHitInfo.CellInfo property provides information on the cell located at the test point;
• the PivotGridHitInfo.HitTest property which allows the type of element located under the test point to be identified.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the PivotGridHitInfo class.

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-reorder-pivotgrid-rows-and-columns-by-drag-and-drop-e4545/CS/ReorderHelper.cs#L170

}
PivotGridHitInfo dragInfo;
PivotGridHitInfo _targetInfo;

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-draw-a-custom-element-when-a-user-hovering-over-field-value-with-a-mouse-e2228/CS/WindowsApplication73/Form1.cs#L60

mousePos = Point.Empty;
PivotGridHitInfo info = pivotGridControl1.CalcHitInfo(e.Location);
if (info.HitTest == PivotGridHitTest.Value)

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) {

VB.NET

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

End Sub
Private dragInfo As PivotGridHitInfo
Private _targetInfo As PivotGridHitInfo

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-draw-a-custom-element-when-a-user-hovering-over-field-value-with-a-mouse-e2228/VB/WindowsApplication73/Form1.vb#L55

mousePos = Point.Empty
Dim info As PivotGridHitInfo = pivotGridControl1.CalcHitInfo(e.Location)
If info.HitTest = PivotGridHitTest.Value 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

Inheritance

Object

PivotGridHitInfo