专栏首页c#学习笔记C#学习笔记——窗口停靠控件WeifenLuo.WinFormsUI.Docking使用

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

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • C#学习笔记——chart控件使用笔记总结

        //设置横纵坐标轴在没有曲线数据时也可显示    axTChart.ChartAreas[0].AxisX.Enabled = AxisEn...

    vv彭
  • WinForm企业级框架实战项目演练

    跟着阿笨一起玩NET
  • 【V-REP自学笔记(二)】软件入门

    在这一系列的V-REP自学笔记中,我们定了一个小目标,完成一个Demo。使用官方提供的KUKA公司的YouBot机器人模型来实验机器人的感知和控制过程,控制机器...

    博士的沙漏
  • TCP/IP协议学习笔记

    计算机网络基础知识复习汇总:计算机网络基础知识复习 HTTP协议的解析:剖析 HTTP 协议 一个系列的解析文章: TCP/IP详解学习笔记(1)-- 概述 T...

    mukekeheart
  • 从零讲JAVA ,给你一条清晰地学习道路!该学什么就学什么!!

    三哥
  • JAVA试练塔之试炼技能图

    1.计算机基础: 1.1数据机构基础: 主要学习: 1.向量,链表,栈,队列和堆,词典。熟悉 2.树,二叉搜索树。熟悉 3.图,有向图,无向图,基本概念 4.二...

    hbbliyong
  • 一起来学matlab-matlab学习笔记1--matlab工作界面

    本文为matlab自学笔记的一部分,之所以学习matlab是因为其真的是人工智能无论是神经网络还是智能计算中日常使用的,非常重要的软件。也许最近其带来的一些负面...

    演化计算与人工智能
  • 计算机网络:这是一份全面 & 详细 的TCP协议学习指南

    对于接收端:当收到数据帧后,将窗口向前移动一个位置,并发回确认帧,若收到的数据帧落在接收窗口之外,则一律丢弃。

    Carson.Ho
  • ROS专题----数据可视化rviz简明笔记

    1 DisplayTypes/Marker:http://wiki.ros.org/rviz/DisplayTypes/Marker

    zhangrelay
  • 从零讲JAVA ,给你一条清晰地学习道路!该学什么就学什么!!

    本文转载java知音

    Rookie
  • 从零讲JAVA ,给你一条清晰地学习道路!该学什么就学什么!!

    主要学习: 1.向量,链表,栈,队列和堆,词典。熟悉 2.树,二叉搜索树。熟悉 3.图,有向图,无向图,基本概念 4.二叉搜索A,B,C类熟练,9大排序熟悉。 ...

    java思维导图
  • 从零讲Java,给你一条清晰地学习道路!该学什么就学什么!

    Spark学习技巧
  • 从零讲Java,给你一条清晰地学习道路!该学什么就学什么!

    主要学习: 1.向量,链表,栈,队列和堆,词典。熟悉 2.树,二叉搜索树。熟悉 3.图,有向图,无向图,基本概念 4.二叉搜索A,B,C类熟练,9大排序熟悉。 ...

    Java团长
  • 从零讲JAVA ,给你一条清晰地学习道路!该学什么就学什么!!

     原文链接:https://zhuanlan.zhihu.com/p/25296859

    黑泽君
  • 如何在远程服务器上运行Jupyter Notebooks?

    Jupyter Notebook是许多数据科学家工具箱中的一个主要工具。作为一个工具,Jupyter Notebook可以通过交互方式简化数据分析、模型建模和实...

    AiTechYun
  • 用Python也能画图?用Python来画个“python”

    Death is so final, whereas life is so full of possibilities。死了可什么都没了,而活着就有无限的可能。...

    小Bob来啦
  • 2019秋招:460道Java后端面试高频题答案版【模块五:计算机网络】

    计算机网络、计算机操作系统这两个“兄弟”是所有开发岗位都需要“结拜”的,不管你是 Java、C++还是测试。对于后端开发的童鞋来说,计算机网络的重要性不亚于语言...

    乔戈里
  • 独家 | 教你使用Keras on Google Colab(免费GPU)微调深度神经网络

    在CPU上训练深度神经网络很困难。本教程将指导您如何使用Google Colaboratory上的Keras微调VGG-16网络,这是一个免费的GPU云平台。如...

    数据派THU
  • pygame-游戏开发学习笔记(二)–模块表与背景图样例。

    if pygame.font is None: print "The font module is not available!" exit()

    我在鹅厂做安全

扫码关注云+社区

领取腾讯云代金券