开源DataGridView扩展（3） 单元格格式化器的设计 DataGridCellFormatter

图：效果图

 

一、 设计初衷

1. 有没有想过当你的表格中的某些数据需要分类时该如何做？

2. 有没有想过当表格中的数据根据某一状态来启用/禁用某个按钮？

3. 有没有想过为了突出某一些数据，所以加颜色来区分？

4. 总得来说，就是如何根据数据来设置行或单元格的样式？

二、 设计实现

      通过以上几个疑问，最终也归结为一点：如何根据数据来设置行或单元格的样式? 其实这个问题，我也纠结了一段时间，后来再详细的查找尝试后，不经意间发现在DataGridView中有一个CellFormatting事件，这样的话就为我的解决方案提供了基础。

1. 思考之一，对于单元格的格式化，由于是基于内容来改变样式，所以可以为列（Column）来注册一个格式化器，因为列的内容类型是一致的。

2. 思考之二，为了能提供在封装之后的样式的灵活改变，就应该把格式化器的注册开放到外部，所以以委托形式来注册。

综上考虑，最终设计了这么一个类：

public class DataGridCellFormatter : IDisposable
   {

       /// <summary>
       /// 值与显示转换的委托
       /// </summary>
       /// <param name="columnName">当前列名</param>
       /// <param name="value">当前列值</param>
       /// <returns>转换后的显示值</returns>
       public delegate void CellFormatDelegate(string columnName, DataGridViewCellFormattingEventArgs value);

       /// <summary>
       /// key:列名，value：注册的委托
       /// </summary>
       private Dictionary<string, CellFormatDelegate> m_cellFormatters = new Dictionary<string, CellFormatDelegate>();

       /// <summary>
       /// 将列转换注册到具体的方法
       /// </summary>
       /// <param name="columnName">注册列名称</param>
       /// <param name="formatter">注册列转换方法</param>
       public void RegisterFormatter(string columnName, CellFormatDelegate formatter)
       {
           if (!string.IsNullOrEmpty(columnName) && formatter != null)
               m_cellFormatters[columnName] = formatter;
       }

       /// <summary>
       /// 获取注册格式化器
       /// </summary>
       /// <param name="columnName"></param>
       public CellFormatDelegate GetRegisterFormatter(string columnName)
       {
           if (m_cellFormatters.ContainsKey(columnName))
               return m_cellFormatters[columnName];
           return null;
       }

       /// <summary>
       /// 执行格式化操作
       /// </summary>
       /// <param name="columnName"></param>
       /// <param name="defaultValue"></param>
       public void RunFormatter(string columnName, DataGridViewCellFormattingEventArgs defaultValue)
       {
           CellFormatDelegate formatter = GetRegisterFormatter(columnName);
           if (formatter == null) return;
           formatter(columnName, defaultValue);
       }

       public void Dispose()
       {
           if (m_cellFormatters.Count > 0)
               m_cellFormatters.Clear();
       }
   }

然后再CellFormatting中把格式化器给Hook到DataGridViewEx上面：

        protected override void OnCellFormatting(DataGridViewCellFormattingEventArgs e)
        {
            //Mark：在这里执行注册的程序
            this.CellFormatterRegister.RunFormatter(this.Columns[e.ColumnIndex].Name, e);
            base.OnCellFormatting(e);
        }

最后，使用者只要在引用DataGridViewEx的时候，注册一下想要的列改变就行了：

 

  protected void RegisterCellFormatters()
        {
            this.dataGridViewEx1.CellFormatterRegister.RegisterFormatter("Column5",
                new DataGridCellFormatter.CellFormatDelegate(FormatColumn5));
            this.dataGridViewEx1.CellFormatterRegister.RegisterFormatter("Column4",
                new DataGridCellFormatter.CellFormatDelegate(FormatColumn4));
        }

        //根据内容改变Column5的文本颜色
        internal void FormatColumn5(string columnName, DataGridViewCellFormattingEventArgs e)
        {
            if (e.Value.ToString().Contains("5"))
            {
                e.CellStyle.ForeColor = Color.Green;
            }

            if (e.Value.ToString().Contains("3"))
            {
                e.CellStyle.ForeColor = Color.Red;
            }
        }

        // 根据内容设置自定义按钮列为不可用
        internal void FormatColumn4(string columnName, DataGridViewCellFormattingEventArgs e)
        {
            if (e.Value.ToString().Contains("2"))
            {
                DataGridViewButtonCellEx cell =
                    this.dataGridViewEx1.Rows[e.RowIndex].Cells[e.ColumnIndex] as DataGridViewButtonCellEx;
                if (cell != null)
                {
                    cell.Enabled = false;
                }
            }

        }


ok，一切都搞定，让它自动运行吧。

三、 Demo程序和开源源码

 

Demo下载：DataGridCellFormatter@DataGridViewEx.rar

开源地址  ：http://sourceforge.net/p/datagridviewex/code-0/3/tree/trunk/DataGridViewEx/

源码下载  ：ver4.0_带上CellFormatter的源码.rar

---