Friday, May 14, 2010

Working with Silverlight DataGrid RowDetailsTemplate

In this post I am going to show how we can use the Silverlight DataGrid RowDetails Template, Before I start I assume that you know basics of Silverlight and also know how you create a Silverlight Projects.

I have started with the Silverlight Application, and kept all the default options before I created a Silverlight Project.

After this I added a Silverlight DataGrid control to my MainForm.xaml page, using the DragDrop feature of Visual Studio IDE, this will help me to add the default namespace and references automatically.

Just to give you a quick look of what exactly I am going to do, I will show you in the screen below my final target, before I start explaining rest of my codes.


Before I start with the real code, first I have to do some ground work, as I am not getting the data from the DB, so I am creating a class where I will populate the dummy data.


public class EmployeeData
        public string FirstName { get; set; }
        public string LastName { get; set; }
        public string Address { get; set; }
        public string City { get; set; }
        public string State { get; set; }
        public string Country { get; set; }

        public EmployeeData()
        { }

        public List<EmployeeData> GetEmployeeData()
            List<EmployeeData> employees = new List<EmployeeData>();
                new EmployeeData
                    Address = "#407, PH1, Foyer Appartment",
                    City = "Bangalore",
                    Country = "India",
                    FirstName = "Brij",
                    LastName = "Mohan",
                    State = "Karnataka"
                new EmployeeData
                    Address = "#332, Dayal Niketan",
                    City = "Jamshedpur",
                    Country = "India",
                    FirstName = "Arun",
                    LastName = "Dayal",
                    State = "Jharkhand"
                new EmployeeData
                    Address = "#77, MSR Nagar",
                    City = "Bangalore",
                    Country = "India",
                    FirstName = "Sunita",
                    LastName = "Mohan",
                    State = "Karnataka"
            return employees;

The above class will give me some sample data, I think this will be good enough to start with the actual code. now I am giving below the XAML code from my MainForm.xaml

First I will put the Silverlight DataGrid,

<data:DataGrid x:Name="gridEmployee" CanUserReorderColumns="False" CanUserSortColumns="False" 
                           HorizontalAlignment="Center" ScrollViewer.VerticalScrollBarVisibility="Auto" 
                           Height="200"  AutoGenerateColumns="False" Width="350" VerticalAlignment="Center">
Here, the most important property which I am going to set is

This will display the RowDetails only when we select the desired Row. Other option we have in this is Collapsed and Visible. Which will either make the row details always Visible or Always Collapsed. but to get the real effect I have selected VisibleWhenSelected.

Now I am going to put the rest of my XAML code.

                <!--Begin FirstName Column-->
                <data:DataGridTextColumn Width="150" 
                                         Header="First Name" 
                                         Binding="{Binding FirstName}"/>
                <!--End FirstName Column-->

                <!--Begin LastName Column-->
                <data:DataGridTextColumn Width="150" 
                                         Header="Last Name" 
                                         Binding="{Binding LastName}"/>
                <!--End LastName Column-->

                <!-- Begin row details section. -->
                    <Border BorderBrush="Black" 
                            BorderThickness="1" Background="White">
                                <ColumnDefinition Width="0.2*" />
                                <ColumnDefinition Width="0.8*" />
                                <RowDefinition />
                                <RowDefinition />
                                <RowDefinition />
                                <RowDefinition />
                            <!-- Controls are bound to FullAddress properties. -->
                            <TextBlock Text="Address : " 
                                       Grid.Column="0" Grid.Row="0" />
                            <TextBlock Text="{Binding Address}" 
                                       Grid.Column="1" Grid.Row="0" />
                            <TextBlock Text="City : " 
                                       Grid.Column="0" Grid.Row="1" />
                            <TextBlock Text="{Binding City}" 
                                       Grid.Column="1" Grid.Row="1" />
                            <TextBlock Text="State : " 
                                       Grid.Column="0" Grid.Row="2" />
                            <TextBlock Text="{Binding State}" 
                                       Grid.Column="1" Grid.Row="2" />
                            <TextBlock Text="Country : " 
                                       Grid.Column="0" Grid.Row="3" />
                            <TextBlock Text="{Binding Country}" 
                                       Grid.Column="1" Grid.Row="3" />
                <!-- End row details section. -->


In the code above, first I am declaring the simple dataGridTextColumn for FirstName and LastName, and after this I am creating the RowDetailTemplate, where we are just putting the code what we usually do to design the Grid. I mean nothing very much RowDetailTemplate Specific, most of the code which you will see inside the RowDetailsTemplate is plain and simple, where I am binding rest of the Address Column. And that,s it. Once we will bind the DataGrid, you are ready to go.

In the code below from MainForm.xaml.cs, I am just binding the DataGrid

public partial class MainPage : UserControl
    public MainPage()

    private void BindControls()
        EmployeeData employees = new EmployeeData();
        gridEmployee.ItemsSource = employees.GetEmployeeData();

Once you will run, you can see the output I have given in the screenshot above.

In this example I have just shown the very basic example, now it up to your creativity and requirement, you can put some other controls like checkbox, Images, even other DataGrid, etc inside this RowDetailsTemplate column.

I am attaching my sample source code with this post. I have used Silverlight 3 and Visual Studio 2008, but this is fully compatible with you Silverlight 4 and Visual Studio 2010. you may just need to Upgrade the attached Sample.

You can download from here. Also you can find the better formatted version of the post here.


Anonymous said...

Nice and Interesting Post.
Really Helpfuli

Post a Comment