DevExpress使用教程：XtraGrid常见用法

支持多种类型的数据集合作为数据源

XtraGrid与传统的DataGridView一样,支持多种类型作为其数据源。下面例子是将DataTable, List和数组分别绑定到XtraGrid里面。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48

//定义数据源 List<person> peopleList=new List<person> {     { ID = 1, FirstName = "Magnus", LastName = "Hedlund", Sex = true, Birth = new DateTime(1999, 9, 9), Chinese = 60, English = 80, Math = 79 },     { ID = 2, FirstName = "Terry", LastName = "Adams", Sex = false, Birth = new DateTime(1999, 9, 9), Chinese = 60, English = 80, Math = 79 },     { ID = 3, FirstName = "Charlotte", LastName = "Weiss", Sex = false, Birth = new DateTime() },     { ID = 4, FirstName = "Arlene", LastName = "Huff", Sex = true, Birth = new DateTime(1999, 9, 9), Chinese = 60, English = 80, Math = 79 },     { ID = 5, FirstName = "FirstName1", LastName = "LastName1", Sex = true, Birth = new DateTime(1999, 9, 9), Chinese=60, English=80, Math=79 },  　　{ ID = 6, FirstName = "FirstName2", LastName = "LastName2", Sex = true, Birth = new DateTime(1999, 9, 19), Chinese = 60, English = 80, Math = 79 }, 　　 { ID = 7, FirstName = "FirstName3", LastName = "LastName3", Sex = true, Birth = new DateTime(1999, 9, 29) }, 　　 { ID = 8, FirstName = "FirstName4", LastName = "LastName4", Sex = true, Birth = new DateTime(1999, 2, 9), Chinese = 60, English = 80, Math = 79 }, 　　 { ID = 9, FirstName = "FirstName5", LastName = "LastName5", Sex = true, Birth = new DateTime(1999, 4, 9) } }; //将list<t>绑定到grid中 gridControl1.DataSource = peopleList;       People[] peopleArray=peopleList.ToArray(); //将数组绑定到grid中 gridControl1.DataSource = peopleArray;   DataTable peopleTable=new DataTable();    peopleTable.Columns.Add("FirstName"); peopleTable.Columns.Add("LastName"); peopleTable.Columns.Add("Sex"); peopleTable.Columns.Add("Birth"); peopleTable.Columns.Add("Chinese"); peopleTable.Columns.Add("English"); peopleTable.Columns.Add("Math"); peopleTable.Columns.Add("ID");    foreach (Person pi in people) {     DataRow row = peopleTable.Rows.Add();     row["FirstName"] = pi.FirstName;     row["LastName"] = pi.LastName;     row["Sex"] = pi.Sex;     row["Birth"] = pi.Birth;     row["Chinese"] = pi.Chinese;     row["English"] = pi.English;     row["Math"] = pi.Math;     row["ID"]=pi.ID; }    //将DataTable绑定到grid中 gridControl1.DataSource = peopleTable;</t></person></person>

统计运算的功能

XtraGrid提供的统计运算的功能，包括求和，求平均值，最大值，最小值，行数，自定义统计。

做法是打开属性编辑器，在Columns ——> Columns properties下的 SummaryItem的SummaryType选择。

或者通过代码设置,例如：

1	this.bandedGridColumn2.SummaryItem.SummaryType= DevExpress.Data.SummaryItemType.Average;

DevExpress.Data.SummaryItemType是一个枚举，它的值有 Sum,Average,Max,Min,Count,Custom和None。

排序

只要该列的ColumnsOptions的AllowSort属性不为False就可以根据那一列的数据进行排序。（AllowSort属性 在属性编辑器的Columns的Columns Options选项卡。）设置Column properties下的SortOrder值。

或者通过代码，例如：

1 2 3

this.bandedGridColumn2.OptionsColumn.AllowSort=  DevExpress.Utils.DefaultBoolean.Default| DevExpress.Utils.DefaultBoolean.True;   this.bandedGridColumn2.SortOrder= DevExpress.Data.ColumnSortOrder.Ascending

另外在程序运行时，单击某列的列头也可以对该列进行排序。

分组

1 2 3 4 5

GridView view = gridControl1.MainView as GridView; [] sortInfo = {         new GridColumnSortInfo(view.Columns["Chinese"], ColumnSortOrder.Ascending)       }; view.SortInfo.(sortInfo, 2);

GridColumnSortInfo 数组存放的是分组的列的信息，调用ClearAndAddRange清除结果并进行分组。

筛选

只要该列的Filter Options选项卡的AllowFilter属性不为False就可以进行筛选。

该属性通过代码设置是

1	this.bandedGridColumn2.OptionsFilter.AllowFilter = false;

运行程序后，鼠标指针移动到列标题，单击漏斗状图形经行筛选操作。

分页栏

XtraGrid提供分页栏。通过这个设置可以显示出来。

1	gridControl1.UseEmbeddedNavigator = true;

如果要根据滚动条滚动实现翻页功能的，那得依靠Scroll事件。它又没像DataGridView那样开放滚动条事件，不过里面有一个事件可以替代Scroll事件，那就是TopRowChanged，例子如下：

1 2 3 4 5 6 7 8

private void gridView1_TopRowChanged(object sender, EventArgs e)         {               if (gridView1.IsRowVisible(gridView1.RowCount - 1) == RowVisibleState.Visible) //如果滚到了底端             {                 people.AddRange(new Person[] { Person1, Person2, Person3, Person4, Person5 });             }         }

如果硬要获取滚动条对象来设置，则可以用下面这段代码获取gridView的滚动条。

1 2 3 4 5 6 7 8 9

Type type = gridView1.GetType();               FieldInfo fi = type.GetField("fViewInfo", BindingFlags.NonPublic | BindingFlags.Instance);               GridViewInfo info = gridView1.GetViewInfo() as GridViewInfo;               fi = type.GetField("scrollInfo", BindingFlags.NonPublic | BindingFlags.Instance);               ScrollInfo scrollInfo = fi.GetValue(gridView1) as ScrollInfo;

父子表

当绑定的 数据源中的子项再存在集合时，XtraGrid会自动启用子表。例如上面的在Person类里多添加一个成员 List Friends{get;set;}表示那个人的朋友圈子，在任意一个实例中把Person实例添加进去，再启动程序时，就会发现父子表的效果实现了。

若要对子表的进行设置，可以给MainView添加MasterRowExpanded事件，例如：

1 2 3 4 5 6 7 8 9 10 11

private void gridView1_MasterRowExpanded(object sender, CustomMasterRowEventArgs e)         {             //获取子表             AdvBandedGridView gv = (AdvBandedGridView)gridView1.GetDetailView(e.RowHandle, e.RelationIndex);             //第一个参数是行号，第二个参数是父子表关联索引                           if (gv != null)             {                 //对子表设置             }         }

Get/Set 单元格的值

通过调用GetRowCellValue获取单元格的值。

1 2 3 4

public override object GetRowCellValue(    int rowHandle,     GridColumn column );

rowHandle是行的索引，column列的对象。

通过调用SetRowCellValue设置单元格的值

1 2 3 4 5

public void SetRowCellValue(    int rowHandle,     GridColumn column,     object _value );

rowHandle是行的索引，column列的对象。_value是单元格新的值。

以peopleList为例

1 2	int englishS=Convert.ToDouble(0,gridView1.Columns["English"])+60; SetRowCellValue(0,gridView1.Columns["English"],englishS);

在XtraGrid有另一种方式，就是直接设置数据源的值。对于上面这个例子，直接找到grid里第一行数据对应的Person对象，设置它的English值。

数据验证

有两种方法来实现基于单元格的验证：

1、使用RepositoryItem.Validating事件

事件的"sender" 必须转换为BaseEdit类型，使用EditValue来获取当前输入的值并进行校验，如果校验不通过，把e.Cancel设置True。这种方法一般用来对内置控件的单元格进行数据验证。

2、使用 GridView.ValidatingEditor 事件

事件的"sender"必须转换为GridView类型，当前列可以从GridView.FocusedColumn属性获得，值可以从e.Value获取，如果校验不通过，需要把e.Valid设置为False。
这种方法一般用于对整个Grid内的文本框进行数据验证

在设置完事件之后需要写一个GridView.InvalidValueException 的事件委托，如

1 2 3 4 5

private void gridView1_InvalidValueException(object sender, DevExpress.XtraGrid.Views.Base.InvalidValueExceptionEventArgs e) {   e.ThrowException = false;   e.WindowText = "验证通过";   e.DisplayError = true; }

表格数据与数据源的数据同步

XtraGrid与DataGridView在数据源方面不同的是，对grid里的数据进行任何改动(增、删、改)之后，原本的数据源也相应的改动。通过下面例子可以得出此结论，在窗体添加删，改两个按钮并绑定下面相应的事件。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

/// <summary>         /// 更改         /// </summary>         /// <param name="sender">         /// <param name="e">         private void btEdit_Click(object sender, EventArgs e)         {             Person p = (Person)gridView1.GetRow(gridView1.FocusedRowHandle);         }           /// <summary>         /// 删除         /// </summary>         /// <param name="sender">         /// <param name="e">         private void btDelete_Click(object sender, EventArgs e)         {if (gridView1.SelectedRowsCount != 0)                 gridView1.DeleteSelectedRows();             MessageBox.Show(people.Count.ToString());         }

只要对grid的数据经过改动之后，单击相应的按钮就可以查看数据源的信息。

数据导入导出

XtraGrid 支持Html、Xml、Txt、Xsl导出，对应的导出器是ExportHtmlProvider、ExportXmlProvider、 ExportTxtProvider、ExportXslProvider。都在命名空间DevExpress.XtraExport里面。

这里封装了一个数据导出的方法，可以导出上述列举的类型，只需要传入相应类型的provider就可以了。

1 2 3 4 5 6 7 8 9 10 11 12 13

private void ExportTo(IExportProvider provider)         {             Cursor currentCursor = Cursor.Current;             Cursor.Current = Cursors.WaitCursor;               this.FindForm().Refresh();             BaseExportLink link = gridView1.CreateExportLink(provider);             (link as GridViewExportLink).ExpandAll = false;             link.ExportTo(true);             provider.Dispose();               Cursor.Current = currentCursor;         }

调用时只需要创建一个相应的provider。

1 2	IExportProvider provider = new ExportXlsProvider(FullFileName); //这里可以是ExportHtmlProvider、ExportXmlProvider、ExportTxtProvider ExportTo(provider);

导入数据只尝试了导入Excel的导入，利用ODBC读取Excel的数据到DataTable中，再把DataTable绑定到XtraGrid中。

这里也是封装了一个读取Excel数据的方法。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24

private DataSet GetDataFromExcelWithAppointSheetName(string Path)         {             String strConn = "Provider=Microsoft.Jet.OLEDB.4.0;" +                      "Data Source=" + Path + ";" +                      "Extended Properties=Excel 8.0;";             OleDbConnection conn = new OleDbConnection(strConn);             conn.Open();             //返回Excel的架构，包括各个sheet表的名称,类型，创建时间和修改时间等　             DataTable dtSheetName = conn.GetOleDbSchemaTable(OleDbSchemaGuid.Tables, new object[] { null, null, null, "Table" });             //包含excel中表名的字符串数组             string[] strTableNames = new string[dtSheetName.Rows.Count];             for (int k = 0; k < dtSheetName.Rows.Count; k++)             {                 strTableNames[k] = dtSheetName.Rows[k]["TABLE_NAME"].ToString();             }             OleDbDataAdapter da = null;             DataSet ds = new DataSet();             //从指定的表明查询数据,可先把所有表明列出来供用户选择             string strExcel = "select * from[" + strTableNames[0] + "]";             da = new OleDbDataAdapter(strExcel, conn);             da.Fill(ds);               return ds;         }

以这样方式调用。

1	DataSet ds = GetDataFromExcelWithAppointSheetName(FullFileName);

设置条带状的列

在选择视图时，选择BandedGridView和AdvBandedGridView都是支持设置条带状的列。在属性编辑器的Bands处可以对条带进行管理，直接拖动列标题可以设置该列属于哪个条带。通过Bands属性可以对各个条带进行管理。

编辑器

XtraGrid提供了多种编辑器。这些能够在Grid/CardView/BandedView中使用。在属性编辑器中的In-place Editor Repository可以对编辑器进行管理。在Columns的ColumnEdit中选择该列使用哪个编辑器。

也可以通过代码实现：

1 2 3 4 5 6

RepositoryItemComboBox repositoryItemComboBox_abc=new RepositoryItemComboBox();             //             // 对编辑器进行设置             //               this.gridColumn1.ColumnEdit = repositoryItemComboBox_abc;  //在需要的列里使用定义好的编辑器

单元格编辑

这个效果发现只使用与gridView这种视图，同样通过上，下，左，右四个方向的导航键控制光标移动，按回车进入编辑状态，按Esc键不保存更改内容，按回车保存更改内容。

1 2 3

this.gridView1.OptionsSelection.MultiSelect = true;             this.gridView1.OptionsSelection.MultiSelectMode = DevExpress.XtraGrid.Views.Grid.GridMultiSelectMode.CellSelect;             this.gridView1.OptionsSelection.UseIndicatorForSelection = false;

列拖动

只 要是在列属性里把AllowMove设置了True（它的默认值本身是True）,在程序运行时，用户都可以拖动列标题来改变列的位置。该属性可以通过属 性编辑器设置，在Columns-->Columns Options选项卡下的AllowMove。也可以通过代码设置，如：

1	gridView1.Columns[0].OptionsColumn.AllowMove = true;

XtraGrid滚轮翻页

滚轮翻页与传动的翻页更为方便，经过本人一番探讨与琢磨终于在XtraGrid的GridView中实现了鼠标滚轮翻页。

我新建了一个组件继承原本的GridControl，在组件中添加了一个ImageList,专门存放一些资源图片。用于实现动态图的效果。

添加一个自定义委托的参数与枚举，委托参数用于传递分页的信息。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23

public class PagingEventArgs : EventArgs     {         public int PageSize { get; set; }         public int PageIndex { get; set; }     }       public enum LoadState     {         /// <summary>         /// 就绪         /// </summary>         Ready,           /// <summary>         /// 正在读取         /// </summary>         Loading,           /// <summary>         /// 读取完成         /// </summary>         Finish     }

在组件的类里面添加以下字段

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

/// <summary>         /// 页面大小         /// </summary>         private int _int_page_size=20;           /// <summary>         /// 当前页索引         /// </summary>         private int _int_page_index=1;           /// <summary>         /// 总记录数         /// </summary>         private int _int_record_count;           /// <summary>         /// 读取状态         /// </summary>         private LoadState _LodaState_state;

添加以下属性

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69

/// <summary>         /// 总记录数         /// </summary>         public int RecordCount         {             get             {                 if (!IsPaging) return 0;                 return _int_record_count;             }             set             {                 if (!IsPaging) return ;                 _int_record_count = value;                 //当设置了新的记录总数，自动读取第一页的内容                 if(value>0)                     gridView_TopRowChanged(this, new EventArgs());    　　　　　　　　　　else                 　　　　　　　　　　{                     　　　　　　　　　　　　　　while (this.MainView.DataRowCount > 0)                         　　　　　　　　　　　　　　　　GridView_main_view.DeleteRow(0);                     　　　　　　　　　　　　　　this.RefreshDataSource();                 　　　　　　　　　　}             }         }           /// <summary>         /// 每次读取的行数         /// </summary>         public int PageSize         {             get             {                 if (!IsPaging) return 0;                 return _int_page_size;             }             set             {                 if (!IsPaging) return ;                 _int_page_size = value;             }         }           /// <summary>         /// 总页数         /// </summary>         private int PageCount         {             get             {                 if (RecordCount % PageSize == 0)                     return RecordCount / PageSize;                 return RecordCount / PageSize + 1;             }         }           /// <summary>         /// Grid         /// </summary>         private GridView _GridView_main_view         {             get { return (GridView)this.MainView; }         }           /// <summary>         /// 是否启用分页         /// </summary>         public bool IsPaging { get; set; }

添加以下委托与事件

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16

/// <summary>         /// 内部使用的委托         /// </summary>         private delegate void myDelegate();           /// <summary>         /// 滚动翻页的委托         /// </summary>         /// <param name="sender">         /// <param name="e">         public delegate void ScrollingToPageEventHandler(object sender, PagingEventArgs e);           /// <summary>         /// 滚动翻页的事件         /// </summary>         public event ScrollingToPageEventHandler OnScrollingToPage;

以下则是一些对控件的设置，按照各人喜好可以有所更改。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

/// <summary>         /// 设置分页栏         /// </summary>         private void InitEmbeddedNavigator()         {this.EmbeddedNavigator.CustomButtons.AddRange(new DevExpress.XtraEditors.NavigatorCustomButton[] {             new DevExpress.XtraEditors.NavigatorCustomButton(-1, -1, true, false, "", null)});             this.EmbeddedNavigator.TextStringFormat = "  当前 {1} 行数据  ";             this.UseEmbeddedNavigator = true;           }           /// <summary>         /// 设置gridView         /// </summary>         private void InitGridView()         {             _GridView_main_view.TopRowChanged += new EventHandler(gridView_TopRowChanged);         }

为控件的事件注册以下方法

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34

private void gridControl_Load(object sender, EventArgs e)         {             if (IsPaging)             {                 _LodaState_state = LoadState.Ready;                   InitEmbeddedNavigator();                 InitGridView();             }         }           private void gridView_TopRowChanged(object sender, EventArgs e)         {               lock (this)             {                 if ( _int_page_index > PageCount || _LodaState_state != LoadState.Ready) return;             }               //检查是否到达底部             if (_GridView_main_view.IsRowVisible(_GridView_main_view.RowCount - 1) == RowVisibleState.Visible||                 _int_page_index==1)             {                   lock (this)//设置成开始读取状态                 {                     _LodaState_state = LoadState.Loading;                 }                 Thread thread_load_data = new Thread(new ThreadStart(LoadData));                 Thread thread_change_text = new Thread(new ThreadStart(ChangeLoadingImage));                 thread_change_text.Start();                 thread_load_data.Start();             }         }

TopRowChanged事件在grid的首行改变了就会触发，类似于滚动条的Scroll事件。这里开了两个线程，第一个线程用于读取数据，第二个线程用于实现动态图。两个线程调用的方法都在下面。

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97

/// <summary>         /// 读取数据         /// </summary>         private void LoadData()         {             int top_row_index = 0;             int focus_index = 0;             lock (this)             {                 top_row_index = _GridView_main_view.TopRowIndex;                 focus_index = _GridView_main_view.FocusedRowHandle;                   //执行事件                 if (OnScrollingToPage == null)                     throw new Exception("OnScrollingToPage can not be null");                   PagingEventArgs e = new PagingEventArgs();                 e.PageIndex = this._int_page_index;                 e.PageSize = this._int_page_size;                 OnScrollingToPage(this,e);                               }               //刷新grid的数据             if (this.Parent.InvokeRequired)             {                 this.Parent.Invoke(new myDelegate(delegate                 {                     _GridView_main_view.TopRowIndex = top_row_index;                     _GridView_main_view.FocusedRowHandle = focus_index; 　　　　　　　　　　　_GridView_main_view.RefreshData();                   }));               }             lock (this)             {                 _LodaState_state = LoadState.Finish;//设置成读取完成状态             }         }           /// <summary>         /// 更替图片         /// </summary>         private void ChangeLoadingImage()         {               int image_index = 0;               if (this.Parent.InvokeRequired)//显示loading的gif             {                 this.Parent.Invoke(new myDelegate(delegate                 {                     this.EmbeddedNavigator.Buttons.CustomButtons[0].Visible = true;                 }));             }             while (true)//循环更替图片实现动态图效果             {                 lock (this)                 {                     if (_LodaState_state != LoadState.Loading)//判定数据是否完成                         break;                 }                   Thread.Sleep(120);                   if (image_index == 3)                     image_index = 0;                 else                     image_index++;                 if (this.Parent.InvokeRequired)                 {                     //轮流更换图片实现gif动态图                     this.Parent.Invoke(new myDelegate(delegate                     {                         this.EmbeddedNavigator.Buttons.CustomButtons[0].ImageIndex = image_index;                     }));                 }             }               if (this.Parent.InvokeRequired)//隐藏loading的gif             {                 this.Parent.Invoke(new myDelegate(delegate                 {                     this.EmbeddedNavigator.Buttons.CustomButtons[0].Visible = false;                 }));             }                   lock (this)             {                 _LodaState_state = 0;                 _int_page_index++;             }           }

不过这个代码有点问题，当GridControl绑定的数据源有相同实例的子项时，随着RefreshData方法的调用会不停触发 TopRowChanged事件，确切的原因还没搞清楚，解决这个问题就是要不去除数据源上相同的实例子项，要不就不调用RefreshData方法。还 有更好的办法还请高手们的指点。

出处：博客园武胜-阿伟