使用DotNetBar制作漂亮的WinFrom界面，自定义AgileEAS.NET SOA平台WinClient主界面

一、前言

     AgileEAS.NET SOA 中间件平台是一款基于基于敏捷并行开发思想和Microsoft .Net构件(组件)开发技术而构建的一个快速开发应用平台。用于帮助中小型软件企业建立一条适合市场快速变化的开发团队，以达到节省开发成本、缩短开发时间，快速适应市场变化的目的。

     AgileEAS.NET SOA中间件平台提供了敏捷快速开发软件工程的最佳实践，通过提供大量的基础支撑功能如IOC、ORM、SOA、分布式体系及敏捷并发开发方法所支撑的插件开发体系，以及提供了大量的实体、数据模型设计生成工具、代码生成工具，用于帮助中小软件开发商快速成长。

     AgileEAS.NET平台充分把握目前软件行业快速发展的新趋势，基于敏捷并行开发、快速适应市场这样淳朴的软件工程实践，采用业界广泛使用的Microsoft .Net构件(组件)开发技术实践了这种开发思想，帮助软件企业实现“敏捷变化、快速适合”的目标，从而帮助软件企业在激烈的市场竞争中赢得先机并获得更高的回报。

二、关于WinClient的外挂资源体系介绍

     最初版本的AgileEAS.NET SOA中间件平台的运行容器/外壳是没有界面替换体系，最初只是提供了替换关键部分的图片、文字的功能，随着AgileEAS.NET SOA中间件被众多的客户应用到各行各业之后，我们从客户的应用反馈之中进行了大量的重构，其中运行容器也越来越开放，从最初令开放替换部分图片到慢慢开放可以自由修改其他的导航栏、Banner、状态栏、菜单、登录界面、关于界面，发生了很大的变化，同步我们也提供了Desktop、MDI、Dockable等多种界面风格，可以说客户有更我的选择了。

     随着更多软件企业或组织加入应用AgileEAS.NET SOA中间件行业，有许多的客户已经不能满足于在这几种风格之中进行选择，希望能给自己最大的自定义空间和范围，提供了更换主界面的需求，我们积极的响应这种需求，并且提出了相关的解决方案，并且在2012年AgileEAS.NET SOA 5.0版本的时间向大家提供。

     主界面替换被某一些我们服务于的客户所使用，但是对于广大的关心AgileEAS.NET SOA中间件的朋友来说，并不能得到我们细致并且一对一的服务，因为我们还没有变此部分内容给大家做过介绍和在公开的案例之中提供，所以对于社区之中的很多朋友来说，还能灵活的应用本部分内容。

     下图是一个典型的AgileEAS.NET SOA中间件平台WinClient容器的主界面：

     其中包含以下组成部分：

 

     主菜单：界面最上部的主菜单，系统、视图和帮助。

     导航菜单：通过菜单之中的菜单项可以打开指点的功能模块。

     导航栏：同系统导航菜单、以树形或者其他形式展示。

     状态栏：显示系统的一些状态信息，如操作消息、当前登录信息等。
     内容区：除以上项目外的界面空白区域为业务工作区，即模块插件的工作区域，新打开的模块在经区域显示和工作。

     启始页：特指工作区之中第一个打开的模块，当系统登录完成之后会自动打开一个模块，此模块称为起始页模块。

三、IResource接口

     AgileEAS.NET SOA 中间件平台为了应用对运行容器的各个部分进行自定义和扩展，提供了一个资源接口IResource:

using System;

namespace EAS.Explorer
{
    /// <summary>
    /// 运行容器的外壳资源。
    /// </summary>
    public interface IResource
    {
        /// <summary>
        /// 获取应用系统的图标，用于替换主界面的图标。
        /// </summary>
        System.Drawing.Icon GetMainIcon();

        /// <summary>
        /// 获取默认的模块图标，用于简约、经典风格的Tab页图标显示，也用于Desktop模式的桌面图标显示。
        /// </summary>
        System.Drawing.Image GetModuleIcon();

        /// <summary>
        /// 获取桌面背景图像，用于Desktop模式的桌面模块。
        /// </summary>
        System.Drawing.Image GetDesktopImage();

        /// <summary>
        /// 获取应用系统的导航控件，用于替换平台的导航控件。
        /// </summary>
        /// <returns>WinForm/WPF用户控件。</returns>
        object GetNavigationControl();

        /// <summary>
        /// 获取应用系统的Banner控件，用于替换平台的Banner条。
        /// </summary>
        /// <returns>WinForm/WPF用户控件。</returns>
        object GetBannerControl();

        /// <summary>
        /// 获取应用系统的Bottom控件，用于替换平台的状态栏。
        /// </summary>
        /// <returns>WinForm/WPF用户控件。</returns>
        object GetBottomControl();

         /// <summary>
        /// 获取WinForm/WPF容器的关于对话框，用于替换平台的关于对话框。
        /// </summary>
        /// <returns>WinForm/WPF窗体。</returns>
        object GetAboutForm();

        /// <summary>
        /// 获取WinForm/WPF容器的主界面，用于替换平台的主界面。
        /// </summary>
        /// <returns>WinForm/WPF窗体。</returns>
        object GetMainShell();

        /// <summary>
        /// 获取WinForm/WPF/Silverlight容器的登录对话框，用于替换平台的登录对话框。
        /// </summary>
        /// <returns>WinForm/WPF/Silverlight窗体。</returns>
        ILoginForm GetLoginForm();

        /// <summary>
        /// 获取WinForm/WPF容器的起始页/初始模块，用于替换平台的起始页。
        /// </summary>
        /// <returns>WinForm/WPF用户控件。</returns>
        object GetStartModule();

        /// <summary>
        /// 获取系统的名称，显示在运行环境的导航栏。
        /// </summary>
        /// <returns>应用系统名称。</returns>
        string GetApplicationName();

        /// <summary>
        /// 获取系统的标题，显示在运行环境的主窗口之上。
        /// </summary>
        /// <returns>应用系统名称。</returns>
        string GetApplicationTitle();

        /// <summary>
        /// 是否显示主菜单。
        /// </summary>
        bool DisplayMainMenu
        {
            get;
        }

        /// <summary>
        /// 是否显示导航工具条。
        /// </summary>
        bool DisplayNavigationTool
        {
            get;
        }
    }
}

     实现AgileEAS.NET SOA 平台的资源替换即是实现IResource接口的过程，在我们DrugShop、SmartERP案例之中都有对应的实现项目DrugShop.Res和SmartERP.Res。

     当然，光实现IResource还不购，还需要修改系统的配置文件，以便让资源生效：

<;!--资源-->
<object name="EAS.Explorer.Resource" assembly="DrugShop.Res" type="DrugShop.Res.Resources" LifestyleType="Singleton"/>

     需要注意的是在EAS.Explorer.dll程序集之中还定义了以下两个接口，INavigation接口：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Text.RegularExpressions;

namespace EAS.Explorer
{
    /// <;summary>
    /// 导航控件接口。
    /// <;/summary>
    public interface INavigation
    {
        /// <;summary>
        /// 初始化导航。
        /// <;/summary>
        /// <;param name="m_GroupList">导航清单。</param>
        /// <;param name="m_ModuleList">模块清单。</param>
        void Initialize(IList<;INavigateGroup> m_GroupList, IList<INavigateModule> m_ModuleList);
    }
}

     ILoginForm接口：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace EAS.Explorer
{
    /// <;summary>
    ///  定义登记对话框接口,用于实现自定义登录。
    /// <;/summary>
    public interface ILoginForm
    {
        /// <;summary>
        /// 是否已经通过登录验证。
        /// <;/summary>
        bool Passed { get; }
    }
}

     自定义的导航控件必须实现INavigation接口，以便于平台实现导航的初始化，方法Initialize由平台调用，传入当前系统登录人员所具有权限的模块清单及相关的导航清单。

     自定我的登录界面必须实现ILoginForm，以便于系统判定登录界面是否完成了登录验证。

四、IMainShell接口和自定义主界面

     第三节在介绍IResource接口的时候我们会发现其他有一个GetMainShell()方法，其用于获取资源实现之中的主界面定义，系统主界面必须是一个Form并且要实现IMainShell接口：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace EAS.Explorer
{
    /// <;summary>
    /// 定义主界面接口,用于实现自定义主界面。
    /// <;/summary>
    public interface IMainShell
    {
        /// <;summary>
        /// 初始化主界面，根据平台传入的模块清单和相关的导航分组初始化主界面。
        /// <;/summary>
        /// <;param name="m_GroupList">导航清单。</param>
        /// <;param name="m_ModuleList">模块清单。</param>
        void InitializeShell(IList<;INavigateGroup> m_GroupList, IList<INavigateModule> m_ModuleList);

        /// <;summary>
        /// 加载/打开指定模块，响应系统的模块打开操作。
        /// <;/summary>
        /// <;param name="module">模块实例。</param>
        void OpenModule(object module);

        /// <summary>
        /// 关闭当前模块(活动的模块)。
        /// <;/summary>
        void CloseModule();

        /// <summary>
        /// 关闭指定模块。
        /// <;/summary>
        /// <;param name="module">模块实例。</param>
        void CloseModule(object module);

        /// <summary>
        /// 切换导航，展开、隐藏导航，主界面没有导航的隐藏、展开需求可以不处理。
        /// <;/summary>
        void SwitchNavigation();

        /// <summary>
        /// 当前活动插件/模块。
        /// <;/summary>
        object ActiveAddIn
        {
            get;
        }

        /// <;summary>
        /// 已打开的插件/模块集合。
        /// <;/summary>
        List<;object> AddIns
        {
            get;
        }
    }
}

     其中InitializeShell方法：用于平台传入当前系统登录人员所具有权限的模块清单及相关的导航清单，由自定义界面实现界面的初始化。

     OpenModule方法：用于实现对模块的打开，平台传入要打开的模块，由主界面进行处理，实现主界面对模块的动态加载。

     CloseModule方法：用于关闭已经打开的模块，并对界面进行清理。

     SwitchNavigation方法：切换导航，展开、隐藏导航，主界面没有导航的隐藏、展开需求可以不处理。

     ActiveAddIn属性：向平台返回当前的活动模块。

     AddIns属性：向平台返回已加载的模块清单。

四、自定义界面实例

     近期 有朋友建议使用devcomponents或者DotNetBar为大家演示一下如何自定义平台的主体界面，参考了网有对devcomponents和DotNetBar相关的资料之后我们选择了较为轻量级的DotNetBar为大家演示如何替换系统的主界面。

     我们使用DotNetBar所提供的一些控件实现了以下三种风格的主体界面：

     第一种是Win7/Ribbon风格的主界面RibbonShell，如下图所示：

     其对应代码为DrugShop案例之中的DrugShop.Res项目之中的RibbonShell.cs程序文件。

     第二种为类似Visual Studio界面风格的DockableShell，其效果如下：

     其对应代码为DrugShop案例之中的DrugShop.Res项目之中的DockableShell.cs程序文件。

     第三种为不包含导航栏的简单MDI界面风格的TabShell，其效果如下：

     其对应代码为DrugShop案例之中的DrugShop.Res项目之中的TabShell.cs程序文件。

五、关于代码

     以上介绍了三种风格的自定义主界面的例子，例子不多，也不复杂，或许也不能满足所有人的美观度需求和功能需求，其目的在于抛砖引用，希望借此文让更多的开发者加入到我们的行列之中来，做出更加美观大方的界面。

     关于以上三种风格自定义界面代码，我们已经合并到DrugShop案例和SmartEPR案例之中，请大家在AgileEAS.NET SOA中间件官方网站的最新下载栏目进行下载。

     在启动自定义界面的过程之中切记要修改资源项目之中IResource的实现代码之中的GetMainShell方法代码：

public object GetMainShell()
{
    return new RibbonShell(); //Ribbon风格自定义界面。
    //return new DockableShell(); //Dockable风格自定义界面。
    //return new TabShell(); //TabMdi风格自定义界面。
    //return null; //使用AgileEAS.NET SOA平台自带界面。
}

    本文所使用的是DotNetBar115版本，有关于DotNetBar115请通过http://42.121.30.77/downloads/DotNetBar115.rar下载。

六、联系我们

     为完善、改进和推广AgileEAS.NET而成立了敏捷软件工程实验室，是一家研究、推广和发展新技术，并致力于提供具有自主知识产权的业务基础平台软件，以及基于业务基础平台开发的管理软件的专业软件提供商。主要业务是为客户提供软件企业研发管理解决方案、企业管理软件开发，以及相关的技术支持，管理及技术咨询与培训业务。

     AgileEAS.NET SOA中间件平台自2004年秋呱呱落地一来，我就一直在逐步完善和改进，也被应用于保险、医疗、电子商务、房地产、铁路、教育等多个应用，但一直都是以我个人在推广，2010年因为我辞职休息，我就想到把AgileEAS.NET推向市场，让更多的人使用。

     我的技术团队成员都是合作多年的老朋友，因为这个平台是免费的，所以也没有什么收入，都是由程序员的那种理想与信念坚持，在此我感谢一起奋斗的朋友。

团队网站：http://www.agilelab.cn

AgileEAS.NET网站：http://www.agileeas.net

官方博客:http://eastjade.cnblogs.com

github:https://github.com/agilelab/eas

QQ:47920381

QQ群：113723486（AgileEAS SOA 平台）/上限1000人

199463175（AgileEAS SOA 交流）/上限1000人

212867943（AgileEAS.NET研究）/上限500人

147168308（AgileEAS.NET应用）/上限500人

172060626（深度AgileEAS.NET平台）/上限500人

116773358（AgileEAS.NET 平台）/上限500人

125643764（AgileEAS.NET探讨）/上限500人

193486983（AgileEAS.NET 平台）/上限500人

邮件:james@agilelab.cn,mail.james@qq.com,

电话：18629261335。