C#.NET 窗体停靠控件WeifenLuo.WinFormsUI.Docking.dll的使用

源码:https://github.com/dockpanelsuite/dockpanelsuite

https://www.cnblogs.com/wuhuacong/archive/2009/07/09/1520082.html

类库介绍
weiFenLuo.winFormsUI.Docking.dll是开源项目DockPanel Suite的一个类库。是一个很强大的界面布局控件,可以实现像Visual Studio的窗口停靠、拖拽等功能;可以保存自定义的布局为XML文件,可以加载XML配置文件.

该动态库源自开源项目DockPanelSuite,衔接地址是:weifenluo.winformsUI.Docking.dll源代码
可下载其源码、直接使用的dll及示例程序,目前最新版本为2.9.0.0,可在VS2012环境下使用。

Dockpanel中提供了几个可用的类,主要的有两个, 一是DockPanel,另一个是DockContent。DockPanel 是从panel继承出来的, 用于提供可浮动的dock的子窗口,DockContent是从form类中继承出来的, 用于提供可浮动的窗口基类. 就是说: DockContent对象可以在DockPanel对象中任意贴边, 浮动, TAB化等. 

使用说明
主窗体的建立
创建窗体应用程序WeifenLuoUISample,添加引用WeifenLuo.WinFormsUI.Docking.dll
重命名主窗体为MainWnd作为测试主窗口,设置主窗体Mainwnd的IsMdiContainer属性为true
添加dockPanel控件到工具箱中:工具箱—>右键—>选择项—>.net组件—>浏览—>weiFenLuo.winFormsUI.Docking.dll,此时在工具箱将出现dockPanel,将dockPanel拖放到Mainwnd中,设置dockpanel的相关属性:dockPanel.Dock=Fill

停靠窗体的建立
【1】新建一个Windows 窗体Form1,修改窗体继承于WeifenLuo.WinFormsUI.Docking.DockContent:
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
 
namespace WeifenLuoUISample
{
    public partial class Form1 : WeifenLuo.WinFormsUI.Docking.DockContent
    {
        public Form1()
        {
            InitializeComponent();
        }
    }
}


【2】在MainWnd中添加Load事件的响应代码来创建停靠窗口
using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Windows.Forms;
using WeifenLuo.WinFormsUI.Docking;
 
namespace WeifenLuoUISample
{
    public partial class MainWnd : Form
    {
        public MainWnd()
        {
            InitializeComponent();
        }
 
        private void MainWnd_Load(object sender, EventArgs e)
        {
            Form1 form = new Form1();
            form.Show(_dockPanel, DockState.DockLeft);
        }
    }
}

【3】运行效果如下

保存界面布局
【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,保存主窗体启动的位置与尺寸,很简单,这里不再详细介绍。
————————————————
================================================

很酷的效果,很值得好好去学习的哈。

重置工具箱:

新建一个WinForm程序,项目名称为TestDockPanelControl。选中Form1窗体后选择工具箱--->>新建个添加选项卡命名为WeiFenLuo--->>右键--->>选择项--->>浏览---

>>weiFenLuo.winFormsUI.Docking.dll--->>确定.此时工具箱出现DockPanel控件。这以上步骤仅是把DockPanel控件添加到工具箱中。

接下来看看DockPanel控件的停靠效果是如何实现的。

主窗体设置:(Form1窗体默认是主窗体)

Form1窗体的属性设置
在原有的Form1窗体上设置窗体的Text属性为主窗体,IsMdiContainer属性为true也就是设置为MDI程序(为了体验DockPanel控件的演示效果)。FormBorderStyle设置为

FixedSingle,StartPosition设置为CenterScreen,WindowState设置为Maximized。

Form1窗体的控件布局
将工具箱下的MenuStrip控件和DockPanel控件拖放到窗体上,设置DockPanel控件的Dock属性为Fill.设置MenuStrip的子菜单选项设置值如下图所示:

停靠窗体设置(FormDock为子窗体):

添加一个新的WinForm窗体命名为FormDock,设置Text值为停靠窗体,Size值为207,382此处值可以根据实际的需要情况而定并非唯一。

主要点:在代码中修改窗体继承于DockContent,要添加using WeifenLuo.WinFormsUI.Docking命名空间
修改前是

复制代码

 

public partial class FormDock :Form
{
public FormDock()
{
InitializeComponent();
}
}

复制代码

修改后:

复制代码

 

public partial class FormDock :DockContent
{
public FormDock()
{
InitializeComponent();
}
}

复制代码

回到主窗体Form1窗体,在Form1窗体中显示要停靠的窗体(FormDock)
代码如下:

复制代码

 

//底部
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);
}

复制代码

以上的就是用DockPanel控件来使窗体进行停靠的整个操作。

效果图如下所示:

DockPanel控件还可以拖放子窗体,可以把子窗体拖放到上左中右下等位置
只要把DockPanel控件的的AllowDrop设置为true就可以了。效果图如下所示;

====================================================

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中展示相关的业务窗口了,展示的代码如下所示

复制代码

    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();
                }
            }
        } 

复制代码

最后呈上该控件文件,大家可以下来玩玩。

http://files.cnblogs.com/wuhuacong/WeifenLuo.WinFormsUI.Docking.rar

发布了42 篇原创文章 · 获赞 6 · 访问量 2万+

猜你喜欢

转载自blog.csdn.net/u014090257/article/details/102409824
今日推荐