Click here to Skip to main content
Click here to Skip to main content
Go to top

GroupedGridview - A Customized GridView Control

, 9 Jan 2009
Rate this:
Please Sign up or sign in to vote.
Grouping repeated data in a GridView control.

Introduction

This article is all about creating a custom GridView control which is useful in scenarios where the data is in a hierarchical format, e.g., for columns like Country, State, etc., or Manager, Employee, etc.

UnGrouped.JPG

Sample Data

Grouped Image with Grouped Depth 2

Grouped Data

In the above scenarios, rather than using the GridView, GroupedGridview can be used in which the repetition of data is avoided.

Background

Users having a knowledge of creating an inherited (custom) control can easily use/understand this article.

Quickly learn how to create an inherited (custom) control

It's just like adding any other control like a Button or a DataGrid. First, create a new Class Library project. Create a class and derive it from an existing class. E.g.: TextBox, Button etc. In this article, we have derived from a GridView class.

Then, write the functionality which you want to add. This includes overriding methods, etc. Once you are done with it, create its DLL. Add a reference to the DLL in the web application.

Now, you are ready to customize the Toolbox: Right-click the Toolbox, .NET Framework Components, Browse, select the newly created DLL, and click OK. Then, you will notice the new control added in the Toolbox. It's now ready to use.

Using the code

The main part of this article is the class GroupedGridView which inherits from the GridView class.

/// <summary />
/// Summary description for GroupedGridView
/// </summary />
namespace CommonClassLibrary
{
    public class GroupedGridView : GridView
    {
       //..............
       //..............
     }
}

The class has a property GroupedDepth which specifies the number of columns needed to be grouped.

public int GroupedDepth
{
    get
    {
        object val = this.ViewState["GroupedDepth"];
        if (null == val)
        {
            return 0;
        }

        return (int)val;
    }
    set
    {
        if (value < 0)
            throw new ArgumentOutOfRangeException....
        this.ViewState["GroupedDepth"] = value;
    }
}

The GroupedGridView class overrides GridView's OnDataBound event, in which a recursive function SpanCellsRecursive is called.

protected override void OnDataBound(EventArgs e)
{
    base.OnDataBound(e);
    this.SpanCellsRecursive(0, 0, this.Rows.Count);
}

The function below loops through the row data and compares the column values. The compared value will be stored in a boolean variable isNewGroup. If the variable value is true, then its RowSpan is set to 1. And, if its value is false, the cell's Visible property is set to false and the RowSpan is incremented, thus duplicate display is avoided.

private void SpanCellsRecursive(int columnIndex, int startRowIndex, int endRowIndex)
{
    if (columnIndex >= this.GroupedDepth || columnIndex >= this.Columns.Count)
        return;

    TableCell groupStartCell = null;
    int groupStartRowIndex = startRowIndex;

    for (int i = startRowIndex; i < endRowIndex; i++)
    {
        TableCell currentCell = this.Rows[i].Cells[columnIndex];

        bool isNewGroup = (null == groupStartCell) || 
            (0 != String.CompareOrdinal(currentCell.Text, groupStartCell.Text));

        if (isNewGroup)
        {
            if (null != groupStartCell)
            {
                SpanCellsRecursive(columnIndex + 1, groupStartRowIndex, i);
            }

            groupStartCell = currentCell;
            groupStartCell.RowSpan = 1;
            groupStartRowIndex = i;
        }
        else
        {
            currentCell.Visible = false;
            groupStartCell.RowSpan += 1;
        }
    }
}

Once the class is added in the class library, add a reference to the DLL and the control will be available in the Toolbox ready to add in the web application, as mentioned in the Background part of the article above. The newly created control on your webpage looks like this:

<%@ Page Language="C#" AutoEventWireup="true" 
   CodeFile="Default.aspx.cs" Inherits="_Default" %>

<%@ Register Assembly="CommonClassLibrary" 
   Namespace="CommonClassLibrary" TagPrefix="cc1" %>

<html xmlns="http://www.w3.org/1999/xhtml">
<head  runat="server">
    <title>Untitled Page</title>
</head>
<body>
    <form id="form1"  runat="server">
        
<div>
        <cc1:GroupedGridView ID="GroupedGridView1"  runat="server" 
          BackColor="White" BorderColor="#CCCCCC"
          BorderStyle="None" BorderWidth="1px" 
          CellPadding="3" GroupedDepth="2" AutoGenerateColumns="false">
             <columns />
                <asp:BoundField HeaderText="Country" DataField="Country" />
                <asp:BoundField HeaderText="Country Code" DataField="Code" />
                <asp:BoundField HeaderText="State" DataField="State" />
             </columns />
</div>

    </form>
</body>
</html>

Note: This control does not work for AutoGenerateColumns="true". Sorry about that. I am working on this issue.

//
//Binding the dataset to the Gridview
//
GroupedGridView1.DataSource = dataSet;
GroupedGridView1.DataBind();

Conclusion

This is my first article here. I hope you find this article and control useful - it's saved me a lot of time when working with several different types of hierarchical data, to quickly get a full-featured GridView grouped control up and running. Enjoy!

Any suggestions and feedback for improvement are highly appreciated!

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

sudhanvag
Software Developer
India India
Bachelor Of Computer Engineering - Working as a Software Engineer for past 3+ years in .NET technology.
 
Has experience in C#.NET,VB.NET,ASP.NET,ADO.NET,JavaScript,Crystal Reports, Infragistics, NUnit, SQL Server 2000/2005, SSRS, SSAS.
 
Now started learning the latest .NET framework.

Comments and Discussions

 
GeneralMy vote of 5 PinmemberAJMAL SHAHZAD13-Nov-12 18:09 
BugCannot get RowCreated to work Pinmemberprofnachos11-Dec-11 18:20 
GeneralNice idea! PinmemberSandeep Mewara28-Mar-10 8:50 
Generalgridview grouping Pinmemberdanishjee29-Mar-09 0:20 
GeneralNice work PinmemberMike Ellison12-Feb-09 11:03 
GeneralRe: Nice work Pinmembersudhanvag12-Feb-09 21:50 
Generalnice Pinmemberjeshonhe15-Jan-09 7:49 
GeneralRe: nice Pinmembersudhanvag15-Jan-09 21:36 
GeneralAutoGenerateColumns doesn't work Pinmemberandre_monteiro15-Jan-09 4:54 
GeneralRe: AutoGenerateColumns doesn't work [modified] Pinmembersudhanvag15-Jan-09 23:05 
GeneralRe: AutoGenerateColumns doesn't work Pinmemberandre_monteiro15-Jan-09 23:09 
GeneralRe: AutoGenerateColumns doesn't work [modified] Pinmembersudhanvag16-Jan-09 0:28 
Generalvb.NET translation PinmemberBrendanSaunders12-Jan-09 20:12 
GeneralRe: vb.NET translation Pinmembersudhanvag12-Jan-09 20:34 
GeneralGood Job !! PinmvpAbhijit Jana11-Jan-09 0:08 
GeneralRe: Good Job !! Pinmembersudhanvag11-Jan-09 1:20 
GeneralSuggestion and Feedback Pinmembersudhanvag10-Jan-09 3:57 
GeneralRe: Suggestion and Feedback PinmemberDr.Luiji10-Jan-09 10:48 
GeneralRe: Suggestion and Feedback Pinmembersudhanvag10-Jan-09 15:50 
GeneralRe: Suggestion and Feedback PinmemberAnurag Gandhi19-Oct-10 22:17 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web01 | 2.8.140916.1 | Last Updated 10 Jan 2009
Article Copyright 2009 by sudhanvag
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid