WinForm界面开发之布局控件"WeifenLuo.WinFormsUI.Docking"的使用

本篇介绍Winform程序开发中的布局界面的设计，介绍如何在我的共享软件中使用布局控件"WeifenLuo.WinFormsUI.Docking"。

布局控件"WeifenLuo.WinFormsUI.Docking"是一个非常棒的开源控件，用过的人都深有体会，该控件之强大、美观、不亚于商业控件。而且控件使用也是比较简单的。先看看控件使用的程序界面展示效果。

配电网络可视化管理系统的界面截图：



深田之星送水管理系统网络版的界面截图：



我在几个共享软件都使用了该布局控件，我们先以“深田之星送水管理系统网络版”这款软件为例，介绍如何完成该界面的设计及显示的。

1、首先，我们添加一个主界面窗体，命名为MainForm，该窗体IsMdiContainer设置为True，也就是设置为多文档窗体格式。拖拉布局控件"WeifenLuo.WinFormsUI.Docking.DockPanel"到主窗体MainForm中，并设置下面几个属性：

Dock为Fill、DocumentStyle为DockingMdi、RightToLeftLayout为True。

这几个属性的意思应该不难，Dock就是 覆盖整个MDI窗体的区域，DocumentStyle为多文档类型、RightToLeftLayout是指新打开的窗口都停靠在右边区域。

我们看看设计界面视图如下所示。



2、主界面其实基本上就可以了，另外我们看到“送水管理系统网络版”的界面中有一个左边的工具栏，它其实也是在一个停靠的窗体中的，我们增加一个窗体用来承载相关的工具快捷键按钮展示。命名为MainToolWindow的窗体，继承自WeifenLuo.WinFormsUI.Docking.DockContent.



其中的“HideOnClose”属性很重要，该属性一般设置为True，就是指你关闭窗口时，窗体只是隐藏而不是真的关闭。

左边的窗口MainToolWindow实现停靠的代码是在MainForm的构造函数或者Load函数中加载即可。

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

3、对于工具窗口我们已经完成了，但是主业务窗口还没有做，也就是下面的部分内容。



为了方便，我们定义一个基类窗体，命名为BaseForm，继承自DockContent，如下所示

public class BaseForm : DockContent

然后每个业务窗口继承BaseForm即可。

4、剩下的内容就是如何在主窗体MainForm中展示相关的业务窗口了，展示的代码如下所示

1.     public partial class MainForm : Form
   
2.     {
   
3.         #region 属性字段
   
4. 
   
5.         private MainToolWindow mainToolWin = new MainToolWindow();
   
6.         private FrmProduct frmProduct = new FrmProduct();
   
7.         private FrmCustomer frmCustomer = new FrmCustomer();
   
8.         private FrmOrder frmOrder = new FrmOrder();
   
9.         private FrmStock frmStock = new FrmStock();
   
10.         private FrmComingCall frmComingCall = new FrmComingCall();
    
11.         private FrmDeliving frmDeliving = new FrmDeliving();
    
12.         private FrmTicketHistory frmHistory = new FrmTicketHistory(); 
    
13. 
    
14.         #endregion
    
15. 
    
16.         public MainForm()
    
17.         {
    
18.             InitializeComponent();
    
19. 
    
20.             SplashScreen.Splasher.Status = "正在展示相关的内容";
    
21.             System.Threading.Thread.Sleep(100);
    
22. 
    
23.             mainToolWin.Show(this.dockPanel, DockState.DockLeft);
    
24.             frmComingCall.Show(this.dockPanel);
    
25.             frmDeliving.Show(this.dockPanel);
    
26.             frmHistory.Show(this.dockPanel);
    
27.             frmStock.Show(this.dockPanel);
    
28.             frmProduct.Show(this.dockPanel);
    
29.             frmCustomer.Show(this.dockPanel);
    
30.             frmOrder.Show(this.dockPanel);
    
31. 
    
32.             SplashScreen.Splasher.Status = "初始化完毕";
    
33.             System.Threading.Thread.Sleep(50);
    
34. 
    
35.             SplashScreen.Splasher.Close();
    
36.         }
    

复制代码

5.下面贴出基本窗口的基本操作事件函数

1.         private void menu_Window_CloseAll_Click(object sender, EventArgs e)
   
2.         {
   
3.             CloseAllDocuments();
   
4.         }
   
5. 
   
6.         private void menu_Window_CloseOther_Click(object sender, EventArgs e)
   
7.         {
   
8.             if (dockPanel.DocumentStyle == DocumentStyle.SystemMdi)
   
9.             {
   
10.                 Form activeMdi = ActiveMdiChild;
    
11.                 foreach (Form form in MdiChildren)
    
12.                 {
    
13.                     if (form != activeMdi)
    
14.                     {
    
15.                         form.Close();
    
16.                     }
    
17.                 }
    
18.             }
    
19.             else
    
20.             {
    
21.                 foreach (IDockContent document in dockPanel.DocumentsToArray())
    
22.                 {
    
23.                     if (!document.DockHandler.IsActivated)
    
24.                     {
    
25.                         document.DockHandler.Close();
    
26.                     }
    
27.                 }
    
28.             }
    
29.         }
    
30. 
    
31.         private DockContent FindDocument(string text)
    
32.         {
    
33.             if (dockPanel.DocumentStyle == DocumentStyle.SystemMdi)
    
34.             {
    
35.                 foreach (Form form in MdiChildren)
    
36.                 {
    
37.                     if (form.Text == text)
    
38.                     {
    
39.                         return form as DockContent;
    
40.                     }
    
41.                 }
    
42. 
    
43.                 return null;
    
44.             }
    
45.             else
    
46.             {
    
47.                 foreach (DockContent content in dockPanel.Documents)
    
48.                 {
    
49.                     if (content.DockHandler.TabText == text)
    
50.                     {
    
51.                         return content;
    
52.                     }
    
53.                 }
    
54. 
    
55.                 return null;
    
56.             }
    
57.         }
    
58. 
    
59.         public DockContent ShowContent(string caption, Type formType)
    
60.         {
    
61.             DockContent frm = FindDocument(caption);
    
62.             if (frm == null)
    
63.             {
    
64.                 frm = ChildWinManagement.LoadMdiForm(Portal.gc.MainDialog, formType) as DockContent;
    
65.             }
    
66. 
    
67.             frm.Show(this.dockPanel);
    
68.             frm.BringToFront();
    
69.             return frm;
    
70.         }
    
71. 
    
72.         public void CloseAllDocuments()
    
73.         {
    
74.             if (dockPanel.DocumentStyle == DocumentStyle.SystemMdi)
    
75.             {
    
76.                 foreach (Form form in MdiChildren)
    
77.                 {
    
78.                     form.Close();
    
79.                 }
    
80.             }
    
81.             else
    
82.             {
    
83.                 IDockContent[] documents = dockPanel.DocumentsToArray();
    
84.                 foreach (IDockContent content in documents)
    
85.                 {
    
86.                     content.DockHandler.Close();
    
87.                 }
    
88.             }
    
89.         }
    

复制代码