Xin chào các bạn bài viết hôm nay mình sẽ share các bạn class GridViewRefreshHelper dùng để lưu và tải lại trạng thái của Gridview Devexpress C#.

[DEVEXPRESS] Save Gridview State Winform C#

Khi các bạn thêm mới dữ liệu vào hoặc trong dữ liệu gridview có cập nhật nội dung, khi các bạn Refresh Data lại thì thanh cuộn nó luôn chạy về focus ngay dòng đầu tiên.

Như hình ảnh demo của mình dưới đây:

Ở hình trên các bạn thấy khi mình bấm nút nạp lại thì nó sẽ luôn chạy về lại vị trí ban đầu.

Và mong muốn của mình ở bài viết này là sẽ lưu lại trạng thái của GridView, khi chúng ta bấm lại nút Refresh Data.

Như ở hình dưới đây, mình có một data gồm 10.000 record, khi mình kéo dữ liệu và thay đổi nội dung load thêm record thì rowhandle của nó vẫn không thay đổi như hình bên dưới.

Đầu tiên, các bạn tạo cho mình một class với tên RefreshHelperClass.cs (class này được viết bởi kỹ sư DevExpress, không phải mình viết nhé.)

using System;
using System.Collections;
using DevExpress.XtraGrid;
using DevExpress.Utils;
using DevExpress.XtraGrid.Columns;
using DevExpress.XtraGrid.Views.Grid;

namespace DevExpress.XtraGrid.Helpers {
	public class RefreshHelper {
		[Serializable]
		public struct RowInfo{
			public object Id;
			public int level;
		};

		private GridView view;
		private string keyFieldName;
		private ArrayList saveExpList;
		private ArrayList saveSelList;
		private ArrayList saveMasterRowsList;
		private int visibleRowIndex = -1;

		public RefreshHelper(GridView view, string keyFieldName) {
			this.view = view;
			this.keyFieldName = keyFieldName;
		}

		public ArrayList SaveExpList{
			get { 
				if(saveExpList == null)
					saveExpList = new ArrayList();
				return saveExpList;
			}
		}

		public ArrayList SaveSelList{
			get { 
				if(saveSelList == null)
					saveSelList = new ArrayList();
				return saveSelList;
			}
		}

		public ArrayList SaveMasterRowsList{
			get{
				if(saveMasterRowsList == null)
					saveMasterRowsList = new ArrayList();
				return saveMasterRowsList;
			}
		}

		protected int FindParentRowHandle(RowInfo rowInfo, int rowHandle) {
			int result = view.GetParentRowHandle(rowHandle);
			while(view.GetRowLevel(result) != rowInfo.level)
				result = view.GetParentRowHandle(result);
			return result;
		}

		protected void ExpandRowByRowInfo(RowInfo rowInfo){
			int dataRowHandle = view.LocateByValue(0, view.Columns[keyFieldName], rowInfo.Id);
			if(dataRowHandle != GridControl.InvalidRowHandle){
				int parentRowHandle = FindParentRowHandle(rowInfo, dataRowHandle);
				view.SetRowExpanded(parentRowHandle, true, false);
			}
		}

		protected int GetRowHandleToSelect(RowInfo rowInfo) {
			int dataRowHandle = view.LocateByValue(0, view.Columns[keyFieldName], rowInfo.Id);
			if(dataRowHandle != GridControl.InvalidRowHandle)
				if (view.GetRowLevel(dataRowHandle) != rowInfo.level)
					return  FindParentRowHandle(rowInfo, dataRowHandle);
			return dataRowHandle;
		}

		protected void SelectRowByRowInfo(RowInfo rowInfo, bool isFocused){
			if(isFocused)
				view.FocusedRowHandle = GetRowHandleToSelect(rowInfo);
			else 
				view.SelectRow(GetRowHandleToSelect(rowInfo));
		}

		public void SaveSelectionViewInfo(ArrayList list){
			list.Clear();
			GridColumn column = view.Columns[keyFieldName];
			RowInfo rowInfo;
			int[] selectionArray = view.GetSelectedRows();
			if (selectionArray != null)  // otherwise we have a single focused but not selected row
				for(int i = 0; i < selectionArray.Length; i++){
					int dataRowHandle = selectionArray[i];
					rowInfo.level = view.GetRowLevel(dataRowHandle);
					if(dataRowHandle < 0) // group row
						dataRowHandle = view.GetDataRowHandleByGroupRowHandle(dataRowHandle);
					rowInfo.Id = view.GetRowCellValue(dataRowHandle, column);            
					list.Add(rowInfo);
				}
			rowInfo.Id = view.GetRowCellValue(view.FocusedRowHandle, column);
			rowInfo.level = view.GetRowLevel(view.FocusedRowHandle);
			list.Add(rowInfo);
		}

		public void SaveExpansionViewInfo(ArrayList list){
			if(view.GroupedColumns.Count == 0) return;
			list.Clear();
			GridColumn column = view.Columns[keyFieldName];
			for(int i = -1; i > int.MinValue; i--) {
				if(!view.IsValidRowHandle(i)) break;
				if(view.GetRowExpanded(i)){
					RowInfo rowInfo;
					int dataRowHandle = view.GetDataRowHandleByGroupRowHandle(i);
					rowInfo.Id = view.GetRowCellValue(dataRowHandle, column);
					rowInfo.level = view.GetRowLevel(i);
					list.Add(rowInfo);
				}			  
			}			 
		}

		public void SaveExpandedMasterRows(ArrayList list){
			if(view.GridControl.Views.Count == 1) return;
			list.Clear();
			GridColumn column = view.Columns[keyFieldName];
			for(int i = 0; i < view.DataRowCount; i++)
				if(view.GetMasterRowExpanded(i))
					list.Add(view.GetRowCellValue(i, column));
		}

		public void SaveVisibleIndex(){
			visibleRowIndex = view.GetVisibleIndex(view.FocusedRowHandle) - view.TopRowIndex;
		}

		public void LoadVisibleIndex(){
			view.MakeRowVisible(view.FocusedRowHandle, true);
			view.TopRowIndex = view.GetVisibleIndex(view.FocusedRowHandle) - visibleRowIndex;
		}

		public void LoadSelectionViewInfo(ArrayList list) {
			view.BeginSelection();
			try {
				view.ClearSelection();
				for(int i = 0; i < list.Count; i++)
					SelectRowByRowInfo((RowInfo)list[i], i == list.Count - 1);
			}
			finally {
				view.EndSelection();
			}
		}

		public void LoadExpansionViewInfo(ArrayList list) {
			if(view.GroupedColumns.Count == 0) return;
			view.BeginUpdate();
			try {
				view.CollapseAllGroups();
				foreach(RowInfo info in list)
					ExpandRowByRowInfo(info);
			}
			finally {
				view.EndUpdate();
			}
		}

		public void LoadExpandedMasterRows(ArrayList list) {
			view.BeginUpdate();
			try {
				view.CollapseAllDetails();
				GridColumn column = view.Columns[keyFieldName];
				for(int i = 0; i < list.Count; i++){
					int rowHandle = view.LocateByValue(0, column, list[i]);
					view.SetMasterRowExpanded(rowHandle, true);
				}
			}
			finally {
				view.EndUpdate();
			}
		}

		public void SaveViewInfo(){
			SaveExpandedMasterRows(SaveMasterRowsList);
			SaveExpansionViewInfo(SaveExpList);
			SaveSelectionViewInfo(SaveSelList);
			SaveVisibleIndex();
		}

		public void LoadViewInfo(){
			LoadExpandedMasterRows(SaveMasterRowsList);
			LoadExpansionViewInfo(SaveExpList);
			LoadSelectionViewInfo(SaveSelList);
			LoadVisibleIndex();
		}
	}
}

Và dưới đây là cách sử dụng.

Source code Class FrmMain.cs:

using DevExpress.XtraGrid.Helpers;
using Newtonsoft.Json;
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.IO;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Forms;

namespace SaveStateGridView
{
    public partial class Form1 : DevExpress.XtraEditors.XtraForm
    {
        RefreshHelper helper;
        public Form1()
        {
            InitializeComponent();
            helper = new RefreshHelper(gridView1, "id");
        }
        public async void GetData(int numRecord)
        {
            helper.SaveViewInfo();
            listMovie = new List<Result>();
            gridView1.ShowLoadingPanel();
            listMovie = await LoadDataAsync();
            if (listMovie != null)
            {
                gridControl1.DataSource = listMovie.Take(numRecord);
                gridView1.HideLoadingPanel();
                helper.LoadViewInfo();
            }
        }
        public Task<List<Result>> LoadDataAsync()
        {
            return Task.Run(() => {
                var json = File.ReadAllText("movie.json");
                var data = JsonConvert.DeserializeObject<List<Result>>(json);
                return data;
            });
        }
        List<Result> listMovie;
        public class Result
        {
            public double popularity { get; set; }
            public int vote_count { get; set; }
            public bool video { get; set; }
            public string poster_path { get; set; }
            public int id { get; set; }
            public bool adult { get; set; }
            public string backdrop_path { get; set; }
            public string original_language { get; set; }
            public string original_title { get; set; }
            public string title { get; set; }
            public double vote_average { get; set; }
            public string overview { get; set; }
            public string release_date { get; set; }
        }

        private void btnRefresh_Click(object sender, EventArgs e)
        {                 
            GetData(Convert.ToInt32(txtNum.Text));          
        }
    }
}

Thanks for watching!

DOWNLOAD SOURCE