DevExpress使用教程:XtraGrid常見用法
下面匯總了DevExpress XtraGrid控件的各種常見用法,在此分享給大家:
【DXperience Universal Suite下載】
支持多種類型的數(shù)據(jù)集合作為數(shù)據(jù)源
XtraGrid與傳統(tǒng)的DataGridView一樣,支持多種類型作為其數(shù)據(jù)源。下面例子是將DataTable, List<T>和數(shù)組分別綁定到XtraGrid里面。
//定義數(shù)據(jù)源 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(); //將數(shù)組綁定到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ǒng)計(jì)運(yùn)算的功能
XtraGrid提供的統(tǒng)計(jì)運(yùn)算的功能,包括求和,求平均值,最大值,最小值,行數(shù),自定義統(tǒng)計(jì)。
做法是打開屬性編輯器,在Columns ——> Columns properties下的 SummaryItem的SummaryType選擇。
或者通過代碼設(shè)置,例如:
this.bandedGridColumn2.SummaryItem.SummaryType= DevExpress.Data.SummaryItemType.Average;
DevExpress.Data.SummaryItemType是一個(gè)枚舉,它的值有 Sum,Average,Max,Min,Count,Custom和None。
排序
只要該列的ColumnsOptions的AllowSort屬性不為False就可以根據(jù)那一列的數(shù)據(jù)進(jìn)行排序。(AllowSort屬性 在屬性編輯器的Columns的Columns Options選項(xiàng)卡。)設(shè)置Column properties下的SortOrder值。
或者通過代碼,例如:
this.bandedGridColumn2.OptionsColumn.AllowSort= DevExpress.Utils.DefaultBoolean.Default| DevExpress.Utils.DefaultBoolean.True; this.bandedGridColumn2.SortOrder= DevExpress.Data.ColumnSortOrder.Ascending
另外在程序運(yùn)行時(shí),單擊某列的列頭也可以對(duì)該列進(jìn)行排序。
分組
GridView view = gridControl1.MainView as GridView; [] sortInfo = { new GridColumnSortInfo(view.Columns["Chinese"], ColumnSortOrder.Ascending) }; view.SortInfo.(sortInfo, 2);
GridColumnSortInfo 數(shù)組存放的是分組的列的信息,調(diào)用ClearAndAddRange清除結(jié)果并進(jìn)行分組。
篩選
只要該列的Filter Options選項(xiàng)卡的AllowFilter屬性不為False就可以進(jìn)行篩選。
該屬性通過代碼設(shè)置是
this.bandedGridColumn2.OptionsFilter.AllowFilter = false;
運(yùn)行程序后,鼠標(biāo)指針移動(dòng)到列標(biāo)題,單擊漏斗狀圖形經(jīng)行篩選操作。
分頁欄
XtraGrid提供分頁欄。通過這個(gè)設(shè)置可以顯示出來。
gridControl1.UseEmbeddedNavigator = true;
如果要根據(jù)滾動(dòng)條滾動(dòng)實(shí)現(xiàn)翻頁功能的,那得依靠Scroll事件。它又沒像DataGridView那樣開放滾動(dòng)條事件,不過里面有一個(gè)事件可以替代Scroll事件,那就是TopRowChanged,例子如下:
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 }); } }
如果硬要獲取滾動(dòng)條對(duì)象來設(shè)置,則可以用下面這段代碼獲取gridView的滾動(dòng)條。
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;
父子表
當(dāng)綁定的 數(shù)據(jù)源中的子項(xiàng)再存在集合時(shí),XtraGrid會(huì)自動(dòng)啟用子表。例如上面的在Person類里多添加一個(gè)成員 List<Person> Friends{get;set;}表示那個(gè)人的朋友圈子,在任意一個(gè)實(shí)例中把Person實(shí)例添加進(jìn)去,再啟動(dòng)程序時(shí),就會(huì)發(fā)現(xiàn)父子表的效果實(shí)現(xiàn)了。
若要對(duì)子表的進(jìn)行設(shè)置,可以給MainView添加MasterRowExpanded事件,例如:
private void gridView1_MasterRowExpanded(object sender, CustomMasterRowEventArgs e) { //獲取子表 AdvBandedGridView gv = (AdvBandedGridView)gridView1.GetDetailView(e.RowHandle, e.RelationIndex); //第一個(gè)參數(shù)是行號(hào),第二個(gè)參數(shù)是父子表關(guān)聯(lián)索引 if (gv != null) { //對(duì)子表設(shè)置 } }
Get/Set 單元格的值
通過調(diào)用GetRowCellValue獲取單元格的值。
public override object GetRowCellValue( int rowHandle, GridColumn column );
rowHandle是行的索引,column列的對(duì)象。
通過調(diào)用SetRowCellValue設(shè)置單元格的值
public void SetRowCellValue( int rowHandle, GridColumn column, object _value );
rowHandle是行的索引,column列的對(duì)象。_value是單元格新的值。
以peopleList為例
int englishS=Convert.ToDouble(0,gridView1.Columns["English"])+60; SetRowCellValue(0,gridView1.Columns["English"],englishS);
在XtraGrid有另一種方式,就是直接設(shè)置數(shù)據(jù)源的值。對(duì)于上面這個(gè)例子,直接找到grid里第一行數(shù)據(jù)對(duì)應(yīng)的Person對(duì)象,設(shè)置它的English值。
數(shù)據(jù)驗(yàn)證
有兩種方法來實(shí)現(xiàn)基于單元格的驗(yàn)證:
1、使用RepositoryItem.Validating事件
事件的"sender" 必須轉(zhuǎn)換為BaseEdit類型,使用EditValue來獲取當(dāng)前輸入的值并進(jìn)行校驗(yàn),如果校驗(yàn)不通過,把e.Cancel設(shè)置True。這種方法一般用來對(duì)內(nèi)置控件的單元格進(jìn)行數(shù)據(jù)驗(yàn)證。
2、使用 GridView.ValidatingEditor 事件
事件的"sender"必須轉(zhuǎn)換為GridView類型,當(dāng)前列可以從GridView.FocusedColumn屬性獲得,值可以從e.Value獲取,如果校驗(yàn)不通過,需要把e.Valid設(shè)置為False。
這種方法一般用于對(duì)整個(gè)Grid內(nèi)的文本框進(jìn)行數(shù)據(jù)驗(yàn)證
在設(shè)置完事件之后需要寫一個(gè)GridView.InvalidValueException 的事件委托,如
private void gridView1_InvalidValueException(object sender, DevExpress.XtraGrid.Views.Base.InvalidValueExceptionEventArgs e) { e.ThrowException = false; e.WindowText = "驗(yàn)證通過"; e.DisplayError = true; }
表格數(shù)據(jù)與數(shù)據(jù)源的數(shù)據(jù)同步
XtraGrid與DataGridView在數(shù)據(jù)源方面不同的是,對(duì)grid里的數(shù)據(jù)進(jìn)行任何改動(dòng)(增、刪、改)之后,原本的數(shù)據(jù)源也相應(yīng)的改動(dòng)。通過下面例子可以得出此結(jié)論,在窗體添加刪,改兩個(gè)按鈕并綁定下面相應(yīng)的事件。
/// <summary> /// 更改 /// </summary> /// <param name="sender"></param> /// <param name="e"></param> private void btEdit_Click(object sender, EventArgs e) { Person p = (Person)gridView1.GetRow(gridView1.FocusedRowHandle); } /// <summary> /// 刪除 /// </summary> /// <param name="sender"></param> /// <param name="e"></param> private void btDelete_Click(object sender, EventArgs e) {if (gridView1.SelectedRowsCount != 0) gridView1.DeleteSelectedRows(); MessageBox.Show(people.Count.ToString()); }
只要對(duì)grid的數(shù)據(jù)經(jīng)過改動(dòng)之后,單擊相應(yīng)的按鈕就可以查看數(shù)據(jù)源的信息。
數(shù)據(jù)導(dǎo)入導(dǎo)出
XtraGrid 支持Html、Xml、Txt、Xsl導(dǎo)出,對(duì)應(yīng)的導(dǎo)出器是ExportHtmlProvider、ExportXmlProvider、 ExportTxtProvider、ExportXslProvider。都在命名空間DevExpress.XtraExport里面。
這里封裝了一個(gè)數(shù)據(jù)導(dǎo)出的方法,可以導(dǎo)出上述列舉的類型,只需要傳入相應(yīng)類型的provider就可以了。
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; }
調(diào)用時(shí)只需要?jiǎng)?chuàng)建一個(gè)相應(yīng)的provider。
IExportProvider provider = new ExportXlsProvider(FullFileName); //這里可以是ExportHtmlProvider、ExportXmlProvider、ExportTxtProvider ExportTo(provider);
導(dǎo)入數(shù)據(jù)只嘗試了導(dǎo)入Excel的導(dǎo)入,利用ODBC讀取Excel的數(shù)據(jù)到DataTable中,再把DataTable綁定到XtraGrid中。
這里也是封裝了一個(gè)讀取Excel數(shù)據(jù)的方法。
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的架構(gòu),包括各個(gè)sheet表的名稱,類型,創(chuàng)建時(shí)間和修改時(shí)間等 DataTable dtSheetName = conn.GetOleDbSchemaTable(OleDbSchemaGuid.Tables, new object[] { null, null, null, "Table" }); //包含excel中表名的字符串?dāng)?shù)組 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(); //從指定的表明查詢數(shù)據(jù),可先把所有表明列出來供用戶選擇 string strExcel = "select * from[" + strTableNames[0] + "]"; da = new OleDbDataAdapter(strExcel, conn); da.Fill(ds); return ds; }
以這樣方式調(diào)用。
DataSet ds = GetDataFromExcelWithAppointSheetName(FullFileName);
設(shè)置條帶狀的列
在選擇視圖時(shí),選擇BandedGridView和AdvBandedGridView都是支持設(shè)置條帶狀的列。在屬性編輯器的Bands處可以對(duì)條帶進(jìn)行管理,直接拖動(dòng)列標(biāo)題可以設(shè)置該列屬于哪個(gè)條帶。通過Bands屬性可以對(duì)各個(gè)條帶進(jìn)行管理。
編輯器
XtraGrid提供了多種編輯器。這些能夠在Grid/CardView/BandedView中使用。在屬性編輯器中的In-place Editor Repository可以對(duì)編輯器進(jìn)行管理。在Columns的ColumnEdit中選擇該列使用哪個(gè)編輯器。
也可以通過代碼實(shí)現(xiàn):
RepositoryItemComboBox repositoryItemComboBox_abc=new RepositoryItemComboBox(); // // 對(duì)編輯器進(jìn)行設(shè)置 // this.gridColumn1.ColumnEdit = repositoryItemComboBox_abc; //在需要的列里使用定義好的編輯器
單元格編輯
這個(gè)效果發(fā)現(xiàn)只使用與gridView這種視圖,同樣通過上,下,左,右四個(gè)方向的導(dǎo)航鍵控制光標(biāo)移動(dòng),按回車進(jìn)入編輯狀態(tài),按Esc鍵不保存更改內(nèi)容,按回車保存更改內(nèi)容。
this.gridView1.OptionsSelection.MultiSelect = true; this.gridView1.OptionsSelection.MultiSelectMode = DevExpress.XtraGrid.Views.Grid.GridMultiSelectMode.CellSelect; this.gridView1.OptionsSelection.UseIndicatorForSelection = false;
列拖動(dòng)
只 要是在列屬性里把AllowMove設(shè)置了True(它的默認(rèn)值本身是True),在程序運(yùn)行時(shí),用戶都可以拖動(dòng)列標(biāo)題來改變列的位置。該屬性可以通過屬 性編輯器設(shè)置,在Columns-->Columns Options選項(xiàng)卡下的AllowMove。也可以通過代碼設(shè)置,如:
gridView1.Columns[0].OptionsColumn.AllowMove = true;
XtraGrid滾輪翻頁
滾輪翻頁與傳動(dòng)的翻頁更為方便,經(jīng)過本人一番探討與琢磨終于在XtraGrid的GridView中實(shí)現(xiàn)了鼠標(biāo)滾輪翻頁。
我新建了一個(gè)組件繼承原本的GridControl,在組件中添加了一個(gè)ImageList,專門存放一些資源圖片。用于實(shí)現(xiàn)動(dòng)態(tài)圖的效果。
添加一個(gè)自定義委托的參數(shù)與枚舉,委托參數(shù)用于傳遞分頁的信息。
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 }
在組件的類里面添加以下字段
/// <summary> /// 頁面大小 /// </summary> private int _int_page_size=20; /// <summary> /// 當(dāng)前頁索引 /// </summary> private int _int_page_index=1; /// <summary> /// 總記錄數(shù) /// </summary> private int _int_record_count; /// <summary> /// 讀取狀態(tài) /// </summary> private LoadState _LodaState_state;
添加以下屬性
/// <summary> /// 總記錄數(shù) /// </summary> public int RecordCount { get { if (!IsPaging) return 0; return _int_record_count; } set { if (!IsPaging) return ; _int_record_count = value; //當(dāng)設(shè)置了新的記錄總數(shù),自動(dòng)讀取第一頁的內(nèi)容 if(value>0) gridView_TopRowChanged(this, new EventArgs()); else { while (this.MainView.DataRowCount > 0) GridView_main_view.DeleteRow(0); this.RefreshDataSource(); } } } /// <summary> /// 每次讀取的行數(shù) /// </summary> public int PageSize { get { if (!IsPaging) return 0; return _int_page_size; } set { if (!IsPaging) return ; _int_page_size = value; } } /// <summary> /// 總頁數(shù) /// </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; }
添加以下委托與事件
/// <summary> /// 內(nèi)部使用的委托 /// </summary> private delegate void myDelegate(); /// <summary> /// 滾動(dòng)翻頁的委托 /// </summary> /// <param name="sender"></param> /// <param name="e"></param> public delegate void ScrollingToPageEventHandler(object sender, PagingEventArgs e); /// <summary> /// 滾動(dòng)翻頁的事件 /// </summary> public event ScrollingToPageEventHandler OnScrollingToPage;
以下則是一些對(duì)控件的設(shè)置,按照各人喜好可以有所更改。
/// <summary> /// 設(shè)置分頁欄 /// </summary> private void InitEmbeddedNavigator() {this.EmbeddedNavigator.CustomButtons.AddRange(new DevExpress.XtraEditors.NavigatorCustomButton[] { new DevExpress.XtraEditors.NavigatorCustomButton(-1, -1, true, false, "", null)}); this.EmbeddedNavigator.TextStringFormat = " 當(dāng)前 {1} 行數(shù)據(jù) "; this.UseEmbeddedNavigator = true; } /// <summary> /// 設(shè)置gridView /// </summary> private void InitGridView() { _GridView_main_view.TopRowChanged += new EventHandler(gridView_TopRowChanged); }
為控件的事件注冊(cè)以下方法
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; } //檢查是否到達(dá)底部 if (_GridView_main_view.IsRowVisible(_GridView_main_view.RowCount - 1) == RowVisibleState.Visible|| _int_page_index==1) { lock (this)//設(shè)置成開始讀取狀態(tài) { _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的首行改變了就會(huì)觸發(fā),類似于滾動(dòng)條的Scroll事件。這里開了兩個(gè)線程,第一個(gè)線程用于讀取數(shù)據(jù),第二個(gè)線程用于實(shí)現(xiàn)動(dòng)態(tài)圖。兩個(gè)線程調(diào)用的方法都在下面。
/// <summary> /// 讀取數(shù)據(jù) /// </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; //執(zhí)行事件 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的數(shù)據(jù) 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;//設(shè)置成讀取完成狀態(tài) } } /// <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)//循環(huán)更替圖片實(shí)現(xiàn)動(dòng)態(tài)圖效果 { lock (this) { if (_LodaState_state != LoadState.Loading)//判定數(shù)據(jù)是否完成 break; } Thread.Sleep(120); if (image_index == 3) image_index = 0; else image_index++; if (this.Parent.InvokeRequired) { //輪流更換圖片實(shí)現(xiàn)gif動(dòng)態(tài)圖 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++; } }
不過這個(gè)代碼有點(diǎn)問題,當(dāng)GridControl綁定的數(shù)據(jù)源有相同實(shí)例的子項(xiàng)時(shí),隨著RefreshData方法的調(diào)用會(huì)不停觸發(fā) TopRowChanged事件,確切的原因還沒搞清楚,解決這個(gè)問題就是要不去除數(shù)據(jù)源上相同的實(shí)例子項(xiàng),要不就不調(diào)用RefreshData方法。還 有更好的辦法還請(qǐng)高手們的指點(diǎn)。
出處:博客園武勝-阿偉