Click here to Skip to main content
14,238,982 members

DataGridViewGrouper

Rate this:
4.93 (23 votes)
Please Sign up or sign in to vote.
4.93 (23 votes)
28 May 2015CPOL
DataGridViewGrouper: add grouping functionality to the .NET DataGridView

Introduction

The DataGridViewGrouper is a component that can add grouping functionality to any existing DataGridView. The component can be added in the designer or in code. Optionally, a control can be used (DataGridViewGrouperControl) to provide a user interface to alter the grouping.

Background

The component was something I wrote in 2008 and published on blogs.vbcity.com/hotdog/archive/2008/12/19/9225.aspx (no longer available). That was a primary version and although it hasn't been updated in a long time now, the component and its controls are something that I use every day in custom applications and contains a lot of functionality the old version did not.

Using the Code

To simply start grouping, the component can be added in designer, or on the fly. Grouping can be started with one of the appropriate functions, or by attaching a custom grouper.

All the code needed to make a grid grouped on a property (in this example called AString):

var grouper = new Subro.Controls.DataGridViewGrouper(dataGridView1);
grouper.SetGroupOn("AString");

which creates something like:

N.B.: The test project generates random data, so the displayed data will vary.

The miscellaneous options for formatting/sorting/collapsing/etc. can be set either in code, or with the included wrapper control:

The dropdown contains the columns from whatever source the grid is bound to:

And the various options can be set via the secondary options button:

The options can of course be set in code, but also with the help of an included toolstripmenuitem which can be added to a contextmenu or other menu.

In the example, a string was used, but the same can be accomplished by using a PropertyDescriptor/DataGridViewColumn or lambda expression. For example, these do the same as using the string:

grouper.SetGroupOn<TestData>(t => t.AString);
grouper.SetGroupOn(this.dataGridView1.Columns["AString"]);

Also, a custom grouper can be assigned to the GroupOn property (any class inheriting GroupingInfo. This could be changed to an interface later on if needed.

Or by using the SetCustomGroup method:

grouper.SetCustomGroup<TestData>(t => t.AnInt % 10, "Mod 10");

Some further examples:

//to start with all rows collapsed on a (re)load or 
//when the group is changed you can set the option startcollapsed:
grouper.Options.StartCollapsed = true;

//to collapse all loaded rows: (the difference with setting the option above, 
//is that after choosing a new grouping (or on a reload), the new groups would expand.
grouper.CollapseAll();

//if you don't want the (rowcount) to be shown in the headers:
grouper.Options.ShowCount = false;

//if you don't want the grouped column name to be repeated in the headers:
grouper.Options.ShowGroupName = false;

//default sort order for the groups is ascending, 
//you can change that in the options as well (ascending, descending or none)
grouper.Options.GroupSortOrder = SortOrder.Descending;

An example of collapse all:

The component exposes a GroupingChanged event to catch when the grouping was changed or removed. And a DisplayGroup event which is fired whenever one of the grouping rows is being painted. The DisplayGroup event can be used to further customize whatever has to be shown:

//grouper.DisplayGroup += grouper_DisplayGroup;
          
void grouper_DisplayGroup(object sender, GroupDisplayEventArgs e)
{
    e.BackColor = (e.Group.GroupIndex % 2) == 0 ? Color.Orange : Color.LightBlue;
    e.Header = "[" + e.Header + "], grp: " + e.Group.GroupIndex;
    e.DisplayValue = "Value is " + e.DisplayValue;
    e.Summary = "contains " + e.Group.Count + " rows";
}

The snippet above would produce something like:

Points of Interest

The class library is an extract from a larger control library. One of the things still missing here is a quick grouping context menu item, which sets the grouping on the column where the right click took place and is the way grouping is used most in the applications I've used so far. However, the context menu is a bit too integrated in the library and its custom ORM to quickly add here. If interest exists, I will add that later on, including its quick filter options.

Another note: The library also contains some searchboxes (for DataGridView/Treeview and bindingsource in general. Not documented here, but fully usable. Just drop onto a form and attach the appropriate control.

History

  • 2008: First draft on vbcity blog
  • 2015-05-28 First publish of current production version

License

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

Share

About the Author

Robert.Verpalen
Software Developer
Netherlands Netherlands
No Biography provided

Comments and Discussions

 
QuestionPrevent collapsing in vb.net Pin
Mr.Bluesky7-Sep-18 3:14
memberMr.Bluesky7-Sep-18 3:14 
QuestionRemove Grouping Pin
Member 1341448023-Jun-18 22:52
memberMember 1341448023-Jun-18 22:52 
AnswerRe: Remove Grouping Pin
Member 1447330616-Jul-19 10:27
memberMember 1447330616-Jul-19 10:27 
QuestionWhen reloading data into DataGridView I am getting exception: Column 'ColumnName' does not belong to table Pin
Luis Mendez26-Jan-18 9:51
memberLuis Mendez26-Jan-18 9:51 
AnswerRe: When reloading data into DataGridView I am getting exception: Column 'ColumnName' does not belong to table Pin
Member 1447330616-Jul-19 10:25
memberMember 1447330616-Jul-19 10:25 
QuestionThanks Pin
Luis Mendez24-Jan-18 5:46
memberLuis Mendez24-Jan-18 5:46 
QuestionConditional Color change Pin
Ziya Hussain3-Jan-18 17:49
memberZiya Hussain3-Jan-18 17:49 
QuestionRecompiling for use in VB.net and also how to .GetChanges() Pin
SidupacX13-Nov-17 2:02
memberSidupacX13-Nov-17 2:02 
QuestionHow to expand and specific group Pin
lrhage10-Oct-17 7:40
memberlrhage10-Oct-17 7:40 
QuestionSystem.Exception: ' Company is not a valid property' Pin
Member 1340398011-Sep-17 4:28
memberMember 1340398011-Sep-17 4:28 
QuestionHow can I get the number of groups? Pin
Roland Wiesinger20-Jun-17 3:29
memberRoland Wiesinger20-Jun-17 3:29 
BugException Unhandled Pin
Member 43148597-Jun-17 20:29
memberMember 43148597-Jun-17 20:29 
QuestionColumn x does not belong to table Pin
Eliseu Fil9-Feb-17 2:33
memberEliseu Fil9-Feb-17 2:33 
QuestionUnable to cast object of type 'Subro.Controls.GroupRow' to type 'System.Data.DataRowView'. Pin
Awesh Vishwakarma1-Dec-16 17:04
professionalAwesh Vishwakarma1-Dec-16 17:04 
AnswerRe: Unable to cast object of type 'Subro.Controls.GroupRow' to type 'System.Data.DataRowView'. Pin
wasniewc2-May-17 12:25
memberwasniewc2-May-17 12:25 
QuestionIs there a method to group by multiple columns of a datatable Pin
Member 1056115613-Sep-16 7:02
memberMember 1056115613-Sep-16 7:02 
QuestionRefresh causes Object reference not set to an instance of an object Pin
paperboy30-Jul-16 5:10
memberpaperboy30-Jul-16 5:10 
Questionproblem: Pin
Member 118312927-Feb-16 3:04
memberMember 118312927-Feb-16 3:04 
QuestionNot working 2016 Pin
Nerexis19-Jan-16 13:17
memberNerexis19-Jan-16 13:17 
QuestionSummaries Pin
Member 1208329623-Nov-15 3:08
memberMember 1208329623-Nov-15 3:08 
AnswerRe: Summaries Pin
wasniewc4-May-17 11:02
memberwasniewc4-May-17 11:02 
GeneralMy vote of 5 Pin
Juan Aguilera Ramos22-Oct-15 20:31
memberJuan Aguilera Ramos22-Oct-15 20:31 
QuestionGroup /Sub Group on multiple properties Pin
m4dh016-Sep-15 4:52
memberm4dh016-Sep-15 4:52 
BugInvalidCastException Pin
ricpulvi2-Sep-15 4:48
memberricpulvi2-Sep-15 4:48 
GeneralRe: InvalidCastException Pin
Robert.Verpalen2-Sep-15 5:03
memberRobert.Verpalen2-Sep-15 5:03 

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

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

Tip/Trick
Posted 28 May 2015

Stats

59.3K views
6.1K downloads
28 bookmarked