在DataGrid(WinForm)中改变符合指定条件的行颜色的方法

鼓起勇气贴上这篇帖子,实在不知道究竟是否有人会看。而随着Whidbey的推出,这个问题应该已经不复存在——新的DataGridView控件据说可以直接设置行颜色——不过考虑到Whidbey目前只是测试版,DataGrid控件还在广泛地使用,本文或许能对面临同样问题的朋友稍有帮助。

大家都知道DataGrid控件通过其属性TableStyles控制每个对应的DataTable的显示风格,而每个TableStyle又通过其属性GridColumnStyles控制每一列的显示风格,但却没有属性或方法可以直接设置每行数据的显示风格。这或许是出于使用方法考虑(在绑定数据源前当然不知道有哪些行,行中有哪些数据),或许是出于性能考虑(为每行建立显示风格索引的代价会比较大),或者是其他考虑(我没想到的^_^)。但实际工作中这种需求很多,比如“当资源小于某个临界值就变红色显示”之类的。如果可以做到改变行的颜色,应该能满足这些需求中的大部分。然而按照常规方法,在一列当中,每个单元格(即每行)的显示风格都是相同的。

改变DataGrid控件行颜色的基本技巧就是重写DataGridColumnStyle的Paint方法,更改其中的foreBrush和backBrush两个参数,再重新调用基类的Paint方法。当然实际操作中我们不能直接继承DataGridColumnStyle类,而是要从它的子类DataGridTextBoxColumn,DataGridBoolColumn中继承(可惜我们不能在这个继承层次中插入我们自己的类,呵呵)。如下所示:
 public class  DataGridColoredTextBoxColumn : DataGridTextBoxColumn
 {
  //重载绘制单元格的函数,如果该单元格所在行符合ColoredView中的条件,就改变前景和背景色
  protected override void Paint(System.Drawing.Graphics g,
   System.Drawing.Rectangle bounds, System.Windows.Forms.CurrencyManager
   source, int rowNum, System.Drawing.Brush backBrush, System.Drawing.Brush
   foreBrush, bool alignToRight)
  {
   /*在这里加入判断条件,决定是否更改颜色
   if (...)
    backBrush = new SolidBrush(...);
    foreBrush = new SolidBrush(...);
   */
   
   //调用基类的绘制函数
   base.Paint(g, bounds, source, rowNum, backBrush, foreBrush, alignToRight);
  }
 }

这个方法本身很好理解,我们再为这个类加上一个设置颜色的公共方法,就可以在使用的时候指定颜色了(这里的颜色是广义的概念,对于Brush来说,也可以指定渲染方式)。问题的关键在于我们如何设置if里面的那个条件:我们能看出Paint方法的参数rowNum给出了正在绘制的当前行行号,那么是否可以通过指定行号来决定改变那一行的颜色呢?答案是否定的。首先,rowNum给出的行号是当前显示的行号,而我们在外部通过某些条件选出来的往往是DataSource中的行号,由于排序等操作会改变显示顺序,这两者有可能不一致;其次,我们往往是希望符合一定条件的行变色,而不是特定位置的行变色,如果直接指定行号,就会造成设置的颜色成了DataGrid的背景,有失初衷。

既然如此,我们是不是可以通过rowNum直接取出要判断的那一列的内容,根据它的值来判断是否变色呢?网上有不少例子都是这么实现的,作为展示一个技巧,当然已经足够了,不过实际使用却不太方便。因为这势必要求我们把判断条件("age>20", "name like 'Jack'"之类的)硬编码在方法中,不够灵活,如果有多个地方需要设置不同的条件,岂不是要编写多个类?况且要真正地取出rowNum对应的某一列的值,也不是那么容易的。

要解决上述两个问题,比较理想的思路就是首先想办法取出rowNum在其绑定的dataSource中对应的行,再通过公共方法指定要变色的行,比较两者是否相等,如果相等就按预先设置的Brush更改前景和背景。下面是我找到的一种获取DataSource中对应rowNum的行的方法,通过获取一个当前的DataView实现,也许不够简洁,不过确实可用:
 //获取当前正在显示的DataView
 DataView currentView;
 Type iType = this.DataGridTableStyle.DataGrid.DataSource.GetType();
 if (iType==typeof(System.Data.DataView) )
  currentView = (DataView)(this.DataGridTableStyle.DataGrid.DataSource);
 else if (iType==typeof(System.Data.DataTable) )
  currentView = ((DataTable)(this.DataGridTableStyle.DataGrid.DataSource)).DefaultView;
 else if (iType==typeof(System.Data.DataSet) )
  currentView = ((DataSet)(this.DataGridTableStyle.DataGrid.DataSource)).Tables[this.DataGridTableStyle.MappingName].DefaultView;
 else if (iType==typeof(System.Data.DataViewManager) )
 {
  DataViewManager viewManager = (DataViewManager)(this.DataGridTableStyle.DataGrid.DataSource);
  currentView = viewManager.DataSet.Tables[this.DataGridTableStyle.MappingName].DefaultView;
 }
 else
 { //如果dataSource不符合以上四种类型(应该不会吧^_^),抛出系统错误
  throw(new SystemException());
 }
 
 //取出当前行
 DataRow currentRow = currentView[rowNum].Row;
 
找到当前行后就好办了,和预先指定的一系列行做比较,就可以知道是不是应该变色,如下所示:
 //搜索当前行是否在设置行色彩的ColoredView当中
 DataRow currentRow = currentView[rowNum].Row;
 foreach (DataRow coloredRow in m_coloredDataRows) //m_coloredDataRows是一个DataRow类型的数组,是private的成员变量
 {
  if (currentRow == coloredRow)
  {
   backBrush = m_backBrush;
   foreBrush = m_foreBrush;
   break;
  }
 }
至此,我们终于给出了if的判断条件,问题也就解决了。为了便于使用,我们还要提供一个公共方法,以及几个私有成员,来供外界设置行和颜色,该方法可以粗略实现如下:
 private System.Data.DataRow[] m_coloredDataRows;
 private System.Drawing.Brush m_foreBrush;
 private System.Drawing.Brush m_backBrush;

 //设置行色彩
 public void SetRowsColor(DataRow[] aDataRows, System.Drawing.Brush aForeBrush, System.Drawing.Brush aBackBrush)
 {
  //设置要改变颜色的行
  m_coloredDataRows = aDataRows;
  //设置前景色
  m_foreBrush = aForeBrush;
  //设置背景色
  m_backBrush = aBackBrush;
 }

使用这个类的方法很简单,下面举一个例子,是用其中dTable是一个DataTable对象,用它的Select方法选出了要变色的行,作为SetRowsColor的实参:
 //设置列以及每列的行样式
 DataGridTableStyle dgTableStyle = new DataGridTableStyle();
 dgTableStyle.MappingName = dTable.TableName;
 foreach (DataColumn eachCol in dTable.Columns)
 {
  DataGridColoredTextBoxColumn dbColumnStyle = new DataGridColoredTextBoxColumn();
  dbColumnStyle.MappingName = eachCol.ColumnName;
  //设置变色行的条件以及前景和背景色
  dbColumnStyle.SetRowsColor(dTable.Select("age>20"), new SolidBrush(Color.White), new SolidBrush(Color.BlueViolet));
  dgTableStyle.GridColumnStyles.Add(dbColumnStyle);
 }
 
 //添加样式到dataGrid1
 dataGrid1.TableStyles.Add(dgTableStyle);
 
当然,如果希望通用型更强,这个类还有很多功能有待完善,比如目前只能设定一组行的颜色,再次设置会替换掉原来的内容,要想设置多组行与颜色的对应,还得添加一些数据结构;还有当前只能设置Brush,实现不了改变字体之类的功能,不过目前我也还没找到好办法(Paint方法以及PaintText方法都没有关于字体的参数)。

完整的测试代码附在下面:
using System.Data;

public class Form2 : System.Windows.Forms.Form
{
 public Form2()
 {
  //
  // Windows 窗体设计器支持所必需的
  //
  InitializeComponent();

  DataTable dTable;

  //创建测试DataTable
  dTable = new DataTable("person");
  //添加测试列
  dTable.Columns.Add(new DataColumn("id",typeof(int)) );
  dTable.Columns.Add(new DataColumn("name",typeof(string)) );
  dTable.Columns.Add(new DataColumn("age",typeof(int)) );
  //添加测试行   
  DataRow newDataRow;
  Random iRandom = new Random();
  for(short i=0;i<20;i++)
  {
   newDataRow = dTable.NewRow();
   newDataRow[0] = i;
   newDataRow[1] = Convert.ToString(iRandom.Next(0,15))+"song";
   newDataRow[2] = iRandom.Next(15,30);
   dTable.Rows.Add(newDataRow);
  }

  //设置列以及每列的行样式
  DataGridTableStyle dgTableStyle = new DataGridTableStyle();
  dgTableStyle.MappingName = dTable.TableName;
  foreach (DataColumn eachCol in dTable.Columns)
  {
   DataGridColoredTextBoxColumn dbColumnStyle = new DataGridColoredTextBoxColumn();
   dbColumnStyle.MappingName = eachCol.ColumnName;
   //设置变色行的条件以及前景和背景色
   dbColumnStyle.SetRowsColor(dTable.Select("age>20"), new SolidBrush(Color.White), new SolidBrush(Color.BlueViolet));
   dgTableStyle.GridColumnStyles.Add(dbColumnStyle);
  }
  
  //添加样式到dataGrid1
  dataGrid1.TableStyles.Add(dgTableStyle);
  
  dataGrid1.SetDataBinding(dTable,"");  
 }
}

public class  DataGridColoredTextBoxColumn : DataGridTextBoxColumn
{
 private System.Data.DataRow[] m_coloredDataRows;
 private System.Drawing.Brush m_foreBrush;
 private System.Drawing.Brush m_backBrush;

 //设置行色彩
 public void SetRowsColor(DataRow[] aDataRows, System.Drawing.Brush aForeBrush, System.Drawing.Brush aBackBrush)
 {
  //设置要改变颜色的行
  m_coloredDataRows = aDataRows;
  //设置前景色
  m_foreBrush = aForeBrush;
  //设置背景色
  m_backBrush = aBackBrush;
 }

 //重载绘制单元格的函数,如果该单元格所在行符合ColoredView中的条件,就改变前景和背景色
 protected override void Paint(System.Drawing.Graphics g,
  System.Drawing.Rectangle bounds, System.Windows.Forms.CurrencyManager
  source, int rowNum, System.Drawing.Brush backBrush, System.Drawing.Brush
  foreBrush, bool alignToRight)
 {
  //获取当前正在显示的DataView
  DataView currentView;
  Type iType = this.DataGridTableStyle.DataGrid.DataSource.GetType();
  if (iType==typeof(System.Data.DataView) )
   currentView = (DataView)(this.DataGridTableStyle.DataGrid.DataSource);
  else if (iType==typeof(System.Data.DataTable) )
   currentView = ((DataTable)(this.DataGridTableStyle.DataGrid.DataSource)).DefaultView;
  else if (iType==typeof(System.Data.DataSet) )
   currentView = ((DataSet)(this.DataGridTableStyle.DataGrid.DataSource)).Tables[this.DataGridTableStyle.MappingName].DefaultView;
  else if (iType==typeof(System.Data.DataViewManager) )
  {
   DataViewManager viewManager = (DataViewManager)(this.DataGridTableStyle.DataGrid.DataSource);
   currentView = viewManager.DataSet.Tables[this.DataGridTableStyle.MappingName].DefaultView;
  }
  else
  { //如果dataSource不符合以上四种类型(应该不会吧^_^),抛出系统错误
   throw(new SystemException());
  }

  //搜索当前行是否在设置行色彩的ColoredView当中
  DataRow currentRow = currentView[rowNum].Row;
  foreach (DataRow coloredRow in m_coloredDataRows)
  {
   if (currentRow == coloredRow)
   {
    backBrush = m_backBrush;
    foreBrush = m_foreBrush;
    break;
   }
  }

  //调用基类的绘制函数
  base.Paint(g, bounds, source, rowNum, backBrush, foreBrush, alignToRight);
 }

}

更改后,原来显示列名的列头没有显示了:(  回复   

# re: 在DataGrid(WinForm)中改变符合指定条件的行颜色的方法 2005-08-23 09:00 rrr

Sorry,不是BUG,是该完善,应该在DataGridColoredTextBoxColumn 类内增加如下代码:

//重载标头文本属性
public override string HeaderText
{
get
{
return base.MappingName;
}
set
{
base.HeaderText = value;
}
}

你完全可以将重画的方式做一个事件公布出来,就可以更灵活的使用。
就象 Delphi 中的 DBGrid 的 OnDrawCell 的事件一样,我就是这么做的。  回复
bundur的提议不错,但是与作者的方法都有一个通病就是要继承DataGridTextBoxColumn,DataGridBoolColumn等等的DataGridColumnStyle类,如果出现有自定义的譬如DataGridDateTimeColumn、DataGridMaskTextBoxColumn等类,又要自定义继承,感觉非常不好。
楼主曾提到“直接继承DataGridColumnStyle类”,这是非常棒的想法。为了不影响DataGridColumnStyle类的被继承,我觉得可以写一个Provider组件,在该组件中将DataGridColumnStyle类的Paint事件抽离出来自己重画,这应该是个好方法。不知可行不,我试试看。
(BTW: Provider组件是指实现了接口System.ComponentModel.IExtenderProvider的System.ComponentModel.Component子类)  回复

你可能感兴趣的:(datagrid)