自定義GridLookUpEdit編輯器

本文版權歸博主  驚夢無痕  所有，歡迎轉載，但須保留此段聲明，並給出原文鏈接，謝謝合作。SourceLink

前兩天分享了GridControl的自定義編輯器，今天再來分享一下整理出來的GridLookUpEdit的自定義編輯器。
本代碼用的DevExpress版本號：17.2.6.0，舊的版本可能有些地方會有些微的變化。
該自定義編輯器需要用到上篇中定義的MyGridView（具體代碼可在自定義GridControl編輯器一文中閱覽），此控件包含了多列模糊查詢功能，希望對使用或正在學習DevExpress的同學有所幫助。
后續有時間會陸續將一些比較實用的自定義編輯器分享出來。

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Windows.Forms;
using Comteck.Dto;
using DevExpress.XtraEditors;
using DevExpress.XtraEditors.Controls;
using DevExpress.XtraEditors.Drawing;
using DevExpress.XtraEditors.Popup;
using DevExpress.XtraEditors.Registrator;
using DevExpress.XtraEditors.Repository;
using DevExpress.XtraEditors.ViewInfo;
using DevExpress.XtraGrid;
using DevExpress.XtraGrid.Views.Base;

namespace Comteck.Winforms.Controls {
  /// <summary>
  /// 自定義的GridLookupEdit,允許進行多列的匹配
  /// <para>參照：https://www.devexpress.com/Support/Center/Example/Details/E1985 </para>
  /// </summary>
  [ToolboxItem(true)]
  public class MyGridLookUpEdit : GridLookUpEdit {
    /// <summary>
    /// 自動注冊下拉框編輯器
    /// </summary>
    static MyGridLookUpEdit() {
      RepositoryItemMyGridLookUpEdit.RegisterCustomGridLookUpEdit();
    }

    /// <summary>
    /// 創建自定義GridLookupEdit
    /// </summary>
    public MyGridLookUpEdit() : base() {
      Initialize();
    }

    /// <summary>
    /// 初始化
    /// </summary>
    private void Initialize() {
      this.Tag = false;   // 設置全選標記
      this.Properties.AllowMouseWheel = false;
      //this.EnterMoveNextControl = true;
      this.Properties.ImmediatePopup = true;
      this.Properties.TextEditStyle = TextEditStyles.Standard;

      #region 編輯框默認自動全選

      // 鼠標移入文本編輯框觸發事件
      this.Enter += (sender, e) => {
        // 設置全選標記
        this.Tag = true;
        this.SelectAll();
      };
      // 獲取輸入焦點時自動全選
      this.MouseUp += (sender, e) => {
        // 如果鼠標左鍵操作並且標記存在，則執行全選
        if (e.Button == MouseButtons.Left && (bool)this.Tag) {
          this.SelectAll();
        }

        // 取消全選標記
        this.Tag = false;
      };
      // 雙擊輸入框時自動全選
      this.DoubleClick += (sender, e) => {
        this.SelectAll();
      };

      #endregion

      this.KeyDown += this.MyGridLookUpEdit_KeyDown;
    }

    /// <summary>
    /// 
    /// </summary>
    /// <param name="sender"></param>
    /// <param name="e"></param>
    private void MyGridLookUpEdit_KeyDown(object sender, KeyEventArgs e) {
      if (e.KeyCode == Keys.Delete) {
        var control = sender as BaseEdit;
        if (control.ReadOnly) { return; }
        control.EditValue = null;
        e.Handled = true;
      } else if (e.KeyCode == Keys.Down) {
        this.ShowPopup();

        e.Handled = true;
      } else if (e.KeyCode == Keys.Back) {
        if (this.IsPopupOpen == false) {
          this.ShowPopup();

          e.Handled = true;
        }
      }
    }

    /// <summary>
    /// 自定義編輯器名稱
    /// </summary>
    public override string EditorTypeName => RepositoryItemMyGridLookUpEdit.MyGridLookUpEditName;

    /// <summary>
    /// 重寫下拉框編輯器
    /// </summary>
    [DesignerSerializationVisibility(DesignerSerializationVisibility.Content)]
    public new RepositoryItemMyGridLookUpEdit Properties => base.Properties as RepositoryItemMyGridLookUpEdit;

    //
    // 摘要:
    //     Gets or sets whether focus is moved to the next control (according to the tab
    //     order) when an end-user presses ENTER.
    [DefaultValue(true)]
    [DXCategory("Behavior")]
    public override bool EnterMoveNextControl { get; set; } = true;

    /// <summary>
    /// 
    /// </summary>
    /// <returns></returns>
    protected override PopupBaseForm CreatePopupForm() {
      return new MyGridLookUpPopupForm(this);
    }

    /// <summary>
    /// 
    /// </summary>
    /// <param name="e"></param>
    /// <returns></returns>
    public override bool IsNeededKey(KeyEventArgs e) {
      return this.Properties.IsNeededKey(e.KeyData);
    }

    /// <summary>
    /// 正常情況下，在輸入第一個字符（主要是數字及字母）后，雖然自動彈出了下拉框並過濾了數據，
    /// 但是此時光標並未定位到下拉框中，導致回車后並未返回匹配到的首行記錄
    /// 此處就是為了解決以上問題，展開下拉框時自動定位到首行
    /// </summary>
    protected override void OnPopupShown() {
      base.OnPopupShown();

      BeginInvoke(new Action(() => {
        if (this.GetSelectedDataRow() == null) {
          this.Properties.View.FocusedRowHandle = 0;
        }
      }));
    }
  }

  /// <summary>
  /// 匹配自定義編輯器的下拉GridLookUpEdit
  /// </summary>
  [DXCategory("Properties")]
  [UserRepositoryItem("RegisterMyGridLookUpEdit")]
  public class RepositoryItemMyGridLookUpEdit : RepositoryItemGridLookUpEdit {
    /// <summary>
    /// 編輯器的名稱
    /// </summary>
    public const string MyGridLookUpEditName = "MyGridLookUpEdit";

    /// <summary>
    /// 注冊編輯器
    /// </summary>
    static RepositoryItemMyGridLookUpEdit() {
      RegisterCustomGridLookUpEdit();
    }

    /// <summary>
    /// 創建自定義的編輯器
    /// </summary>
    public RepositoryItemMyGridLookUpEdit() {
      // 不允許自動完成
      base.AutoComplete = false;
    }

    /// <summary>
    /// 編輯器名稱
    /// </summary>
    public override string EditorTypeName => MyGridLookUpEditName;

    /// <summary>
    /// 注冊編輯器
    /// </summary>
    public static void RegisterCustomGridLookUpEdit() {
      EditorRegistrationInfo.Default.Editors.Add(
          new EditorClassInfo(
              MyGridLookUpEditName,
              typeof(MyGridLookUpEdit),
              typeof(RepositoryItemMyGridLookUpEdit),
              typeof(GridLookUpEditBaseViewInfo),
              new ButtonEditPainter(),
              true));
    }

    /// <summary>
    /// 創建自定義GridView
    /// </summary>
    /// <returns></returns>
    protected override ColumnView CreateViewInstance() {
      return new MyGridView();
    }

    /// <summary>
    /// 創建自定義GridControl
    /// </summary>
    /// <returns></returns>
    protected override GridControl CreateGrid() {
      return new MyGridControl();
    }
  }

  public class MyGridLookUpPopupForm : PopupGridLookUpEditForm
  {
    public MyGridLookUpPopupForm(GridLookUpEdit ownerEdit)
        : base(ownerEdit) {
    }

    protected override void OnKeyDown(KeyEventArgs e) {
      if (e.KeyCode == Keys.Tab) {
        this.OwnerEdit.EditValue = QueryResultValue();
        this.OwnerEdit.SendKey(e);
      }
      
      base.OnKeyDown(e);
    }
  }
}