Edit this page

DateTimeGroupDescription

In this article we will show you how to use DateTimeGroupDescription with your DateTime and DateTimeOffset data.

DateTimeGroupDescription

When using LocalDataSourceProvider you can choose between three types of group description - PropertyGroupDescription, DoubleGroupDescription and DateTimeGroupDescription (or implement your own group description, which inherits PropertyGroupDescriptionBase).

DateTimeGroupDescription is used when you want to group your data by property of type DateTime or DateTimeOffset. DateTimeGroupDescription has the following properties:

  • PropertyName - defines the name of the property by which the data will be grouped. It is mandatory to set a value.

  • Step - defines the grouping interval. Default value is Year, but you can change it to one of the following: Quarter, Month, Week, Day, Hour, Minute, Second. If you have the following dates: 01-01-2013 and 20-02-2013 and you set Step to Year, the two values will be in one group - 2013. But if you change the step to Month, the values will be in two different groups - January and February.

When you have a property of type DateTime (DateTimeOffset), you can create several DateTimeGroupDescriptions with different steps. You may also create a PropertyGroupDescription - this way the DateTime will be treated as a string and grouped as such. All of them can be used simultaneously. You can add the description in RowGroupDescriptions or ColumnGroupDescriptions collections of LocalDataSourceProvider.

XAML

<pivot:LocalDataSourceProvider.RowGroupDescriptions>
    <pivot:DateTimeGroupDescription PropertyName="Date" Step="Quarter"/>
    <pivot:DateTimeGroupDescription PropertyName="Date" Step="Month" />
    <pivot:PropertyGroupDescription PropertyName="Date"/>
</pivot:LocalDataSourceProvider.RowGroupDescriptions>

C#

DateTimeGroupDescription dateTimeGroupDescription1 = new DateTimeGroupDescription();
dateTimeGroupDescription1.PropertyName = "Date";
dateTimeGroupDescription1.Step = DateTimeStep.Quarter;
DateTimeGroupDescription dateTimeGroupDescription2 = new DateTimeGroupDescription();
dateTimeGroupDescription2.PropertyName = "Date";
dateTimeGroupDescription2.Step = DateTimeStep.Month;
Telerik.Pivot.Core.PropertyGroupDescription propertyGroupDescription = new Telerik.Pivot.Core.PropertyGroupDescription();
propertyGroupDescription.PropertyName = "Date";

var dataProvider = new LocalDataSourceProvider();
dataProvider.RowGroupDescriptions.Add(dateTimeGroupDescription1);
dataProvider.RowGroupDescriptions.Add(dateTimeGroupDescription2);
dataProvider.RowGroupDescriptions.Add(propertyGroupDescription);

VB.NET

Dim dateTimeGroupDescription1 As New DateTimeGroupDescription()
dateTimeGroupDescription1.PropertyName = "Date"
dateTimeGroupDescription1.Step = DateTimeStep.Quarter
Dim dateTimeGroupDescription2 As New DateTimeGroupDescription()
dateTimeGroupDescription2.PropertyName = "Date"
dateTimeGroupDescription2.Step = DateTimeStep.Month
Dim propertyGroupDescription As New Telerik.Pivot.Core.PropertyGroupDescription()
propertyGroupDescription.PropertyName = "Date"

Dim dataProvider = New LocalDataSourceProvider()
dataProvider.RowGroupDescriptions.Add(dateTimeGroupDescription1)
dataProvider.RowGroupDescriptions.Add(dateTimeGroupDescription2)
dataProvider.RowGroupDescriptions.Add(propertyGroupDescription)

RadPivotFieldList automatically detects properties of type DateTime (DateTimeOffset) and creates a special folder in the FieldTree for each of the properties. The name of the folder is the name of the property. By default inside the folder you will find out the following structure:

Rad Pivot Grid Features Date Time Group 01

As you can see, the folder gives you the ability to select different steps for your DateTimeGroupDescription at runtime and use them simultaneously. The names of the items are a combination of the property name and a step. Only the last item in the folder has different name - it contains only the property name. When you drag it, you will add the data as PropertyGroupDescription.

Modify FieldTree of RadPivotFieldList

By default RadPivotFieldList will show the following steps in its FieldTree for each DateTimeGroupDescription: Year, Month, Quarter, Week, Day (you will also see additional item, which will create PropertyGroupDescription instead of DateTimeGroupDescription). But you can set three more steps - Hour, Minute, Second. So how to show them in RadPivotFieldList?

The solution of this problem is to use AddingContainerNode event of LocalDataSourceFieldDescriptionsProvider. In this event you will receive all items from the FieldTree and you will be able to modify which of them to be visible. In order to use this event you have to create a new instance of LocalDataSourceFieldDescriptionsProvider and set LocalDataSourceProvider's FieldDescriptionProvider to this instance. You can do this in XAML or in code behind:

XAML

<pivot:LocalDataSourceProvider x:Key="dataProvider" ItemsSource="{StaticResource source}">
    <pivot:LocalDataSourceProvider.FieldDescriptionsProvider>
        <pivot:LocalDataSourceFieldDescriptionsProvider AddingContainerNode="LocalDataSourceFieldDescriptionsProvider_ContainerNodeAdded_1"/>
    </pivot:LocalDataSourceProvider.FieldDescriptionsProvider>
</pivot:LocalDataSourceProvider>

C#

var dataProvider = new LocalDataSourceProvider();
dataProvider.ItemsSource = new Source();
var descriptionProvider = new LocalDataSourceFieldDescriptionsProvider();
descriptionProvider.AddingContainerNode += LocalDataSourceFieldDescriptionsProvider_ContainerNodeAdded;
dataProvider.FieldDescriptionsProvider = descriptionProvider;

VB.NET

Dim dataProvider = New LocalDataSourceProvider()
dataProvider.ItemsSource = New Source()
Dim descriptionProvider = New LocalDataSourceFieldDescriptionsProvider()
descriptionProvider.AddingContainerNode += LocalDataSourceFieldDescriptionsProvider_ContainerNodeAdded
dataProvider.FieldDescriptionsProvider = descriptionProvider

By using the ContainerNodeEventArgs you are able to access the information foreach ContainerNode in the FieldTree, its children. You can decide whether to include each of the children by using AutoGenerateField property. If you want you can remove the whole container (the folder) from the UI, by setting e.Cancel = true:

  • Add children to the container node (folder) - for example you may add Hour Step to the FieldTree:

C#

void LocalDataSourceFieldDescriptionsProvider_ContainerNodeAdded(object sender, ContainerNodeEventArgs e)
{
    //Use the name of the DateTime property, in our case it is Date
    if (e.ContainerNode.Name == "Date")
    {
        foreach (var containerNode in e.ContainerNode.Children)
        {
            FieldInfoNode fin = containerNode as FieldInfoNode;
            if (containerNode.Name == "Date.Hour")
            {
                //Show Hour from the DateTime tree
                (fin.FieldInfo as PropertyFieldInfo).AutoGenerateField = true;
            }
        }
    }
}

VB.NET

Private Sub LocalDataSourceFieldDescriptionsProvider_ContainerNodeAdded(ByVal sender As Object, ByVal e As ContainerNodeEventArgs)
    'Use the name of the DateTime property, in our case it is Date
    If e.ContainerNode.Name = "Date" Then
        For Each containerNode In e.ContainerNode.Children
            Dim fin As FieldInfoNode = TryCast(containerNode, FieldInfoNode)
            If containerNode.Name = "Date.Hour" Then
                'Show Hour from the DateTime tree
                TryCast(fin.FieldInfo, PropertyFieldInfo).AutoGenerateField = True
            End If
        Next containerNode
    End If
End Sub
  • Remove children from the container node (folder) - for example you may remove Year Step to the FieldTree:

C#

void LocalDataSourceFieldDescriptionsProvider_ContainerNodeAdded(object sender, ContainerNodeEventArgs e)
{
    //Use the name of the DateTime property, in our case it is Date
    if (e.ContainerNode.Name == "Date")
    {
        foreach (var containerNode in e.ContainerNode.Children)
        {
            FieldInfoNode fin = containerNode as FieldInfoNode;
            if (containerNode.Name == "Date.Year")
            {
                //Remove Year from the DateTime tree
                (fin.FieldInfo as PropertyFieldInfo).AutoGenerateField = false;
            }
        }
    }
}

VB.NET

Private Sub LocalDataSourceFieldDescriptionsProvider_ContainerNodeAdded(ByVal sender As Object, ByVal e As ContainerNodeEventArgs)
    'Use the name of the DateTime property, in our case it is Date
    If e.ContainerNode.Name = "Date" Then
        For Each containerNode In e.ContainerNode.Children
            Dim fin As FieldInfoNode = TryCast(containerNode, FieldInfoNode)
            If containerNode.Name = "Date.Year" Then
                'Remove Year from the DateTime tree
                TryCast(fin.FieldInfo, PropertyFieldInfo).AutoGenerateField = False
            End If
        Next containerNode
    End If
End Sub
  • Remove the whole container node (folder) from the FieldTree:

C#

void LocalDataSourceFieldDescriptionsProvider_ContainerNodeAdded(object sender, ContainerNodeEventArgs e)
{
    //Use the name of the DateTime property, in our case it is Date
    if (e.ContainerNode.Name == "Date")
    {
        e.Cancel = true;
    }
}

VB.NET

Private Sub LocalDataSourceFieldDescriptionsProvider_ContainerNodeAdded(ByVal sender As Object, ByVal e As ContainerNodeEventArgs)
    'Use the name of the DateTime property, in our case it is Date
    If e.ContainerNode.Name = "Date" Then
        e.Cancel = True
    End If
End Sub
  • Remove the whole container node (folder) from the FieldTree and show a single DateTime with chosen Step::

C#

void LocalDataSourceFieldDescriptionsProvider_ContainerNodeAdded(object sender, ContainerNodeEventArgs e)
{
    //Use the name of the DateTime property, in our case it is Date
    if (e.ContainerNode.Name == "Date")
    {
        //Find the children Date.Month and show it.
        FieldInfoNode fin = e.ContainerNode.Children.First<ContainerNode>(cn => cn.Name == "Date.Month") as FieldInfoNode;
        e.ContainerNode = fin;
    }
}

VB.NET

Private Sub LocalDataSourceFieldDescriptionsProvider_ContainerNodeAdded(ByVal sender As Object, ByVal e As ContainerNodeEventArgs)
    'Use the name of the DateTime property, in our case it is Date
    If e.ContainerNode.Name = "Date" Then
        'Find the children Date.Month and show it.
        Dim fin As FieldInfoNode = TryCast(e.ContainerNode.Children.First(Function(cn) cn.Name = "Date.Month"), FieldInfoNode)
        e.ContainerNode = fin
    End If
End Sub

See Also