GridControlEx.cs 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398
  1. using DevExpress.Utils;
  2. using DevExpress.Utils.Menu;
  3. using DevExpress.Utils.Svg;
  4. using DevExpress.XtraBars;
  5. using DevExpress.XtraEditors;
  6. using DevExpress.XtraEditors.Controls;
  7. using DevExpress.XtraGrid;
  8. using DevExpress.XtraGrid.Columns;
  9. using DevExpress.XtraGrid.Views.Grid;
  10. using DevExpress.XtraGrid.Views.Tile;
  11. using System;
  12. using System.Collections.Generic;
  13. using System.ComponentModel.DataAnnotations;
  14. using System.Drawing;
  15. using System.IO;
  16. using System.Linq;
  17. using System.Reflection;
  18. using System.Runtime.CompilerServices;
  19. using System.Text;
  20. using System.Threading;
  21. using System.Threading.Tasks;
  22. using System.Windows.Forms;
  23. public static class GridControlEx
  24. {
  25. class GridTag
  26. {
  27. public GridTag() { }
  28. public PopupMenu PopupMenu { get; set; }
  29. public BarManager BarM { get; set; }
  30. }
  31. /// <summary>
  32. /// <para>初始化表格</para>
  33. /// <para>禁用列菜单、排序、分组、过滤、列拖动等</para>
  34. /// </summary>
  35. /// <param name="grid"></param>
  36. /// <param name="rowHeight"></param>
  37. /// <param name="showScrollH"></param>
  38. /// <typeparam name="T">绑定的数据源模型类型</typeparam>
  39. /// <param name="searchLookUpEdit">searchLookUpEditd控件</param>
  40. /// <returns></returns>
  41. public static GridControl Init<T>(this GridControl grid, int rowHeight = 24, bool showScrollH = false, Control searchLookUpEdit = null)
  42. {
  43. grid.MainView.BorderStyle = BorderStyles.Flat;
  44. var view = grid.MainView as GridView;
  45. view.CustomColumnDisplayText += View_CustomColumnDisplayText;
  46. view.Appearance.HeaderPanel.TextOptions.HAlignment = HorzAlignment.Center;
  47. view.Appearance.Row.Options.UseTextOptions = true;
  48. view.Appearance.Row.TextOptions.HAlignment = HorzAlignment.Center;
  49. view.OptionsView.ColumnHeaderAutoHeight = DefaultBoolean.True;
  50. view.RowHeight = rowHeight;
  51. view.OptionsView.ShowGroupPanel = false;
  52. view.OptionsBehavior.Editable = false;
  53. view.OptionsView.ShowDetailButtons = false;
  54. view.OptionsView.ShowIndicator = false;
  55. view.OptionsMenu.EnableColumnMenu = true;
  56. view.OptionsCustomization.AllowFilter = false;
  57. view.OptionsCustomization.AllowGroup = false;
  58. view.OptionsCustomization.AllowSort = false;
  59. view.OptionsCustomization.AllowColumnMoving = true;
  60. view.OptionsCustomization.AllowMergedGrouping = DefaultBoolean.False;
  61. view.OptionsSelection.MultiSelect = false;
  62. view.OptionsCustomization.AllowRowSizing = false;
  63. view.OptionsCustomization.AllowQuickHideColumns = false;
  64. view.OptionsMenu.EnableGroupPanelMenu = false;
  65. view.OptionsMenu.EnableGroupRowMenu = false;
  66. view.OptionsMenu.EnableFooterMenu = false;
  67. view.OptionsLayout.StoreAllOptions = true;
  68. view.OptionsLayout.StoreAppearance = true;
  69. view.OptionsLayout.StoreDataSettings = true;
  70. view.OptionsLayout.StoreVisualOptions = true;
  71. view.OptionsLayout.StoreFormatRules = true;
  72. view.OptionsView.ColumnAutoWidth = !showScrollH;
  73. view.PopupMenuShowing += View_PopupMenuShowing;
  74. view.OptionsSelection.EnableAppearanceFocusedCell = false;
  75. string GetLayoutName()
  76. {
  77. Control ctrl;
  78. if (searchLookUpEdit != null)
  79. ctrl = searchLookUpEdit;
  80. else
  81. ctrl = grid;
  82. while (ctrl.Parent != null)
  83. {
  84. ctrl = ctrl.Parent;
  85. if (ctrl is UserControl) break;
  86. }
  87. var props = typeof(T).GetProperties();
  88. StringBuilder sb = new StringBuilder();
  89. foreach (var item in props)
  90. {
  91. sb.Append(item.Name);
  92. }
  93. var md5 = MD5Helper.StrToMD5(sb.ToString());
  94. if (searchLookUpEdit != null)
  95. return $"{ctrl.Name}_{searchLookUpEdit.Name}_{md5}";
  96. else
  97. return $"{ctrl.Name}_{grid.Name}_{md5}";
  98. }
  99. string name = GetLayoutName();
  100. void SaveLayoutAction()
  101. {
  102. Form frm = null;
  103. if (searchLookUpEdit == null)
  104. frm = grid.FindForm();
  105. else
  106. frm = searchLookUpEdit.FindForm();
  107. if (frm != null)
  108. {
  109. frm.VisibleChanged += (sender2, e2) =>
  110. {
  111. Directory.CreateDirectory("Layout");
  112. if (name == null) return;
  113. grid.MainView?.SaveLayoutToXml($"Layout\\{name}.xml", OptionsLayoutBase.FullLayout);
  114. };
  115. }
  116. }
  117. if (grid.IsLoaded)
  118. {
  119. SaveLayoutAction();
  120. }
  121. else
  122. {
  123. grid.Load += (sender, e) => SaveLayoutAction();
  124. }
  125. if (name != null && File.Exists($"Layout\\{name}.xml"))
  126. {
  127. view.RestoreLayoutFromXml($"Layout\\{name}.xml", OptionsLayoutBase.FullLayout);
  128. }
  129. view.KeyUp += View_KeyUp;
  130. grid.Tag = new GridTag();
  131. return grid;
  132. }
  133. public static GridControl UseExportCsv(this GridControl grid)
  134. {
  135. GridTag tag = grid.Tag as GridTag;
  136. if (tag.BarM == null)
  137. {
  138. tag.BarM = new BarManager();
  139. tag.BarM.Form = grid;
  140. }
  141. if (tag.PopupMenu == null)
  142. {
  143. tag.PopupMenu = new PopupMenu();
  144. }
  145. PopupMenu popupMenu = tag.PopupMenu;
  146. BarButtonItem item = new BarButtonItem();
  147. item.ItemClick += (sender, e) =>
  148. {
  149. SaveFileDialog dialog = new SaveFileDialog();
  150. dialog.Filter = "csv|*.csv";
  151. if (dialog.ShowDialog() == DialogResult.OK)
  152. {
  153. var view = grid.MainView as GridView;
  154. view.ExportToCsv(dialog.FileName);
  155. }
  156. };
  157. item.ImageOptions.SvgImage = DxHelper.SvgHelper.CreateExportCsv();
  158. item.Caption = "导出(CSV)";
  159. tag.BarM.Items.Add(item);
  160. popupMenu.AddItem(item);
  161. popupMenu.Manager = tag.BarM;
  162. tag.PopupMenu = popupMenu;
  163. return grid;
  164. }
  165. public static GridControl UseExportXlsx(this GridControl grid)
  166. {
  167. GridTag tag = grid.Tag as GridTag;
  168. if (tag.BarM == null)
  169. {
  170. tag.BarM = new BarManager();
  171. tag.BarM.Form = grid;
  172. }
  173. if (tag.PopupMenu == null)
  174. {
  175. tag.PopupMenu = new PopupMenu();
  176. }
  177. PopupMenu popupMenu = tag.PopupMenu;
  178. BarButtonItem item = new BarButtonItem();
  179. item.ItemClick += (sender, e) =>
  180. {
  181. SaveFileDialog dialog = new SaveFileDialog();
  182. dialog.Filter = "Excel文件|*.xlsx";
  183. if (dialog.ShowDialog() == DialogResult.OK)
  184. {
  185. var view = grid.MainView as GridView;
  186. view.ExportToXlsx(dialog.FileName);
  187. }
  188. };
  189. item.ImageOptions.SvgImage = DxHelper.SvgHelper.CreateExportXlsx();
  190. item.Caption = "导出(Excel)";
  191. tag.BarM.Items.Add(item);
  192. popupMenu.AddItem(item);
  193. popupMenu.Manager = tag.BarM;
  194. tag.PopupMenu = popupMenu;
  195. return grid;
  196. }
  197. private static void View_KeyUp(object sender, KeyEventArgs e)
  198. {
  199. if (e.Control && e.Shift & e.KeyCode == Keys.C)
  200. {
  201. var view = sender as GridView;
  202. if (view.FocusedColumn == null) return;
  203. var val = view.GetFocusedRowCellDisplayText(view.FocusedColumn);
  204. if (string.IsNullOrWhiteSpace(val)) return;
  205. Clipboard.SetText(val);
  206. }
  207. }
  208. private static void View_CustomColumnDisplayText(object sender, DevExpress.XtraGrid.Views.Base.CustomColumnDisplayTextEventArgs e)
  209. {
  210. if (e.Column.ColumnType == typeof(DateTime) || e.Column.ColumnType == typeof(DateTime?))
  211. {
  212. if (e.Value == null) return;
  213. if (e.Column.FieldName == "SigTime")
  214. e.DisplayText = Convert.ToDateTime(e.Value).ToString("yyyy-MM-dd HH:mm:ss.fff");
  215. else
  216. e.DisplayText = Convert.ToDateTime(e.Value).ToString("yyyy-MM-dd HH:mm:ss");
  217. }
  218. }
  219. public static GridControl ShowColumn(this GridControl grid, params string[] colField)
  220. {
  221. var view = grid.MainView as GridView;
  222. if (view.Columns.Count == 0) return grid;
  223. if (colField == null || colField.Length == 0) return grid;
  224. foreach (GridColumn item in view.Columns)
  225. {
  226. if (colField.Contains(item.FieldName))
  227. item.Visible = true;
  228. }
  229. return grid;
  230. }
  231. public static GridControl UseMultiSelect(this GridControl grid)
  232. {
  233. var view = grid.MainView as GridView;
  234. view.OptionsSelection.MultiSelect = true;
  235. view.OptionsSelection.MultiSelectMode = GridMultiSelectMode.RowSelect;
  236. return grid;
  237. }
  238. public static GridControl UseSort(this GridControl grid)
  239. {
  240. var view = grid.MainView as GridView;
  241. view.OptionsCustomization.AllowSort = true;
  242. return grid;
  243. }
  244. public static GridControl UseGroup(this GridControl grid)
  245. {
  246. var view = grid.MainView as GridView;
  247. view.OptionsView.GroupFooterShowMode = GroupFooterShowMode.Hidden;
  248. view.OptionsView.ShowGroupPanel = true;
  249. view.OptionsCustomization.AllowGroup = true;
  250. view.OptionsCustomization.AllowSort = true;
  251. return grid;
  252. }
  253. public static GridControl UseFooter(this GridControl grid, Action<object, DevExpress.XtraGrid.Views.Base.RowObjectCustomDrawEventArgs> act)
  254. {
  255. var view = grid.MainView as GridView;
  256. view.OptionsView.ShowFooter = true;
  257. view.CustomDrawFooter += (s, e) => act(s, e);
  258. return grid;
  259. }
  260. public static GridControl UseFilter(this GridControl grid)
  261. {
  262. var view = grid.MainView as GridView;
  263. view.OptionsCustomization.AllowFilter = true;
  264. return grid;
  265. }
  266. public static GridControl UseEdit(this GridControl grid)
  267. {
  268. var view = grid.MainView as GridView;
  269. view.OptionsBehavior.Editable = true;
  270. view.OptionsSelection.EnableAppearanceFocusedCell = true;
  271. foreach (GridColumn item in view.Columns)
  272. {
  273. item.OptionsColumn.AllowEdit = false;
  274. }
  275. return grid;
  276. }
  277. public static GridControl UseRowNumber(this GridControl grid)
  278. {
  279. var view = grid.MainView as GridView;
  280. view.OptionsView.ShowIndicator = true;
  281. view.CustomDrawRowIndicator += (s, e) =>
  282. {
  283. if (!e.Info.IsRowIndicator) return;
  284. if (e.RowHandle < 0) return;
  285. e.Handled = true;
  286. string txt = (e.RowHandle + 1).ToString();
  287. var txtSize = e.Graphics.MeasureString(txt, e.Appearance.Font);
  288. if (view.IndicatorWidth < txtSize.Width + 20)
  289. {
  290. view.IndicatorWidth++;
  291. }
  292. var loc = new PointF(e.Bounds.X + e.Bounds.Width / 2f - txtSize.Width / 2f + 2,
  293. e.Bounds.Y + e.Bounds.Height / 2f - txtSize.Height / 2f);
  294. e.Cache.FillRectangle(new SolidBrush(e.Appearance.BackColor), e.Bounds);
  295. e.Cache.DrawString(txt, e.Appearance.Font, new SolidBrush(e.Appearance.ForeColor), loc);
  296. };
  297. view.RowCountChanged += (sender, e) =>
  298. {
  299. if (view.RowCount == 0)
  300. view.IndicatorWidth = -1;
  301. else
  302. view.IndicatorWidth = view.RowCount.ToString().Length * 6 + 20;
  303. };
  304. return grid;
  305. }
  306. public static GridControl HideColumn(this GridControl grid, params string[] colField)
  307. {
  308. var view = grid.MainView as GridView;
  309. if (colField == null || colField.Length == 0) return grid;
  310. foreach (GridColumn item in view.Columns)
  311. {
  312. if (colField.Contains(item.FieldName))
  313. item.Visible = false;
  314. }
  315. return grid;
  316. }
  317. private static void View_PopupMenuShowing(object sender, PopupMenuShowingEventArgs e)
  318. {
  319. if (e.Menu != null)
  320. {
  321. foreach (DXMenuItem item in e.Menu.Items)
  322. {
  323. if (!item.Enabled)
  324. {
  325. item.Visible = false;
  326. continue;
  327. }
  328. }
  329. }
  330. if (e.HitInfo.HitTest == DevExpress.XtraGrid.Views.Grid.ViewInfo.GridHitTest.EmptyRow)
  331. {
  332. return;
  333. }
  334. var view = sender as GridView;
  335. var grid = view.GridControl;
  336. var p = grid.PointToScreen(e.Point);
  337. var tag = grid.Tag as GridTag;
  338. tag?.PopupMenu?.ShowPopup(p);
  339. }
  340. public static GridControl AddMenu(this GridControl grid, string menuText, SvgImage meunImage, Action onClick, PopupMenu existMenu = null)
  341. {
  342. GridTag tag = grid.Tag as GridTag;
  343. PopupMenu popupMenu;
  344. if (existMenu == null)
  345. {
  346. if (tag.BarM == null)
  347. {
  348. tag.BarM = new BarManager();
  349. tag.BarM.Form = grid;
  350. }
  351. if (tag.PopupMenu == null)
  352. {
  353. tag.PopupMenu = new PopupMenu();
  354. }
  355. popupMenu = tag.PopupMenu;
  356. }
  357. else
  358. {
  359. popupMenu = existMenu;
  360. tag.PopupMenu = existMenu;
  361. tag.BarM = existMenu.Manager;
  362. }
  363. BarButtonItem item = new BarButtonItem();
  364. item.ItemClick += (sender, e) =>
  365. {
  366. item.Enabled = false;
  367. onClick?.Invoke();
  368. item.Enabled = true;
  369. };
  370. item.ImageOptions.SvgImage = meunImage;
  371. item.Caption = menuText;
  372. tag.BarM.Items.Add(item);
  373. popupMenu.AddItem(item);
  374. popupMenu.Manager = tag.BarM;
  375. tag.PopupMenu = popupMenu;
  376. return grid;
  377. }
  378. }