基于DevExpress的GridControl实现的一些界面处理功能

王才志

DevExpress的GridControl控件能够提供很多强大的操作，其视图GridView能够通过各种设置，呈现出多种复杂的界面效果，本篇随笔探讨一些常见的GridControl控件及其GridView的视图操作处理，以便在大家也需要的时候作为一个参考的代码。其中设计一些常见的操作，如合并单元格、汇总统计、复制粘贴行、导入数据处理、导出Excel、导出PDF等、打印GridView视图、内置插入及保存数据处理等等。
1、合并单元格

 有时候，需要把多行紧挨着的单元格内容进行合并展示，这样有助于界面的美观及查看便利，如下界面所示。

 或者这样的界面，都是类似的效果。

合并的处理比较简单，只需要设置允许合并，以及实现合并的处理事件代码即可。 

1.     //允许合并
2.     this.gridView1.OptionsView.AllowCellMerge = true;

复制代码

然后实现的事件代码如下所示。

1.         private List<string> mergeFields = new List<string> { "订单号", "客户订单号", "客户编码", "客户名称", "组合编码", "组合名称"};
2.         private void GridView1_CellMerge(object sender, CellMergeEventArgs e)
3.         {
4.             var fieldName = e.Column.FieldName;
5.             if(mergeFields.Contains(fieldName))
6.             {
7.                 var view = sender as GridView;
8.                 if(view != null)
9.                 {
10.                     // 获取当前单元格的值
11.                     var cellValue = view.GetRowCellValue(e.RowHandle1, fieldName);
12.                     // 获取前一行相同列的单元格的值
13.                     var prevCellValue = view.GetRowCellValue(e.RowHandle2, fieldName);
15.                     if (e.RowHandle2 >= 0 && cellValue != null && cellValue.Equals(prevCellValue))
16.                     {
17.                         // 合并单元格
18.                         e.Merge = true;
19.                         e.Handled = true;
20.                     }
21.                 }
22.             }
23.             else
24.             {
25.                 e.Merge = false;
26.                 e.Handled = true;
27.             }
28.         }

复制代码

我们可以根据自己的业务需要，设置一些合并的字段，放在列表中即可。呈现的界面效果类似下面所示。

这里值得注意的时候，如果我们需要把列表设置为具有复选框的记录显示模式，方便勾选来进行其他操作，那么就需要取消合并的功能。 

1. this.gridView1.OptionsView.AllowCellMerge = false;

复制代码

这样才可以进行展示复选框的处理。

 
2、汇总统计处理

汇总的处理，也是类似的操作，需要设置显示底部的面板，以及设置好汇总列的处理信息。
 

 为了更方便的设置统计信息，我们可以建立一个扩展函数的方式，来实现统计行的信息处理，如下扩展方法所示。

1. /// <summary>
2. /// 设置统计列内容
3. /// </summary>
4. /// <param name="gridView">GridView对象</param>
5. /// <param name="fieldName">统计字段</param>
6. /// <param name="summaryItemType">统计类型</param>
7. /// <param name="prefix">显示前缀</param>
8. public static void SetSummaryColumn(this GridView gridView, string fieldName, SummaryItemType summaryItemType = SummaryItemType.Sum,
9.     string prefix = "")
10. {
11.     if (!gridView.OptionsView.ShowFooter)
12.     {
13.         gridView.OptionsView.ShowFooter = true;
14.     }
16.     if (gridView.Columns.Count > 0)
17.     {
18.         gridView.Columns[fieldName].SummaryItem.FieldName = fieldName;
19.         gridView.Columns[fieldName].SummaryItem.DisplayFormat = gridView.Columns[fieldName].DisplayFormat.FormatString;
20.         gridView.Columns[fieldName].SummaryItem.SummaryType = summaryItemType;
21.         gridView.Columns[fieldName].SummaryItem.DisplayFormat = prefix + "{0}";
22.     }
23. }

复制代码

如果我们需要在创建统计行的时候，请空它之前的记录信息，那么也可以增加多一个扩展函数来处理清空统计信息，如下所示。

1. /// <summary>
2. /// 清空统计项目
3. /// </summary>
4. /// <param name="gridView"></param>
5. public static void ClearSummaryColumns(this GridView gridView)
6. {
7.     gridView.OptionsView.ShowFooter = false;
8.     foreach (GridColumn column in gridView.Columns)
9.     {
10.         if (column.SummaryItem != null)
11.         {
12.             column.SummaryItem.Collection.Clear();
13.         }
14.     }
15. }

复制代码

最终我们在界面上创建统计信息的代码如下所示。

1.     //添加统计行
2.     gridView1.ClearSummaryColumns();
3.     gridView1.SetSummaryColumn("订单量", DevExpress.Data.SummaryItemType.Sum);
4.     gridView1.SetSummaryColumn("完成数量", DevExpress.Data.SummaryItemType.Sum);

复制代码

最终的界面效果如下所示

 
3、复制粘贴行及导入处理

有时候为了更加便捷的对记录信息进行复制或者粘贴到GridView列表中进行处理，那么需要设置相关的GridView的属性，让它能够允许复制并设置复制的信息，这样的格式化后，就可以用于粘贴到记事本或者粘贴到新增记录模式下的GridView视图中了。
我们只需要设置其中的OptionsClipboard中的某些属性，如下代码所示。

1. //实现选择复制到新的行中
2. view.OptionsClipboard.AllowCopy = DefaultBoolean.True;  //允许复制
3. view.OptionsClipboard.CopyColumnHeaders = DefaultBoolean.False;  //是否复制表头
4. view.OptionsClipboard.PasteMode = DevExpress.Export.PasteMode.Append; //粘贴模式
5. view.OptionsClipboard.ClipboardMode = DevExpress.Export.ClipboardMode.Formatted;//格式化模式

复制代码

然后，如果我们的GridView是设置到编辑模式的话，设置下面的代码，让它可以新增粘贴的记录。

1. view.OptionsBehavior.Editable = true;
2. view.OptionsBehavior.ReadOnly = false;
3. view.OptionsBehavior.AllowAddRows = true;

复制代码

设置好这些，我们如果需要从剪切板中粘贴记录过来，那么只需要简单的饿调用下即可。

1. view.PasteFromClipboard();//从剪切板中复制记录过来

复制代码

如果需要从Excel里面导入到记录表里面我们只需要读取Excel里面的记录，然后设置到当前的列表中即可。

1. var fileDialog = new OpenFileDialog();
2. fileDialog.Title = "导入xcel";
3. fileDialog.Filter = "Excel文件(*.xls)|*.xls";
4. var dialogResult = fileDialog.ShowDialog(this);
5. if (dialogResult == DialogResult.OK)
6. {
7.     ExcelImporter.ImportExcel(fileDialog.FileName, currentView);
8. }

复制代码

 
4、内置的导出Excel处理及导出PDF操作

GridView本身控件提供了ExportToXls、ExportToXlsx两个方法，可以直接把数据导出为Excel文件，可以指定常规的xls或者xlsx的格式。
如下代码所示。

1. var fileDialog = new SaveFileDialog();
2. fileDialog.Title = "导出Excel";
3. fileDialog.Filter = "Excel文件(*.xls)|*.xls";
5. var dialogResult = fileDialog.ShowDialog(this);
6. if (dialogResult == DialogResult.OK)
7. {
8.     var options = new XlsExportOptions();
9.     options.<strong>TextExportMode</strong> = TextExportMode.Text; //修改绑定数据的格式为文本
10.     view.<strong>ExportToXls</strong>(fileDialog.FileName);
11.     MessageDxUtil.ShowTips("导出Excel成功！");
13.     if (openExcel && File.Exists(fileDialog.FileName))
14.     {
15.         System.Diagnostics.Process.Start(fileDialog.FileName);
16.     }
17. }

复制代码

当然，我们也可以利用第三方控件Aspose.Cell或者NPOI、Myxls的控件进行Excel的导出操作，那样也可以提供更多通用的控制处理。
自定义格式的报表导出，可以是一个典型的图文并茂的统计报表，类似样式如下所示。

如我在随笔《使用Aspose.Cell控件实现Excel高难度报表的生成（一）》、《使用Aspose.Cell控件实现Excel高难度报表的生成（二）》、《利用Aspose.Word控件和Aspose.Cell控件，实现Word文档和Excel文档的模板化导出》中介绍过相关的处理方式，一般我们使用封装好的方法，通用的导出Excel内容即可，有时候我们直接利用分页控件进行封装，导出常规的Excel文档。

1. AsposeExcelTools.DataTableToExcel2(table, (String)e.Argument, out outError);

复制代码

导出Excel数据的效果如下所示。

 
5、打印当前GridView视图

GridView本身也提供了直接打印的操作方法，如果对一些简单的表格，可以直接使用它进行打印当前视图处理。

1. currentView.GridControl.ShowRibbonPrintPreview();

复制代码

这样的打印效果，呈现出一个Ribbon的报表预览界面，然后直接在上面进行定制打印的格式。

 或者我们也可以在生成打印预览的时候，指定更多的定制信息，如下界面所示。

1. private void menu_PrintFixColumn_Click(object sender, EventArgs e)
2. {
3.     this.winGridViewPager1.gridView1.OptionsPrint.EnableAppearanceEvenRow = true;
5.     using (PrintableComponentLink link = new PrintableComponentLink(new PrintingSystem()))
6.     {
7.         link.Component = this.winGridViewPager1.gridControl1;
8.         link.Landscape = true;
9.         link.PaperKind = System.Drawing.Printing.PaperKind.A3;
10.         link.CreateMarginalHeaderArea += new CreateAreaEventHandler(Link_CreateMarginalHeaderArea);
11.         link.CreateDocument();
12.         link.ShowPreview();
13.     }
14. }
15. private void Link_CreateMarginalHeaderArea(object sender, CreateAreaEventArgs e)
16. {
17.     string title = this.AppInfo.AppUnit + " -- " + "备件信息报表";
18.     PageInfoBrick brick = e.Graph.DrawPageInfo(PageInfo.None, title, Color.DarkBlue,
19.        new RectangleF(0, 0, 100, 21), BorderSide.None);
21.     brick.LineAlignment = BrickAlignment.Center;
22.     brick.Alignment = BrickAlignment.Center;
23.     brick.AutoWidth = true;
24.     brick.Font = new System.Drawing.Font("宋体", 11f, FontStyle.Bold);
25. }

复制代码

类似的打印预览的界面效果如下所示。

 当然我们也可以利用第三方控件的打印处理来实现更多的效果，不过内置的GridView打印操作，基本上也能满足大多数的要求了。
 
6、弹出GridView自定义菜单

 GridView的右键菜单，可以用ContextMenuStrip的常规性菜单控件来定义，我分页控件中就是采用这样的方式，设置比较简单，只需要设置GridCtrol控件的ContextMenuStrip属性即可，如下代码所示。

1. this.gridControl1.ContextMenuStrip = this.contextMenuStrip1;

复制代码

并且通过ContextMenuStrip的Opening事件，可以对它进行一定的设置禁用/可用的处理。

1. this.contextMenuStrip1.Opening += new CancelEventHandler(contextMenuStrip1_Opening);
3. private void contextMenuStrip1_Opening(object sender, CancelEventArgs e)
4. {
5.     this.menu_Add.Visible = (this.OnAddNew != null && this.ShowAddMenu);
6.     this.menu_Delete.Visible = (this.OnDeleteSelected != null && this.ShowDeleteMenu);
7.     this.menu_Edit.Visible = (this.OnEditSelected != null && this.ShowEditMenu);
8.     this.menu_Refresh.Visible = (this.OnRefresh != null);
9. }

复制代码

这样就可以对GridView的右键进行绑定及权限的设置处理，类似下面的界面效果所示。

虽然利用ContextMenuStrip的传统菜单条，可以很好、方便的实现右键菜单的处理，不过缺点是样式没有随着DevExpress本身的效果变化，如果需要追求一样的样式体验，那么可以考虑使用DevExpress的PopupMenu控件来承载菜单或者Ribbon的一些按钮操作。
 PopupMenu控件可以指定Ribbon窗体控件，然后它们右键菜单和Ribbon的按钮集合同样的出现和隐藏。

然后在设计模式下设计对应的菜单项目集合。

在界面设计好Ribbon的按钮和菜单对象的按钮后，我们可以为菜单绑定对应的GridControl事件处理，让它结合GridControl的右键事件出现右键菜单。

1. this.gridControl.MouseUp += GridControl_MouseUp;

复制代码

显示右键菜单的事件代码如下所示。

1. private void GridControl_MouseUp(object sender, MouseEventArgs e)
2. {
3.     try
4.     {
5.         if (e.Button == MouseButtons.Right)
6.         {
7.             var view = gridControl.DefaultView as GridView;
8.             var info = view.CalcHitInfo(e.Location);
9.             if (info.InRowCell)
10.             {
11.                 popupGridMenu.ShowPopup(gridControl.PointToScreen(e.Location));
12.             }
13.         }
14.     }
15.     catch (Exception ex)
16.     {
17.         MessageDxUtil.ShowError(ex.Message);
18.     }
19. }

复制代码

 
7、直接新增保存的处理

之前在随笔《在DevExpress程序中使用GridView直接录入数据的时候，增加列表选择的功能 》 、《在DevExpress程序中使用Winform分页控件直接录入数据并保存》分别介绍了两种不同方式的数据直接在GridView列表中处理的方式，本质上两者是一致的，都是利用GridView本身的一些事件进行操作，实现更加方便的数据录入体验。
我们一般通过 InitNewRow 、ValidateRow 、CellValueChanged来处理数据的录入操作，如下详细操作的界面代码所示。

1. private void RegisterEvent()
2. {
3.     var grd = this.gridControl1;
4.     var grv = this.gridView1;
5.     grv.InitGridView(GridType.NewItem, false, EditorShowMode.MouseDownFocused, "");
6.     //创建显示的列
7.     grv.CreateColumn("ItemNo", "备件编号", 120).CreateButtonEdit().ButtonClick += (s, e) =>
8.     {
9.         #region 选取备件信息，返回后赋值当前记录
10.         if (grv.GetFocusedRow() == null)
11.         {
12.             grv.AddNewRow();//一定要增加
13.         }
14.         FrmSelectItemDetail dlg = new FrmSelectItemDetail();
15.         dlg.WareHouse = this.txtWareHouse.Text;
16.         if (dlg.ShowDialog() == System.Windows.Forms.DialogResult.OK)
17.         {
18.             var info = dlg.ItemDetailInfo;
19.             if (info != null)
20.             {
21.                 grv.SetFocusedRowCellValue("ItemNo", info.ItemNo);
22.                 grv.SetFocusedRowCellValue("ItemName", info.ItemName);
23.                 grv.SetFocusedRowCellValue("ItemBigType", info.ItemBigType);
24.                 grv.SetFocusedRowCellValue("ItemType", info.ItemType);
25.                 grv.SetFocusedRowCellValue("MapNo", info.MapNo);
26.                 grv.SetFocusedRowCellValue("Specification", info.Specification);
27.                 grv.SetFocusedRowCellValue("Unit", info.Unit);
28.                 grv.SetFocusedRowCellValue("Price", info.Price);
29.                 grv.SetFocusedRowCellValue("Material", info.Material);
30.                 grv.SetFocusedRowCellValue("Source", info.Source);
31.                 grv.SetFocusedRowCellValue("StoragePos", info.StoragePos);
32.                 grv.SetFocusedRowCellValue("UsagePos", info.UsagePos);
33.                 grv.SetFocusedRowCellValue("WareHouse", info.WareHouse);
34.                 grv.SetFocusedRowCellValue("Dept", info.Dept);
35.                 grv.SetFocusedRowCellValue("Quantity", 1);//默认数量为1
36.             }
37.         }
38.         #endregion
39.     };
40.     grv.CreateColumn("ItemName", "备件名称", 120);
41.     grv.CreateColumn("Quantity", "数量").CreateSpinEdit();
42.     grv.CreateColumn("ItemBigType", "备件属类", 120);
43.     grv.CreateColumn("ItemType", "备件类别", 120);
44.     grv.CreateColumn("MapNo", "图号");
45.     grv.CreateColumn("Specification", "规格型号", 120);
46.     grv.CreateColumn("Unit", "单位");
47.     grv.CreateColumn("Price", "单价");
48.     grv.CreateColumn("Amount", "金额");
49.     grv.CreateColumn("Material", "材质", 120);
50.     grv.CreateColumn("Source", "来源", 120);
51.     grv.CreateColumn("StoragePos", "库位", 120);
52.     grv.CreateColumn("UsagePos", "使用位置", 120);
53.     grv.CreateColumn("WareHouse", "所属库房", 120);
54.     grv.CreateColumn("Dept", "所属部门", 120);
56.     //设置部分字段不可修改
57.     var readonlyFields = "ItemName,ItemBigType,ItemType,MapNo,Specification,Unit,Price,Amount,Material,Source,UsagePos,WareHouse,Dept";
58.     grv.SetColumnsReadOnly(readonlyFields);
60.     //绑定数据源，否则无法新增存储
61.     var list = new List<ItemDetailInfo>();
62.     var dt = DataTableHelper.ConvertToDataTable<ItemDetailInfo>(list);
64.     //同时增加两列在实体类属性里没有的列
65.     dt.Columns.Add(new DataColumn("Quantity", typeof(int)));
66.     dt.Columns.Add(new DataColumn("Amount", typeof(decimal)));
67.     grd.DataSource = dt;
69.     grv.InitNewRow += delegate(object sender, InitNewRowEventArgs e)
70.     {
71.         //如果是GUID的主键，可以初始化，以及赋值明细记录的父ID等操作
72.         //GridView gridView = grd.FocusedView as GridView;
73.         //gridView.SetFocusedRowCellValue("ID", Guid.NewGuid().ToString());
74.     };
75.     grv.ValidateRow += delegate(object sender, ValidateRowEventArgs e)
76.     {
77.         //校验一些不能为空的字段
78.         var result = grd.ValidateRowNull(e, new string[]
79.         {
80.             "ItemNo",
81.             "ItemName",
82.             "Quantity"
83.         });
84.     };
85.     grv.CellValueChanged += (object sender, CellValueChangedEventArgs e) =>
86.     {
87.         //根据数量计算金额
88.         if (e.Column.FieldName == "Quantity" && e.Value != null)
89.         {
90.             var Price = string.Concat(grv.GetFocusedRowCellValue("Price")).ToDecimal();
91.             var Quantity = string.Concat(e.Value).ToDecimal();
92.             grv.SetFocusedRowCellValue("Amount", Price * Quantity);
93.         }
94.     };
95.     grv.RowCellStyle += (object sender, RowCellStyleEventArgs e) =>
96.     {
97.         //设置特殊颜色标志
98.         if (e.Column.FieldName == "Quantity" )
99.         {
100.             e.Appearance.BackColor = Color.Moccasin;
101.             e.Appearance.ForeColor = Color.Red;
102.         }
103.     };   
104. }

复制代码

而如果需要结合删除的功能，那么可以增加对RowDeleted的事件处理。

1.     //行删除操作
2.     grv.OptionsBehavior.AllowDeleteRows = DefaultBoolean.True;
3.     grv.RowDeleted += (s, ee) =>
4.     {
5.         //同时移除价格列表
6.         var info = ee.Row as OrderInfo;
7.         if(info != null)
8.         {
9.             this.OrderInfos.Remove(info);
10.             for (int i = 0; i < this.gridView2.RowCount; i++)
11.             {
12.                 var code = (string)this.gridView2.GetRowCellValue(i, "产品编码");
13.                 if(info.产品编码 == code)
14.                 {
15.                     this.gridView2.DeleteRow(i);
16.                 }
17.             }
18.         }
19.     };
20.     grv.KeyDown += (s, ee) =>
21.     {
22.         if (ee.KeyCode == Keys.Delete)
23.         {
24.             gridView1.DeleteSelectedRows();
25.             ee.Handled = true;
26.         }
27.     };

复制代码

以上就是在实际项目中，常用到的GridControl和GridView的常规处理方法，用好这些控件的处理，可以极大程度的提高用户的界面体验。
当然可能还有很多常用的方法或者处理方式，等待大家的进一步挖掘和分享。

来源:https://www.cnblogs.com/wuhuacong/archive/2023/05/15/17401374.html
免责声明：由于采集信息均来自互联网，如果侵犯了您的权益，请联系我们【E-Mail:cb@itdo.tech】 我们会及时删除侵权内容，谢谢合作！