PivotCustomGroupIntervalEventArgs Class

Provides data for the PivotGridControl.CustomGroupInterval event.

Namespace: DevExpress.XtraPivotGrid

Assembly: DevExpress.XtraPivotGrid.v17.2.dll

Declaration

C#

public class PivotCustomGroupIntervalEventArgs :
    PivotCustomGroupIntervalEventArgsBase<PivotGridField>

VB.NET

Public Class PivotCustomGroupIntervalEventArgs
    Inherits PivotCustomGroupIntervalEventArgsBase(Of PivotGridField)

Related API Members

PivotCustomGroupIntervalEventArgs is the data class for the following events:

• PivotGridControl.CustomGroupInterval

Example

This example shows how to provide a custom criteria used to group axis values. The Pivot Grid Control contains two row fields bound to the same ProductName data source field, named Product Group and Product respectively. The custom grouping is applied to the first field and combines the first field’s values by the starting characters of values into three large ranges: A-E, F-S, and T-Z.

The Product Group field’s PivotGridFieldBase.GroupInterval property is set to Custom at design-time. The grouping logic is implemented by handling the PivotGridControl.CustomGroupInterval event.

C#

protected void PivotGridControl_CustomGroupInterval(object sender, 
PivotCustomGroupIntervalEventArgs e) {
    if (e.Field.Caption != "Product Group") return;

    if (Convert.ToChar(e.Value.ToString()[0]) < 'F') {
        e.GroupValue = "A-E";
        return;
    }

    if (Convert.ToChar(e.Value.ToString()[0]) > 'E' && 
    Convert.ToChar(e.Value.ToString()[0]) < 'T') {
        e.GroupValue = "F-S";
        return;
    }

    if (Convert.ToChar(e.Value.ToString()[0]) > 'S')
        e.GroupValue = "T-Z";
}

VB.NET

Protected Sub PivotGridControl_CustomGroupInterval(ByVal sender As Object, _
ByVal e As PivotCustomGroupIntervalEventArgs) _
Handles pivotGridControl.CustomGroupInterval
    If e.Field.Caption <> "Product Group" Then Return
    If Convert.ToChar(e.Value.ToString().Chars(0)) < "F"c Then
        e.GroupValue = "A-E"
        Return
    End If
    If Convert.ToChar(e.Value.ToString().Chars(0)) > "E"c _
      AndAlso Convert.ToChar(e.Value.ToString().Chars(0)) < "T"c Then
        e.GroupValue = "F-S"
        Return
    End If
    If Convert.ToChar(e.Value.ToString().Chars(0)) > "S"c Then
        e.GroupValue = "T-Z"
    End If
End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the PivotCustomGroupIntervalEventArgs 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-provide-custom-date-time-group-intervals-and-preserve-correct-sort-order-e2726/CS/WindowsApplication21/Form1.cs#L48

private void pivotGridControl1_CustomGroupInterval(object sender, DevExpress.XtraPivotGrid.PivotCustomGroupIntervalEventArgs e)
{

VB.NET

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

Private Sub pivotGridControl1_CustomGroupInterval(ByVal sender As Object, ByVal e As DevExpress.XtraPivotGrid.PivotCustomGroupIntervalEventArgs) Handles pivotGridControl1.CustomGroupInterval
    If ReferenceEquals(e.Field, fieldCustomMonth) Then

Inheritance

Object

EventArgs

PivotFieldEventArgsBase<PivotGridField>

PivotCustomGroupIntervalEventArgsBase<PivotGridField>

PivotCustomGroupIntervalEventArgs