開源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下載：[email protected]

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

源碼下載  ：ver4.0_帶上CellFormatter的源碼.rar

---