听了曹严明先生的《组合型智能客户端应用 With Composite Application Block》的讲座后,对CAB有了一个初步的理解,同时感觉CAB将大有用武之地。于是,本人从微软网站http://practices.gotdotnet.com/projects/cab下载了源代码,开始研究。
这个学习笔记将主要讲述CAB中Commands的应用,以及一些本人的疑惑,期望园子里的朋友予以指点。
一、何谓Commands.
Commands是CAB程序集里一个重要的对象,它主要用来关联控件、WorkSpace和业务逻辑,也就是让一个命令可以被多个控件的事件引发。
一般的情况下可以通过以下代码关联一个命令和控件的事件:
Commands[strCommandName].AddInvoker(objControl, strEventName);
二、建立测试Commands的程序
1.打开VS2005,新建Windows Application项目。
2.添加以下引用
- Microsoft.Practices.CompositeUI;
- Microsoft.Practices.CompositeUI.WinForms;
- Microsoft.Practices.ObjectBuilder
3.此时VS将自动产生program.cs,Form1.cs。将Form1.cs命名为TestForm。
4.给TestForm加入菜单。命名为menuStrip1。依次加入菜单子项,名称如下:
- AddNew
- SaveFileTool
- DeleteFile
5.重命名program.cs为CommandsApplication.cs,并且将内容修改成以下形式:
using System;
using System.Collections.Generic;
using System.Windows.Forms;
using Microsoft.Practices.CompositeUI;
using Microsoft.Practices.CompositeUI.Commands;
using Microsoft.Practices.CompositeUI.WinForms;
using Microsoft.Practices.CompositeUI.UIElements;
class CommandsApplication : FormShellApplication<MainWorkItem, TestForm>


{

/**//// <summary>
/// The main entry point for the application.
/// </summary>
[STAThread]
public static void Main()


{
new CommandsApplication().Run();
}
}
修改时要注意将static class 修改成 class,否则无法通过编译,提示类似错误1所示的错误信息
Static class 'TestUIBlock.CommandsApplication' cannot derive from type 'Microsoft.Practices.CompositeUI.WinForms.
FormShellApplication<TestUIBlock.MainWorkItem,TestUIBlock.TestForm>'.
Static classes must derive from object.CommandsApplication.cs 13 40 TestUIBlock。
如果将static class 修改成 public class,也会无法通过编译,提示类似错误2的信息:
Inconsistent accessibility: base class 'Microsoft.Practices.CompositeUI.WinForms.
FormShellApplication<TestUIBlock.MainWorkItem,TestUIBlock.TestForm>'
is less accessible than class 'TestUIBlock.CommandsApplication' E:\WorkSpace\Projects\TestUIBlock\TestUIBlock\TestUIBlock\CommandsApplication.cs 13 18 TestUIBlock。
错误1很好理解,就是静态的类无法从类型继承,但是错误2就让我有些费解,在CAB的Quick Start中就是这样写的。和我新建立的不同区别是,我是通过引用dll来添加引用的,Quick Start是直接引用解决方案中的项目。查阅MSDN帮助对Inconsistent accessibility的解释,好像也不能解释我遇到的这个问题。
还有就是要将static void Main()修改成 public static void Main(),同时删除VS2005默认生成的代码。
6.建立Controller,也就是命令。通常业务行为都放到这个类里。
新建类MainControler文件,将类MainControler从Controller继承。
编写过程,并且以属性[CommandHandler(strKey)]进行修饰,其中strKey是Commands集合中注册的命令关键字。示例过程写法如下:
[CommandHandler("AddNew")]
public void AddNewFileHandler(object sender, EventArgs e)


{
MessageBox.Show("You Had Added A File");
}
7.建立WorkItem。
新建类MainWorkItem,并且从WorkItem继承。
重载Run()方法,代码如下所示:
using System;
using System.Windows.Forms;
using System.Collections.Generic;
using Microsoft.Practices.CompositeUI;
using Microsoft.Practices.CompositeUI.UIElements;
using Microsoft.Practices.CompositeUI.WinForms;
using Microsoft.Practices.ObjectBuilder;
using System.Text;
namespace TestUIBlock


{
class MainWorkItem:WorkItem

{
public override void Run()

{
Items.AddNew<MainControler>();
Activate();}
}
}
}
在Quick Start中是将通过XML文件,将菜单项记录下来,和Commands集合映射,然后动态加载到主菜单上的。由于我们已经在TestForm中创建了菜单项,所以可以去掉动态加载到主菜单的操作,但是和Commands集合映射是必不可少的。可是在MainWorkItem中我不知道如何访问TestForm实例,去获取每一个菜单项(哪位大哥知道的话,请告诉我),于是我只好将映射到Commands部分的代码放到CommandsApplication中。
8.建立菜单项到Commands的映射。
建立方法ProcessCommandMap(IUIElementService uiService):
private void ProcessCommandMap(IUIElementService uiService)


{
foreach (ToolStripMenuItem item in ((ToolStripMenuItem)Shell.MainMenuStrip.Items["FileMenue"]).DropDownItems)


{
this.RootWorkItem.Commands[item.Name].AddInvoker(item, "Click");
}
这里是通过菜单项的名称和命令的名称进行映射的。我们也可以将多个控件的事件映射到同一个命令如:
Button btn1 = new Button();
btn1.Text = "test";
btn1.Name = "btn1";
Panel panel1 = (Panel)Shell.Controls["panel1"];
panel1.Controls.Add(btn1);
this.RootWorkItem.Commands["AddNew"].AddInvoker(btn1, "Click");
不知道看过Commands QuikStart的朋友发现没有,通过Service的RegisterUIExtensionSite方法注册菜单的根后,就可以直接通过Service的Add方法将子菜单添加到父菜单。如以下代码: