Excel催化剂开源第13波-VSTO开发之DataGridView控件几个小坑

Excel催化剂内部大量使用了DataGridView，这其中有一些小坑，花了力气才解决的，在此给广大开发者作简单分享。

为何要使用DataGridView而不是其他控件如ListBox、ListView、ComboBox之类的？因为大量的数据，特别是配置信息，都是以数据库表结构的一维表存储最为合理，一般一个配置是多列内容来定义其多样的属性。

用DataGridView最有优势之处在于，可以直接让DataTable直接绑定即可，同时带有丰富的事件可与用户交互，并且保留有用户常用的排序功能，筛选功能也容易实现，用Dataview来绑定数据源即可。

使用DataGridView的一些小坑

DataGridView内复选框状态改变激活事件

在Excel催化剂的【工作表导航】功能中，有用到DataGridView存储工作表信息，需要和用户交互的是用户点击复选框，可以对工作表的显示隐藏状态进行改变。

image.png

若直接在Checkbox列上写CellValueChanged事件，会发现不起作用的。当然这一步也不可少。

private void dataGridView1_CellValueChanged(object sender, DataGridViewCellEventArgs e)
        {
            if (Common.ExcelApp.ActiveWorkbook.ProtectStructure == false)
            {
                if (e.RowIndex != -1 && !dataGridView1.Rows[e.RowIndex].IsNewRow)
                {
                    //复选框列
                    if (e.ColumnIndex == 1)
                    {
                        string worksheetName = this.dataGridView1[0, e.RowIndex].Value.ToString();
                        Excel._Worksheet wht = Common.ExcelApp.ActiveWorkbook.Worksheets[worksheetName];
                        try
                        {
                            if ((bool)this.dataGridView1[e.ColumnIndex, e.RowIndex].Value == true)
                            {
                                wht.Visible = Excel.XlSheetVisibility.xlSheetVisible;
                            }
                            else
                            {
                                wht.Visible = Excel.XlSheetVisibility.xlSheetHidden;
                            }
                        }
                        catch (Exception)
                        {
                            MessageBox.Show($"操作有误，错误原因为:\r\n工作薄至少需要一个工作表为可见的！");
                            this.dataGridView1[e.ColumnIndex, e.RowIndex].Value = true;
                        }

                    }

                }

            }
            else
            {
                MessageBox.Show("工作薄受保护状态不可操作工作表显示/隐藏操作！");
                this.dataGridView1.CellValueChanged -= dataGridView1_CellValueChanged;
                this.dataGridView1[e.ColumnIndex, e.RowIndex].Value = true;
                this.dataGridView1.CellValueChanged += dataGridView1_CellValueChanged;
            }

        }

需要加上这个事件才可生效，具体原理可自行百度

        /// <summary>
        /// 这个为了让复选框可以单击时产生变化而用的。网上抄的。
        /// </summary>
        /// <param name="sender"></param>
        /// <param name="e"></param>
        private void dataGridView1_CurrentCellDirtyStateChanged(object sender, EventArgs e)
        {
            if (dataGridView1.IsCurrentCellDirty)
            {
                dataGridView1.CommitEdit(DataGridViewDataErrorContexts.Commit);
            }
        }

DataGridView的行手工排序问题

DataGridView原生功能没有实现通过按住某行拖动的方式实现不同行之间的排序问题。在百度上搜索了一些代码实现了此功能。

在Excel催化剂上的使用场景为，对工作表的手工排序操作。

手工排序效果

首先要打开这个AllowDrop属性

AllowDrop打开

具体代码段

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using Excel = Microsoft.Office.Interop.Excel;
namespace Excel催化剂
{
    public partial class formSheetSort : Form
    {
        public formSheetSort()
        {
            InitializeComponent();
            this.Icon = Properties.Resources.Excel催化剂logo32;
        }

        private void formSheetSort_Load(object sender, EventArgs e)
        {
            ReloadSheetName();
        }

        private void btnEnsureOrderSheetName_Click(object sender, EventArgs e)
        {
            try
            {
                Common.ExcelApp.ScreenUpdating = false;
                int shtCount = Common.ExcelApp.ActiveWorkbook.Worksheets.Count;
                foreach (DataGridViewRow row in this.dgv.Rows)
                {
                    Excel.Worksheet sht = Common.ExcelApp.ActiveWorkbook.Worksheets[row.Cells[0].Value];
                    sht.Move(After: Common.ExcelApp.ActiveWorkbook.Worksheets[shtCount]);
                }
            }
            catch (Exception ex )
            {

                MessageBox.Show("操作出错，出错原因为" + ex.Message);
            }
            finally
            {
                Common.ExcelApp.ScreenUpdating = true;
            }

        }

        private void ReloadSheetName()
        {
            foreach (Excel.Worksheet item in Common.ExcelApp.ActiveWorkbook.Worksheets)
            {
                DataGridViewRow row = new DataGridViewRow();
                int sheetNameIndex = this.SheetName.Index;

                int rowIndex = this.dgv.Rows.Add();
                this.dgv.Rows[rowIndex].Cells[sheetNameIndex].Value = item.Name;

            }

        }

        private int selectionIdx = 0;
        private void dgv_CellMouseDown(object sender, DataGridViewCellMouseEventArgs e)
        {
            if (e.RowIndex >= 0)
                selectionIdx = e.RowIndex;
        }

        private void dgv_CellMouseMove(object sender, DataGridViewCellMouseEventArgs e)
        {
            DataGridView dgv = sender as DataGridView;
            if ((e.Clicks < 2) && (e.Button == MouseButtons.Left))
            {
                if ((e.ColumnIndex == -1) && (e.RowIndex > -1))
                    dgv.DoDragDrop(dgv.Rows[e.RowIndex], DragDropEffects.Move);
            }
        }

        private void dgv_DragDrop(object sender, DragEventArgs e)
        {
            DataGridView dgv = sender as DataGridView;
            int idx = GetRowFromPoint(e.X, e.Y);
            if (idx < 0) return;

            if (e.Data.GetDataPresent(typeof(DataGridViewRow)))
            {
                DataGridViewRow row = (DataGridViewRow)e.Data.GetData(typeof(DataGridViewRow));

                int rowIndex = row.Index;
                if (idx < rowIndex)
                {
                    dgv.Rows.Remove(row);
                    selectionIdx = idx;
                    dgv.Rows.Insert(idx, row);
                }
                else
                {
                    dgv.Rows.Remove(row);
                    selectionIdx = idx - 1;
                    dgv.Rows.Insert(idx - 1, row);

                }

            }
        }

        private void dgv_RowsAdded(object sender, DataGridViewRowsAddedEventArgs e)
        {
            DataGridView dgv = sender as DataGridView;
            if (selectionIdx > -1 && dgv.Rows.Count > 0)
            {
                dgv.Rows[selectionIdx].Selected = true;
                dgv.CurrentCell = dgv.Rows[selectionIdx].Cells[0];
            }
        }

        private void dgv_DragEnter(object sender, DragEventArgs e)
        {
            e.Effect = DragDropEffects.Move;
        }

        private int GetRowFromPoint(int x, int y)
        {

            for (int i = 0; i < this.dgv.RowCount; i++)
            {
                Rectangle rec = this.dgv.GetRowDisplayRectangle(i, false);

                if (this.dgv.RectangleToScreen(rec).Contains(x, y))
                    return i;
            }

            return -1;
        }
    }
}

结语

在.Net下写VSTO插件，没有理由再用VBA那些落后的控件，DataGridView、Ado.Net这些在.Net环境里的数据控件和数据存储技术是首选，代码书写更流畅，开发效率更高，用户体验也是超棒。

此篇给大家扫清几个小坑，让大家开发过程中，更顺畅，尽情地在业务逻辑代码上发挥，少关注底层这些莫名的坑坑洼洼。

技术交流QQ群

QQ群名：Excel催化剂开源讨论群， QQ群号：788145319

Excel催化剂开源讨论群二维码

关于Excel催化剂

Excel催化剂先是一微信公众号的名称，后来顺其名称，正式推出了Excel插件，插件将持续性地更新，更新的周期视本人的时间而定争取一周能够上线一个大功能模块。Excel催化剂插件承诺个人用户永久性免费使用！

Excel催化剂插件使用最新的布署技术，实现一次安装，日后所有更新自动更新完成，无需重复关注更新动态，手动下载安装包重新安装，只需一次安装即可随时保持最新版本！

Excel催化剂插件下载链接：https://pan.baidu.com/s/1Iz2_NZJ8v7C9eqhNjdnP3Q

联系作者

公众号

取名催化剂，因Excel本身的强大，并非所有人能够立马享受到，大部分人还是在被Excel软件所虐的阶段，就是头脑里很清晰想达到的效果，而且高手们也已经实现出来，就是自己怎么弄都弄不出来，或者更糟的是还不知道Excel能够做什么而停留在不断地重复、机械、手工地在做着数据，耗费着无数的青春年华岁月。所以催生了是否可以作为一种媒介，让广大的Excel用户们可以瞬间点燃Excel的爆点，无需苦苦地挣扎地没日没夜的技巧学习、高级复杂函数的烧脑，最终走向了从入门到放弃的道路。

最后Excel功能强大，其实还需树立一个观点，不是所有事情都要交给Excel去完成，也不是所有事情Excel都是十分胜任的，外面的世界仍然是一个广阔的世界，Excel只是其中一枚耀眼的明星，还有其他更多同样精彩强大的技术、工具等。*Excel催化剂也将借力这些其他技术，让Excel能够发挥更强大的爆发！

关于Excel催化剂作者

姓名：李伟坚，从事数据分析工作多年（BI方向），一名同样在路上的学习者。
服务过行业：零售特别是鞋服类的零售行业，电商（淘宝、天猫、京东、唯品会）

技术路线从一名普通用户，通过Excel软件的学习，从此走向数据世界，非科班IT专业人士。
历经重重难关，终于在数据的道路上达到技术平原期，学习众多的知识不再太吃力，同时也形成了自己的一套数据解决方案（数据采集、数据加工清洗、数据多维建模、数据报表展示等）。

擅长技术领域：Excel等Office家族软件、VBA&VSTO的二次开发、Sqlserver数据库技术、Sqlserver的商业智能BI技术、Powerbi技术、云服务器布署技术等等。

2018年开始职业生涯作了重大调整，从原来的正职工作，转为*职业者，暂无固定收入，暂对前面道路不太明朗，苦重新回到正职工作，对Excel催化剂的运营和开发必定受到很大的影响（正职工作时间内不可能维护也不可能随便把工作时间内的成果公布于外，工作外的时间也十分有限，因已而立之年，家庭责任重大）。

和广大拥护者一同期盼：Excel催化剂一直能运行下去，我所惠及的群体们能够给予支持（多留言鼓励下、转发下朋友圈推荐、小额打赏下和最重点的可以和所在公司及同行推荐推荐，让我的技术可以在贵司发挥价值，实现双赢（初步设想可以数据顾问的方式或一些小型项目开发的方式合作）。

技术交流QQ群

QQ群名：Excel催化剂开源讨论群， QQ群号：788145319

Excel催化剂开源讨论群二维码

关于Excel催化剂

Excel催化剂先是一微信公众号的名称，后来顺其名称，正式推出了Excel插件，插件将持续性地更新，更新的周期视本人的时间而定争取一周能够上线一个大功能模块。Excel催化剂插件承诺个人用户永久性免费使用！

Excel催化剂插件使用最新的布署技术，实现一次安装，日后所有更新自动更新完成，无需重复关注更新动态，手动下载安装包重新安装，只需一次安装即可随时保持最新版本！

Excel催化剂插件下载链接：https://pan.baidu.com/s/1Iz2_NZJ8v7C9eqhNjdnP3Q

联系作者

公众号

取名催化剂，因Excel本身的强大，并非所有人能够立马享受到，大部分人还是在被Excel软件所虐的阶段，就是头脑里很清晰想达到的效果，而且高手们也已经实现出来，就是自己怎么弄都弄不出来，或者更糟的是还不知道Excel能够做什么而停留在不断地重复、机械、手工地在做着数据，耗费着无数的青春年华岁月。所以催生了是否可以作为一种媒介，让广大的Excel用户们可以瞬间点燃Excel的爆点，无需苦苦地挣扎地没日没夜的技巧学习、高级复杂函数的烧脑，最终走向了从入门到放弃的道路。

最后Excel功能强大，其实还需树立一个观点，不是所有事情都要交给Excel去完成，也不是所有事情Excel都是十分胜任的，外面的世界仍然是一个广阔的世界，Excel只是其中一枚耀眼的明星，还有其他更多同样精彩强大的技术、工具等。*Excel催化剂也将借力这些其他技术，让Excel能够发挥更强大的爆发！

关于Excel催化剂作者

姓名：李伟坚，从事数据分析工作多年（BI方向），一名同样在路上的学习者。
服务过行业：零售特别是鞋服类的零售行业，电商（淘宝、天猫、京东、唯品会）

技术路线从一名普通用户，通过Excel软件的学习，从此走向数据世界，非科班IT专业人士。
历经重重难关，终于在数据的道路上达到技术平原期，学习众多的知识不再太吃力，同时也形成了自己的一套数据解决方案（数据采集、数据加工清洗、数据多维建模、数据报表展示等）。

擅长技术领域：Excel等Office家族软件、VBA&VSTO的二次开发、Sqlserver数据库技术、Sqlserver的商业智能BI技术、Powerbi技术、云服务器布署技术等等。

2018年开始职业生涯作了重大调整，从原来的正职工作，转为*职业者，暂无固定收入，暂对前面道路不太明朗，苦重新回到正职工作，对Excel催化剂的运营和开发必定受到很大的影响（正职工作时间内不可能维护也不可能随便把工作时间内的成果公布于外，工作外的时间也十分有限，因已而立之年，家庭责任重大）。

和广大拥护者一同期盼：Excel催化剂一直能运行下去，我所惠及的群体们能够给予支持（多留言鼓励下、转发下朋友圈推荐、小额打赏下和最重点的可以和所在公司及同行推荐推荐，让我的技术可以在贵司发挥价值，实现双赢（初步设想可以数据顾问的方式或一些小型项目开发的方式合作）。