CodeProject: MergedDataGridView Control.

Free source code and programming help

Page 1 of 6

Desktop Development Grid & Data Controls Grid controls Code Project Open License (CPOL)

License: The

VB 8.0, VB 9.0WinXP, Vista, .NET 3.5, WinForms, VS2005, VS2008, Dev Version: Posted: Updated: Views: 3 (See All) 23 Apr 2009 23 Apr 2009 4,422

MergedDataGridView Control
By jpaulino A DataGridView control that allows to show some extra information in a merged row. Uses Visual Basic.NET 2008 and Framework 3.5.

Bookmarked: 25 times

Prize winner in Competition "Best VB.NET article of April 2009" 15 votes for this article. Popularity: 5.63 Rating: 4.79 out of 5
1 2 3 4 5

Download demo - 22.6 KB Download source - 30.6 KB

Introduction
As we all know, the DataGridView control doesn't allow us to merge cells, and if we think a little on that, we can ask ourselves the question, "Why? Well, the DataGridView is bound to a data source (even if you don't define that), and each cell represents a field in a record, so what field will that merged cell belong to? Maybe, it was because of this that Microsoft didn't include this feature. But, sometimes, we may want to show some extra information, and the only solution is to popup a form/message box, or steal some space in the current form and fill it with textboxes, combo s, etc. The goal of this customization is to show some extra information in a DataGridView . It basically uses a RichTextBox that is inserted in the grid and sized according to the parent row. The parent

http://www.codeproject.com/KB/grid/MergedDataGridViewControl.aspx?display=Print

5/26/2009

CodeProject: MergedDataGridView Control. Free source code and programming help

Page 2 of 6

row must have a unique ID that will be the textbox name. This will then be used to size and position the RichTextBox in the right place. I have also included some icon animation and grid customization to improve the end look.

Using the code

To start, you must include the class MergedDataGridView in your application. After you build the project, the MergedDataGridView control will be available in the toolbox. Then, just drag it to your form. Next, you need to define the custom properties for the MergedDataGridView:

With Me.MergedDataGridView1 ' Define the datasource .DataSource = ds.Tables(0).DefaultView ' Custom definitions for the RichTextBox .StartColumnIndex = 1 .EndColumnIndex = 7 .RowHeight = 60 ' Custom definitions for the DataGridView .AllowUserToAddRows = False .AllowUserToDeleteRows = False .RowsDefaultCellStyle.BackColor = Color.White .AlternatingRowsDefaultCellStyle.BackColor = Color.AliceBlue .AutoResizeColumns(DataGridViewAutoSizeColumnsMode.DisplayedCells) End With

After this, you can include the two DataGridViewImageColumn s that will be used to show the RichTextBox and to display a MessageBox containing the information.

' Create an image column in the datagrid that will open the merged row Dim ImageColumn1 As New DataGridViewImageColumn ImageColumn1.DefaultCellStyle.Alignment = DataGridViewContentAlignment.TopCenter ImageColumn1.Image = My.Resources.DownArrow ImageColumn1.Width = 25 ' Create an image column in the datagrid that will open an extra window Dim ImageColumn2 As New DataGridViewImageColumn ImageColumn2.DefaultCellStyle.Alignment = DataGridViewContentAlignment.TopCenter ImageColumn2.Image = My.Resources.Info ImageColumn2.Width = 25 ' Add the two columns to the datagridview Me .MergedDataGridView1.Columns.AddRange(New _ DataGridViewImageColumn() {ImageColumn1, ImageColumn2})

Finally, in the CellMouseClick event, check to see if the user clicked on the right column; if so, add the new row:

http://www.codeproject.com/KB/grid/MergedDataGridViewControl.aspx?display=Print

5/26/2009

CodeProject: MergedDataGridView Control. Free source code and programming help

Page 3 of 6

' Add a new row in the correct postion (e.RowIndex + 1) Dim rowPos As Integer = e.RowIndex + 1 Dim dv As DataView = Me .MergedDataGridView1.DataSource Dim row As DataRow = dv.Table.NewRow() dv.Table.Rows.InsertAt(row, rowPos) ' Get the text from the hidden columns that will be used to fill the RichTextBox Dim mergedRowText As New System.Text.StringBuilder mergedRowText.AppendLine(Me .MergedDataGridView1( "Description" , e.RowIndex).Value.ToString) mergedRowText.AppendLine(Me .MergedDataGridView1( "Link" , e.RowIndex).Value.ToString) ' Call the AddMergedRow sub Me .MergedDataGridView1.AddMergedRow(rowPos, mergedRowText.ToString)

Or delete it:

' Remove the row from the datasource Dim rowPos As Integer = e.RowIndex + 1 Dim dv As DataView = Me .MergedDataGridView1.DataSource dv.Table.Rows.RemoveAt(rowPos) ' Call the RemoveMergedRow sub Me .MergedDataGridView1.RemoveMergedRow(Me .MergedDataGridView1(0, _ e.RowIndex).Value)

The other code used in the form, as you can see in the attached example, is for validation, error handling, and generic animation.

Looking at the control

The control has only two methods: AddMergedRow and RemoveMergedRow, and three properties. The properties just get the indication of the column where the RichTextBox will start, end, and what height it will have. The AddMergedRow looks for the number (the ID) of the previous row, that will be the parent one, and creates a new RichTextBox in the new row, with that ID as the name.

http://www.codeproject.com/KB/grid/MergedDataGridViewControl.aspx?display=Print

5/26/2009

CodeProject: MergedDataGridView Control. Free source code and programming help

Page 4 of 6

''' <summary> ''' Adds a new row with a merged cell using a richtextbox ''' </summary > ''' <param name="rowIndex" >Index where the row will be added </param > ''' <param name="cellText" >Text that will be displayed on the RichTextBox</param > ''' <remarks></remarks > Public Sub AddMergedRow( ByVal rowIndex As Integer, ByVal cellText As String) Try Me .SuspendLayout()

' Defines the location/size of the textbox Dim x As Integer = _ Me .GetColumnDisplayRectangle( Me .StartColumnIndex, False ).Left + 1 Dim y As Integer = Me .GetRowDisplayRectangle(rowIndex, False ).Top Dim w As Integer = _ Me .GetColumnDisplayRectangle( Me .EndColumnIndex, False ).Right - x - 2 Dim h As Integer = Me .GetRowDisplayRectangle(rowIndex, False ).Size.Height - 1 ' Gets the ID from the previous row, that will be used for the name ' of the textbox. This ID will be used to find the control for the row Dim parentRowID As Integer = Me (0, rowIndex - 1).Value ' Creates a new textbox and place it in the right position Dim rtb As New RichTextBox With rtb .Name = parentRowID .Text = cellText .Multiline = True .BorderStyle = BorderStyle.None .ScrollBars = ScrollBars.Vertical .ReadOnly = True .Font = New Font( Me .DefaultCellStyle.Font, Me .DefaultCellStyle.Font.Style) .SetBounds(x, y, w, h) End With Me .Controls.Add(rtb) ' Define the same color for the RichTextBox as the row color rtb.BackColor = Me (0, rowIndex).InheritedStyle.BackColor ' Define the row height Me .Rows(rowIndex).Height = Me .RowHeight ' Define a new image for the imagecell (up arrow) Dim arrow As DataGridViewImageCell = Me (Me .ColumnCount - 2, rowIndex - 1) arrow.Value = My.Resources.UpArrow Catch ex As Exception Throw New ArgumentException(ex.Message) Finally Me .ResumeLayout() End Try End Sub

The second method, RemoveMergedRow, looks for the parent row and removes it from the grid.

http://www.codeproject.com/KB/grid/MergedDataGridViewControl.aspx?display=Print

5/26/2009

CodeProject: MergedDataGridView Control. Free source code and programming help

Page 5 of 6

''' <summary> ''' Removes the cell (RichTextBox) from the DataGridView ''' </summary > ''' <param name="rowID" >ID of the row </param > ''' <remarks></remarks > Public Sub RemoveMergedRow( ByVal rowID As Integer ) Try ' Find the control in the DataGridView and remove it Dim ctrl() As Control = Me .Controls.Find(rowID.ToString, False ) If ctrl.Length = 1 Then Me .Controls.Remove(ctrl( 0)) End If ' Define a new image for the imagecell (down arrow) Dim arrow As DataGridViewImageCell = Me (Me .ColumnCount - 2, Me .CurrentRow.Index) arrow.Value = My.Resources.DownArrow Catch ex As Exception Throw New ArgumentException(ex.Message) Finally Me .ResumeLayout() End Try End Sub

The Paint event arranges the position of the RichTextBoxes, and adjusts the size. Since its not easy to calculate the positions and keep the empty rows below the parent rows after you sort it, I have turned sorting off in the ColumnAdded event.

Points of interest
This control not only shows some extra information on a DataGridView control, but also demonstrates how to customize the grid and handle row positioning, which may be useful for other projects. I really hope that this can help improve your projects, or help you get some new ideas.

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

About the Author

jpaulino Jorge Paulino Portuguese Software Developer VB.NET, ASP.NET, VBA, SQL, XML Personal Blog (Portuguese only) http://vbtuga.blogspot.com/
Occupation: Software Developer Location: Portugal

Member

http://www.codeproject.com/KB/grid/MergedDataGridViewControl.aspx?display=Print

5/26/2009

CodeProject: MergedDataGridView Control. Free source code and programming help

Page 6 of 6

Discussions and Feedback

10 messages have been posted for this article. Visit http://www.codeproject.com/KB/grid/MergedDataGridViewControl.aspx to post and view comments on this article, or click here to get a print view with messages.

Translate this page Microsoft Translator

Spanish
< >

?
?
Copyright 2009 by jpaulino Everything else Copyright CodeProject , 1999-2009 Web16 | Advertise on the Code Project

PermaLink | Privacy | Terms of Use Last Updated: 23 Apr 2009 Editor: Smitha Vijayan

http://www.codeproject.com/KB/grid/MergedDataGridViewControl.aspx?display=Print

5/26/2009