C#學習筆記——窗口停靠控件WeifenLuo.WinFormsUI.Docking使用

一、介紹

DockPanelSuite是托管在GitHub上的一個開源項目，使用在WinForms上，是一個簡單、美觀的界面組件。其中weiFenLuo.winFormsUI.Docking.dll較為人熟知，它是DockPanel Suite的一個類庫，可以實現類似VS的窗口停靠、懸浮、自動隱藏等功能，同時能夠保存窗體布局為XML文件,啟動時加載XML配置文件還原布局。DockPanelSuite還包含有多種VS主題，能夠自由切換變換風格。

DockPanelSuite官網：

http://docs.dockpanelsuite.com/#

GitHub上DockPanelSuite：

https://github.com/dockpanelsuite

二、引用源碼使用

新建一個測試用Winforms項目，右鍵解決方案，添加現有項目，瀏覽剛才下載的文件夾，找到WinFormsUI文件下的工程，除multithreaading以外添加進來

 

（3）右鍵項目，添加引用，選擇剛才添加的所有項目，確定。

 

（4）點擊Form1，工具箱，可以看到工具箱里多出了WinFormsUI組件和主題組件，如果沒有，關閉Form1,右鍵工程重新生成，再打開Form1。

 

（5）一定要先設置Form1的IsMdiContainer屬性為True，

 

再放置一個dockPanel控件和Vs2015BlueTheme到Form1上，設置dockPanel1的Dock為Fill，Theme為vS2015BlueTheme1

 

 

（6）工程添加一個新的windows窗體Form2，更改Form2 : Form 繼承為 Form2 : DockContent

 

（7）  在Form1的構造函數里添加測試代碼如下

  public Form1()
        {
            InitializeComponent();
            //測試代碼
            var f2 = new Form2() { TabText = "Document" };
            f2.Show(this.dockPanel1, DockState.Document);
            f2 = new Form2() { TabText = "DockLeft" }; ;
            f2.Show(this.dockPanel1, DockState.DockLeft);
            f2 = new Form2() { TabText = "DockRight" }; ;
            f2.Show(this.dockPanel1, DockState.DockRight);
            f2 = new Form2() { TabText = "DockBottom" }; ;
            f2.Show(this.dockPanel1, DockState.DockBottom);
            f2 = new Form2() { TabText = "DockLeftAutoHide" }; ;
            f2.Show(this.dockPanel1, DockState.DockLeftAutoHide);
            f2 = new Form2() { TabText = "Float" }; ;
            f2.Show(this.dockPanel1, DockState.Float);
        }

（8）運行，順利的話能看到界面如下，說明DockPanelSuite已能夠正常使用，拖動窗口實現停靠或懸浮。

三、引用dll使用

1.新建一個WinForm程序,項目名稱為TestDockPanelControl。

 

2.選中Form1窗體后選擇工具箱--->>新建個添加選項卡命名為WeiFenLuo--->>右鍵--->>選擇項--->>瀏覽--->>weiFenLuo.winFormsUI.Docking.dll--->>確定.（注意weiFenLuo.winFormsUI.Docking.dll的路徑不能有名為“C#”的文件夾，巨坑這里）

 

3.此時工具箱出現DockPanel控件。這以上步驟僅是把DockPanel控件添加到工具箱中。

 

4.主窗體設置：(Mainwnd窗體默認是主窗體)

Mainwnd窗體的屬性設置
在原有的Mainwnd窗體上設置窗體的Text屬性為主窗體，IsMdiContainer屬性為true也就是設置為MDI程序（為了體驗DockPanel控件的演示效果）。FormBorderStyle設置為

 

5.將dockPanel拖放到Mainwnd中，設置dockpanel的相關屬性：dockPanel.Dock=Fill

（以及DocumentStyle為DockingMdi、RightToLeftLayout為True）。

這幾個屬性的意思應該不難，Dock就是 覆蓋整個MDI窗體的區域，DocumentStyle為多文檔類型、RightToLeftLayout是指新打開的窗口都停靠在右邊區域。

 

6新建一個Windows 窗體MainToolWindow，修改窗體繼承於WeifenLuo.WinFormsUI.Docking.DockContent： 

public partial class Form1 : WeifenLuo.WinFormsUI.Docking.DockContent

 

 

其中的“HideOnClose”屬性很重要，該屬性一般設置為True，就是指你關閉窗口時，窗體只是隱藏而不是真的關閉。

左邊的窗口MainToolWindow實現停靠的代碼是在MainForm的構造函數或者Load函數中加載即可。

mainToolWin.Show(this.dockPanel, DockState.DockLeft);

（為了方便，我們定義一個基類窗體，命名為BaseForm，繼承自DockContent，如下所示

public class BaseForm : DockContent

然后每個業務窗口繼承BaseForm即可。）

 

7。在MainWnd中添加Load事件的響應代碼來創建停靠窗口

       

    public partial class MainForm : Form
    {
        #region 屬性字段

         private MainToolWindow mainToolWin = new MainToolWindow();
        private FrmProduct frmProduct = new FrmProduct();
        private FrmCustomer frmCustomer = new FrmCustomer();
        private FrmOrder frmOrder = new FrmOrder();
        private FrmStock frmStock = new FrmStock();
        private FrmComingCall frmComingCall = new FrmComingCall();
        private FrmDeliving frmDeliving = new FrmDeliving();
        private FrmTicketHistory frmHistory = new FrmTicketHistory(); 

        #endregion

        public MainForm()
        {
            InitializeComponent();

            SplashScreen.Splasher.Status = "正在展示相關的內容";
            System.Threading.Thread.Sleep(100);

            mainToolWin.Show(this.dockPanel, DockState.DockLeft);
            frmComingCall.Show(this.dockPanel);
            frmDeliving.Show(this.dockPanel);
            frmHistory.Show(this.dockPanel);
            frmStock.Show(this.dockPanel);
            frmProduct.Show(this.dockPanel);
            frmCustomer.Show(this.dockPanel);
            frmOrder.Show(this.dockPanel);

            SplashScreen.Splasher.Status = "初始化完畢";
            System.Threading.Thread.Sleep(50);

            SplashScreen.Splasher.Close();
        }

 

 

8.保存界面布局

【1】新建一個Windows 窗體Form2，修改窗體繼承於WeifenLuo.WinFormsUI.Docking.DockContent，同上。

【2】設置Form1與Form2的HideOnClose屬性為True，表示關閉窗體時，不是真的關閉銷毀資源，而是隱藏。

【3】添加成員變量，用於保存界面布局：
        

private static string _dockpanelConfigFile = Path.Combine(Path.GetDirectoryName(Application.ExecutablePath), "DockManager.config");
        private Form1 _form1 = new Form1();
        private Form2 _form2 = new Form2();

 

【4】添加2個子菜單的Click事件，用於顯示窗體Form1與Form2
       

private void form1ToolStripMenuItem_Click(object sender, EventArgs e)
        {
            _form1.Show(_dockPanel, DockState.DockLeft);            
        }
 
        private void form2ToolStripMenuItem_Click(object sender, EventArgs e)
        {
            _form2.Show(_dockPanel, DockState.Document);
        }

 

【5】主窗體加載時，顯示上次保存的界面，需要編寫DeserializeDockContent回調函數，很簡單：
回調函數：
  

public IDockContent GetDeserializeDockContent(string persistString)
        {
            if (persistString == typeof(Form1).ToString())
                return _form1;
            if (persistString == typeof(Form2).ToString())
                return _form2;
            return null;
        }    

 

主窗體加載，加載上次保存的界面：

 private void MainWnd_Load(object sender, EventArgs e)
        {         
            try
            {
                if (File.Exists(_dockpanelConfigFile))
                    _dockPanel.LoadFromXml(_dockpanelConfigFile, new DeserializeDockContent(GetDeserializeDockContent));
            }
            catch (Exception)
            {
            }
        }

 

【6】主窗體關閉時，保存當前的界面：
    

private void MainWnd_FormClosing(object sender, FormClosingEventArgs e)
        {
            _dockPanel.SaveAsXml(_dockpanelConfigFile);    
        }

 

【7】注意
這種方式只能保存DockPanel中的界面布局，而主窗體的尺寸、顯示的位置是無法保存時，所以需要保存主窗體的尺寸與位置的需要寫一個配置文件，如.Config，保存主窗體啟動的位置與尺寸，很簡單，這里不再詳細介紹。

9.停靠初始化

//底部
        private void bottomToolStripMenuItem_Click(object sender, EventArgs e)
        {
            FormDock frm = new FormDock();
            frm.Text = "底部停靠";
            frm.Show(this.dockPanel1);
            frm.DockTo(this.dockPanel1, DockStyle.Bottom);
        }
        //全屏
        private void fillToolStripMenuItem_Click(object sender, EventArgs e)
        {
            FormDock frm = new FormDock();
            frm.Text = "全屏停靠";
            frm.Show(this.dockPanel1);
            frm.DockTo(this.dockPanel1, DockStyle.Fill);
        }
        //左側
        private void leftToolStripMenuItem_Click(object sender, EventArgs e)
        {
            FormDock frm = new FormDock();
            frm.Text = "左側停靠";
            frm.Show(this.dockPanel1);
            frm.DockTo(this.dockPanel1, DockStyle.Left);
        }
        //None
        private void noneToolStripMenuItem_Click(object sender, EventArgs e)
        {
            FormDock frm = new FormDock();
            frm.Text = "NONE";
            frm.Show(this.dockPanel1);
            frm.DockTo(this.dockPanel1, DockStyle.None);
        }
        //右側
        private void rightToolStripMenuItem_Click(object sender, EventArgs e)
        {
            FormDock frm = new FormDock();
            frm.Text = "右側停靠";
            frm.Show(this.dockPanel1);
            frm.DockTo(this.dockPanel1, DockStyle.Right);
        }
        //頂部
        private void topToolStripMenuItem_Click(object sender, EventArgs e)
        {
            FormDock frm = new FormDock();
            frm.Text = "頂部停靠";
            frm.Show(this.dockPanel1);
            frm.DockTo(this.dockPanel1, DockStyle.Top);
        }

 

9.下面貼出基本窗口的基本操作事件函數

 private void menu_Window_CloseAll_Click(object sender, EventArgs e)
        {
            CloseAllDocuments();
        }

        private void menu_Window_CloseOther_Click(object sender, EventArgs e)
        {
            if (dockPanel.DocumentStyle == DocumentStyle.SystemMdi)
            {
                Form activeMdi = ActiveMdiChild;
                foreach (Form form in MdiChildren)
                {
                    if (form != activeMdi)
                    {
                        form.Close();
                    }
                }
            }
            else
            {
                foreach (IDockContent document in dockPanel.DocumentsToArray())
                {
                    if (!document.DockHandler.IsActivated)
                    {
                        document.DockHandler.Close();
                    }
                }
            }
        }

        private DockContent FindDocument(string text)
        {
            if (dockPanel.DocumentStyle == DocumentStyle.SystemMdi)
            {
                foreach (Form form in MdiChildren)
                {
                    if (form.Text == text)
                    {
                        return form as DockContent;
                    }
                }

                return null;
            }
            else
            {
                foreach (DockContent content in dockPanel.Documents)
                {
                    if (content.DockHandler.TabText == text)
                    {
                        return content;
                    }
                }

                return null;
            }
        }

        public DockContent ShowContent(string caption, Type formType)
        {
            DockContent frm = FindDocument(caption);
            if (frm == null)
            {
                frm = ChildWinManagement.LoadMdiForm(Portal.gc.MainDialog, formType) as DockContent;
            }

            frm.Show(this.dockPanel);
            frm.BringToFront();
            return frm;
        }

        public void CloseAllDocuments()
        {
            if (dockPanel.DocumentStyle == DocumentStyle.SystemMdi)
            {
                foreach (Form form in MdiChildren)
                {
                    form.Close();
                }
            }
            else
            {
                IDockContent[] documents = dockPanel.DocumentsToArray();
                foreach (IDockContent content in documents)
                {
                    content.DockHandler.Close();
                }
            }
        } 

 

10. 如果需要某個頁面始終不被關閉，則在此form的frmCloseing事件中添加如下代碼

            e.Cancel = true;

 

11.修改頂部顏色
      dockPanelGradient2.EndColor = System.Drawing.Color.FromArgb(((int)(((byte)(223)))), ((int)(((byte)(255)))), ((int)(((byte)(250)))));
      dockPanelGradient2.StartColor = System.Drawing.Color.FromArgb(((int)(((byte)(223)))), ((int)(((byte)(255)))), ((int)(((byte)(250)))));