Edit this page

Data Annotations

In this article we will show you how to use Data Annotations with RadPivotGrid. Data Annotations are used to specify validation rules, specify how the data is displayed, and set relationships between classes. More information about Data Annotation can be found here.

RadPivotGrid application

Let's create a simple application that will show data for different orders. Each order has the following descriptions: Date, Product, Quantity, Net, Promotion and Advertisement. So the class that will represent one Order will look this way:

C#

public class Order
{
    public DateTime Date { get; set; }
    public string Product { get; set; }
    public int Quantity { get; set; }
    public double Net { get; set; }
    public string Promotion { get; set; }
    public string Advertisement { get; set; }
}

VB.NET

Public Class Order
    Public Property [Date]() As Date
    Public Property Product() As String
    Public Property Quantity() As Integer
    Public Property Net() As Double
    Public Property Promotion() As String
    Public Property Advertisement() As String
End Class

And here is how RadPivotGrid and RadPivotFieldList will look like after we have added some sample data and group descriptions:

Rad Pivot Grid Features Annotations 01

LocalDataSourceProvider automatically creates a new group for each of the public properties in Order class. This can be easily seen with RadPivotFieldList:

Rad Pivot Grid Features Annotations 02

But what if you want to hide the "Advertisement" property or show different name for it? In this case RadPivotGrid has an easy solution for you - Data Annotations.

Data Annotations with RadPivotGrid

If you want to use Data Annotations in your application, you have to add a reference to System.ComponentModel.DataAnnotations assembly.

With Data Annotations you can apply attributes to the members of the class that specify how the data is displayed. RadPivotGrid supports three different Data Annotations:

  • Display - this is recommended attribute type to use. You can use two properties - Name and AutoGenerateField. The value of Name will be used in RadPivotGrid and RadPivotFieldList instead of the PropertyName. When you set AutoGenerateField to false, the property will not show up in RadPivotFieldList and you will not be able to use it in your RadPivotGrid. Here is a sample how to set DataAnnotation with Display attribute:

C#

//Rename the Date property to Month in the UI
[Display (Name="Month")]
public DateTime Date { get; set; }

//Hide Product from the UI
[Display (AutoGenerateField=false)]
public string Product { get; set; }

VB.NET

<Display(Name:="Month")> _
Public Property [Date]() As Date

'Hide Product from the UI
<Display(AutoGenerateField:=False)> _
Public Property Product() As String
  • Browsable - with this attribute you can define whether an item should be visible or not. There's no difference between setting browsable value to false or AutoGenerateField of Display attribute to false.

C#

//Hide Product from the UI
[Browsable (false) ]
public string Product { get; set; }

VB.NET

'Hide Product from the UI
<Browsable(False)> _
Public Property Product() As String
  • DisplayName - the value of the attribute will be shown in RadPivotGrid and RadPivotFieldList instead of PropertyName. There is no difference in the final result when you use DisplayName and Display attribute (setting Name property). This is an oboslete attribute and we suggest you to use Display instead of it.

C#

//Rename the Date property to Month in the UI
[DisplayName ("Month")]
public DateTime Date { get; set; }

VB.NET

'Rename the Date property to Month in the UI
<DisplayName("Month")> _
Public Property [Date]() As Date

So let's modify our simple Order class and see the result in RadPivotGrid and RadPivotFieldList.

C#

public class Order
{
    //Rename the Date property to Month in the UI
    [Display (Name="Month")]
    public DateTime Date { get; set; }

    public string Product { get; set; }

    //Hide Quantiy from the UI
    [Display (AutoGenerateField=false)]
    public int Quantity { get; set; }

    public double Net { get; set; }

    public string Promotion { get; set; }

    //Hide Product from the UI
    [Browsable(false)]
    public string Advertisement { get; set; }
}

VB.NET

Public Class Order
    'Rename the Date property to Month in the UI
    <Display(Name:="Month")> _
    Public Property [Date]() As Date

    Public Property Product() As String

    'Hide Quantiy from the UI
    <Display(AutoGenerateField:=False)> _
    Public Property Quantity() As Integer

    Public Property Net() As Double

    Public Property Promotion() As String

    'Hide Product from the UI
    <Browsable(False)> _
    Public Property Advertisement() As String
End Class

And here is the new result:

Rad Pivot Grid Features Annotations 03

Data Annotations and CustomName

Each group description has CustomName property. When it is set RadPivotGrid uses it instead of PropertyName in the UI. RadPivotFieldList also shows CustomName value, but only in the groups which are currently in use. Here is a snapshot in which we have set CustomName for our Date group description to "Month" and CustomName for the "Net" aggregate description to "Profit":

Rad Pivot Grid Features Annotations 04

You can see how in the top part of RadPivotFieldList the CustomName is not applied. So if you want to show the same name you have to use Data Annotations. CustomName is suitable in scenarios when you are using only RadPivotGrid or when you want to change the default "Sum of " value which is used for the aggregate descriptions (in green above).

If you use Data Annotations and CustomName for the same property, CustomName will be used as it has higher priority.

See Also