Click here to Skip to main content
15,860,972 members
Articles / Programming Languages / C#
Article

Formatting the Datarow based on a single cell value and Custom Table Styles.

Rate me:
Please Sign up or sign in to vote.
4.00/5 (12 votes)
28 Apr 20032 min read 122K   1.9K   24   20
An article that demonstrates row formatting and adding custom styles to the designer.

Sample Image - article1.jpg

Introduction

In this article I want to show you how to change the format of a single DataRow in the grid, based on the value of a single cell in that row.

Also, I will attempt to explain the process of adding custom styles to the Styles collection of your Datagrid collection editor, so that you can use them in the DataGrid at design time.

You can look at http://www.syncfusion.com/FAQ/WinForms/FAQ_c44c.asp#q1020q for more information on this topic.

Using the code

To control the formatting of a single row, based on the value of a cell, you have to do the following:

  1. Derive from the DataGridTextBoxColumn.
    C#
    public class FormattedTextBoxColumn : DataGridTextBoxColumn 
    { 
        public CellPaint _handle ; 
        public CellPaint PaintHandle 
        { 
            get 
            { 
                return _handle ; 
            } 
            set 
            { 
                _handle = value; 
            } 
        } 
        ...; 
        ...;
    }
  2. Override the 4 paint methods of the DataGridTextBox column.
    C#
    protected override void Paint(Graphics g,Rectangle Bounds,
                                  CurrencyManager Source,int RowNum,
                                  Brush BackBrush ,Brush ForeBrush ,
                                  bool AlignToRight)
    {
       Object data = ( Object ) GetColumnValueAtRow(Source, RowNum);    
       String strData ; 
       strData = data.ToString() ; 
    
       FormatEventArgs e = new FormatEventArgs(RowNum) ;
     
       if( _handle != null) 
        _handle(new object(),ref e) ; 
            
       g.FillRectangle(e.BackBrush, Bounds.X, 
            Bounds.Y, Bounds.Width, Bounds.Height);
                
       FontStyle fs = FontStyle.Regular ; 
       if( e.strikeThrough == true ) 
       { 
         fs = FontStyle.Strikeout ; 
       }
       System.Drawing.Font font = new 
               Font(System.Drawing.FontFamily.GenericSansSerif, 
               (float)8.25 ,fs);
       g.DrawString( strData ,font ,Brushes.Green ,
               Bounds.X ,Bounds.Y );
    
    }
  3. Define a delegate, to be called from the paint functions ( The ones you override )
    C#
    public delegate void CellPaint(object o, ref FormatEventArgs e);
  4. Define a class, which derives from EventArgs, call this FormatEventArgs, and which will be used to pass information back to the delegate.
    C#
    public class FormatEventArgs : EventArgs  { 
     ... ; 
     ... ; 
    }

To add the custom style to the designer, you need to:

  1. Create a custom Datagrid, which derives from the DataGrid ( user defined control )
    C#
    public class CustomDataGrid : DataGrid { 
      ....
    }
    1. Hide the data member, GridTableStylesCollection of the DataGrid like this:
      C#
      [Editor(typeof(CustomTableStylesCollectionEditor), 
                    typeof(UITypeEditor))]
      public new GridTableStylesCollection TableStyles
      {
         get{return base.TableStyles;}
      }

      This is the data member which returns the Table Style collection in your designer. Hide it, so that you can return your own type.

    2. Create an internal class, which derives from the CollectionEditor, and override the function CreateNewItemTypes, which will now return your custom styles.
      C#
      private class CustomTableStylesCollectionEditor : 
                                                CollectionEditor
      {
        public CustomTableStylesCollectionEditor
                             (Type type):base(type)
        {
        }
              
        //Over ride the function which will return 
        //the STYLES collection 
      
        protected override System.Type[] CreateNewItemTypes()
        {
          // refer to POINT 2
          return new Type[] {typeof(CustomStylesCollection)}; 
        } 
      }
  2. Create a custom DataGridTableStyle, which is derived from the DataGridTableStyle.
    C#
    public class CustomStylesCollection : DataGridTableStyle
    {
        ... ; 
        ... ;
    }
    1. Now, hide the data member GridColumnStylesCollection, this member shows the default ColumnStyles available at design time.
      C#
      Editor(typeof(CustomColumnStylesCollectionEditor), 
                       typeof(UITypeEditor))]
      public new GridColumnStylesCollection GridColumnStyles
      {
        get {return base.GridColumnStyles;}
      }

      and,

      C#
      protected override DataGridColumnStyle 
            CreateGridColumn(PropertyDescriptor prop, bool isDefault)
      {
          return base.CreateGridColumn(prop, isDefault);
      }
    2. Create an internal class which derives from the CollectionEditor, and override the function CreateNewItemTypes, which will now return your custom styles.
      C#
      private class CustomColumnStylesCollectionEditor : 
                                      CollectionEditor
      {
        public CustomColumnStylesCollectionEditor(Type type) : 
                                           base(type)
        {
        }
      
        protected override System.Type[] CreateNewItemTypes()
        {
         return new Type[] 
         {    
           typeof(FormattedTextBoxColumn), // Your Custom Style 
           typeof(DataGridTextBoxColumn),  // Default Style
           typeof(DataGridBoolColumn)      // Default Style
         }; 
        } 
      }

Once you build the project, the CustomDataGrid, should be available in your Toolbox.

In your Form application, drop this CustomDataGrid. Then use the designer to add column styles to the DataGrid.

I attempted to expose the PaintHandler, in the properties box, but for some reason, it won't let me hook the delegate there.

If some one has any ideas to how I could do it, please let me know.

For now, manually hook the delegate like this:

C#
formattedTextBoxColumn1.PaintHandle += new CellPaint(PaintHandler) ;

And, define the function PaintHandler, which will allow customized handling of your formats.

C#
public void PaintHandler( object o, ref FormatEventArgs e) 
{ 
  try 
  { 
    FormatEventArgs E = (FormatEventArgs) e ; 
    int rowNum = E.RowNum ; 
        DataRow dr = ds.Tables["table"].Rows[rowNum] ; 
                 
    if( dr[0].ToString() == "X" || dr[0].ToString() == "x") 
    {
       E.BackBrush = Brushes.Beige; 
       E.strikeThrough = true ; 
    }
    else 
    {
      E.BackBrush = Brushes.White ; 
    }
                
                
  }
  catch( System.SystemException ) 
  { 
  } 
}

You would need to declare all the column styles for the DataGrid of type FormattedTextBoxColumn, and hook each style to the function.

I hope this helps.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here


Written By
Architect
United States United States
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions

 
Generalworks great Pin
strother26-Feb-09 10:38
strother26-Feb-09 10:38 
Questionoriginal code? Pin
coolest_dude18-Apr-06 9:38
coolest_dude18-Apr-06 9:38 
GeneralCustomDataGrid not available in Toolbox Pin
daniel_at_mcgarry.com3-Jan-06 10:59
daniel_at_mcgarry.com3-Jan-06 10:59 
GeneralMaster - Detail - no default key inserted Pin
ChristianL200413-Jan-05 1:26
ChristianL200413-Jan-05 1:26 
QuestionSorry to be dumb but how do I use this? Pin
22-Apr-04 5:07
suss22-Apr-04 5:07 
AnswerRe: Sorry to be dumb but how do I use this? Pin
Sameer Khan22-Apr-04 11:36
Sameer Khan22-Apr-04 11:36 
GeneralRe: Sorry to be dumb but how do I use this? Pin
skintstudent28-Apr-04 3:21
skintstudent28-Apr-04 3:21 
Just getting round to looking into the issue again. Somebody also suggested looking at this page to me:

http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnwinforms/html/wnf_CustDataGrid.asp

Will post my results once I have done so.

Yes I did manage to build the app, but I failed to copy and paste the key classes into my app.


GeneralRe: Sorry to be dumb but how do I use this? Pin
skintstudent28-Apr-04 22:28
skintstudent28-Apr-04 22:28 
QuestionHow to change column caption font in datagrid Pin
Anonymous26-Mar-04 9:27
Anonymous26-Mar-04 9:27 
GeneralSelecting complete row Pin
Joerg Eichhorn20-Jan-04 6:52
Joerg Eichhorn20-Jan-04 6:52 
GeneralRe: Selecting complete row Pin
Sameer Khan20-Jan-04 14:33
Sameer Khan20-Jan-04 14:33 
GeneralRe: Selecting complete row Pin
Joerg Eichhorn21-Jan-04 0:33
Joerg Eichhorn21-Jan-04 0:33 
GeneralRe: Selecting complete row Pin
student_rhr13-Jan-06 7:19
student_rhr13-Jan-06 7:19 
GeneralUsing this grid and colors in vb Pin
poojamin18-Jul-03 11:49
poojamin18-Jul-03 11:49 
GeneralRe: Using this grid and colors in vb Pin
Sameer Khan21-Jul-03 19:37
Sameer Khan21-Jul-03 19:37 
GeneralRe: Using this grid and colors in vb Pin
poojamin22-Jul-03 13:41
poojamin22-Jul-03 13:41 
GeneralFormatting incorrect when columns are sorted Pin
M.Lansdaal30-Apr-03 9:52
M.Lansdaal30-Apr-03 9:52 
GeneralRe: Formatting incorrect when columns are sorted Pin
Sameer Khan30-Apr-03 12:34
Sameer Khan30-Apr-03 12:34 
GeneralRe: Formatting incorrect when columns are sorted Pin
M.Lansdaal11-Aug-03 7:14
M.Lansdaal11-Aug-03 7:14 
GeneralRe: Formatting incorrect when columns are sorted Pin
Sameer Khan31-Jul-03 11:40
Sameer Khan31-Jul-03 11:40 

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.