C#学习笔记——窗口停靠控件WeifenLuo.WinFormsUI.Docking使用

C#学习笔记——窗⼝停靠控件WeifenLuo.WinFormsUI.Docking
使⽤
⼀、介绍
DockPanelSuite是托管在GitHub上的⼀个开源项⽬，使⽤在WinForms上，是⼀个简单、美观的界⾯组件。

其中
weiFenLuo.winFormsUI.Docking.dll较为⼈熟知，它是DockPanel Suite的⼀个类库，可以实现类似VS的窗⼝停靠、悬浮、⾃动隐藏等功能，同时能够保存窗体布局为XML⽂件,启动时加载XML配置⽂件还原布局。

DockPanelSuite还包含有多种VS主题，能够⾃由切换变换风格。

DockPanelSuite官⽹：
GitHub上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 = bine(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)))));。