本篇介绍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中展示相关的业务窗口了,展示的代码如下所示
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();
}
5.下面贴出基本窗口的基本操作事件函数
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();
}
}
}
1.多文档界面(MDI)
DockPanel Suite的主窗体类似于WinForm中开发MDI应用程序的父窗体,父窗体容纳了所有的停靠窗体,停靠窗体类似于MDI中的子窗体。
红色区域是一个Panel,继承于WeifenLuo.WinFormsUI.Docking.DockPanel,所有的子窗体必须停靠、悬浮、隐藏在该Panel中。因为是基于MDI的应用,所以父窗体属性IsMdiContainer必须设置为true。另外,子窗体都继承于WeifenLuo.WinFormsUI.Docking.DockContent,这样才能停靠在父窗体中。
2.DockState
DockPanel Suite中的DockSate是一个非常重要的属性:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 |
|
代码中的注释表示的是子窗体停靠父窗体的位置。在继承于DockContent的子窗体中有一个属性ShowHint可以初始化子窗体在显示的时候停靠的方位。
测试效果如下:
DockPanel Suite中提供了一个相应的DockStateChanged来监测子窗体的DockState变化。
3.DockPane及DockAlignment
停靠窗体也可以选择停靠面板(DockPane)来停靠,停靠面板是一个停靠窗体中内置的面板(pane),该面板是一个UserControl,方法如下:
1 |
|
其中参数DockAlignment枚举如下:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 |
|
参数proportion指的是相对停靠面板的占据位置的百分比:
图中红色区域为Form0内置面板区域,该区域下方距离停靠面板百分比为0.4。
4.DockArea
停靠窗体存在一个停靠区域,其属性为DockArea,与DockState比较相似,为枚举类型:
1 2 3 4 5 6 7 8 9 10 11 12 |
|
通常在停靠窗体初始化时可以设置其停靠区域,限制其拖动的区域位置。需要注意的是当DockState为DockLeft |DockRight |DockTop |DockBottom |Float |Document 时,对其相应DockAreas设置的DockLeft |DockRight |DockTop |DockBottom |Float |Document 无效。例如,当DockState为DockRight 时,对DockAreas设置区域DockRight 无效,会抛出异常,在我的测试代码中作了一个扩展,来避免不必要的异常(异常信息为:Invalid Value: The value of DockAreas conflicts with current DockState):
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 |
|
5.DocumentStyle
可以设置DockPanel容器DocumentStyle来改变停靠窗体的风格,DocumentStyle枚举类型如下:
1 2 3 4 5 6 7 |
|
默认值为DockingMdi,个人觉得这几种窗体风格的样式相差无几。
6.其他
在DockPanel Suite源代码自带的实例中,还有一些常用功能如下:
- 关闭激活的停靠窗体、关闭所有停靠窗体
- 停靠状体的布局保存与加载(代码与XML两种方式);可以事先使用代码构建整个应用程序的界面布局,然后在应用程序退出的时将布局保存到xml,以后就以该xml作为标准的
界面布局文件 - 停靠窗体换肤
- 补充一点,关于DockState为非Document的停靠窗体如果需要设置其右键快捷菜单的话可以设置DockContent类中属性TabPageContextMenuStrip为其自己定义的ContextMenu,
效果如下:
来源:oschina
链接:https://my.oschina.net/u/4412037/blog/4375284