制作自定义工作流(WWF)设计器

注:

l         这是一篇翻译,来自http://msdn2.microsoft.com/en-us/library/aa480213.aspx

l         对于一些细节我没有完全翻译

l         增加了一些我的注释,在“[]”里面

l         主要是给朋友们介绍一下这方面的情况

Vihang Dalal
Software Development Engineer Test
Microsoft Corporation<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />

May 2006

应用于:
   Windows Workflow Foundation beta 2.2
   Microsoft Visual C# Version 2.0
   Visual Studio 2005

demo下载:Download the code sample, WorkflowDesignerControl.exe.

 

 

摘要:如果你在vs2005里面安装了Visual Studio 2005 extensions for Windows Workflow Foundation,你就可以使用WWF的可视化编辑器了。这篇文章就是介绍如何在自己的程序中使用这个设计器的一些方法。并且附带有一个简单的例子程序[注:确实可以使用,默认顺序工作流,可以在程序中修改实现。]

 

主要内容包括

l         自定义设计器的介绍

l         自定义设计器的类

l         主要功能和自定义的服务(Services)

l         结论

l         更多资源

 

自定义设计器的介绍:

这篇文章主要讲述了如何使用设计器的api,以及其他扩展。

我们为什么会用到自定义设计器?

l         自定义自己的视图,可以增加/减少一些实现

l         在现有的程序中加入自己的设计器

l         [我用的Web Developer 2005 Express,所以我无法安装WWF设计器,只能用这个了]

什么时候用到这个设计器?

l         设计时:可以创建、编辑工作流

l         运行时:可以跟踪工作流状态

这里提供的例子程序可以独立于vs2005开发工具之外单独运行

 

自定义设计器的类

主要包括:DesignSurface, WorkflowView, and WorkflowDesignerLoader

DesignSurface使用WorkflowDesignerLoader来创建活动(Activety)树和其他组建的树;WorkflowView则用来显示工作流实例(一个xml文件)的默认视图.

 

DesignSurface提供一个环境(self-contained)来显示设计器组件

WorkflowDesignerLoader可以用来加载(PerformLoad())和卸载(PerformFlush())一个工作流的定义。开发者可以使用者个类来自定义工作流保存的方式,可以序列化到自己的媒介中(数据库

WorkflowView是用来显示一个具体的工作流实例的。他借助DesignSurface来显示其中activety的信息。同时他也提供很多用于显示时的控制事件(OnLayout() and OnPaint()),还提供诸如SaveWorkflowAsImage()之类的函数。

 

下边这段代码可以用来制作一个简单的winform的设计器

创建自定义WorkflowDesignerLoader:(重写PerformLoad() and PerformFlush()

制作自定义工作流(WWF)设计器·                           internal sealed class WorkflowLoader : WorkflowDesignerLoader
制作自定义工作流(WWF)设计器制作自定义工作流(WWF)设计器·                           
制作自定义工作流(WWF)设计器{
制作自定义工作流(WWF)设计器·                              
protected override void PerformLoad(IDesignerSerializationManager serializationManager)
制作自定义工作流(WWF)设计器制作自定义工作流(WWF)设计器·                                 
制作自定义工作流(WWF)设计器{
制作自定义工作流(WWF)设计器·                                    
base.PerformLoad(serializationManager);
制作自定义工作流(WWF)设计器·                                    
// Implement the logic to read from the serialized state,
制作自定义工作流(WWF)设计器
·                                    // create the activity tree and the corresponding designer
制作自定义工作流(WWF)设计器
·                                    // tree and add it to the designer host
制作自定义工作流(WWF)设计器
·                                 }

制作自定义工作流(WWF)设计器·                            
制作自定义工作流(WWF)设计器·                              
protected override void PerformFlush(IDesignerSerializationManager manager)
制作自定义工作流(WWF)设计器制作自定义工作流(WWF)设计器·                                 
制作自定义工作流(WWF)设计器{
制作自定义工作流(WWF)设计器·                                    
// Implement the logic to save the activity tree to a
制作自定义工作流(WWF)设计器
·                                    // serialized state along with any code beside elements 
制作自定义工作流(WWF)设计器
·                                 }

制作自定义工作流(WWF)设计器·                           }

制作自定义工作流(WWF)设计器



加载工作流,显示

制作自定义工作流(WWF)设计器·                           // Create new Design surface and loader (created as shown above)
制作自定义工作流(WWF)设计器
·                            
制作自定义工作流(WWF)设计器·                           DesignSurface designSurface 
= new DesignSurface();
制作自定义工作流(WWF)设计器·                           WorkflowLoader loader 
= new WorkflowLoader();
制作自定义工作流(WWF)设计器·                            
制作自定义工作流(WWF)设计器·                           
// load the design surface using the loader. This will call the
制作自定义工作流(WWF)设计器
·                           // PerformLoad method on the loader, create the activity tree and
制作自定义工作流(WWF)设计器
·                           // add the corresponding designer components to the designer host
制作自定义工作流(WWF)设计器
·                            
制作自定义工作流(WWF)设计器·                           designSurface.BeginLoad(loader);
制作自定义工作流(WWF)设计器·                            
制作自定义工作流(WWF)设计器·                           
// Get the designer host and retrieve the corresponding root component
制作自定义工作流(WWF)设计器
·                           IDesignerHost designerHost = designSurface.GetService(typeof(IDesignerHost)) as IDesignerHost;
制作自定义工作流(WWF)设计器·                           
if (designerHost != null && designerHost.RootComponent != null)
制作自定义工作流(WWF)设计器制作自定义工作流(WWF)设计器·                           
制作自定义工作流(WWF)设计器{
制作自定义工作流(WWF)设计器·                              
// Get the designer associated with the root component
制作自定义工作流(WWF)设计器
·                              IRootDesigner rootDesigner =    designerHost.GetDesigner(designerHost.RootComponent) as IRootDesigner;
制作自定义工作流(WWF)设计器·                              
if (rootDesigner != null)
制作自定义工作流(WWF)设计器制作自定义工作流(WWF)设计器·                              
制作自定义工作流(WWF)设计器{
制作自定义工作流(WWF)设计器·                                 
this.designSurface = designSurface;
制作自定义工作流(WWF)设计器·                                 
this.loader = loader;
制作自定义工作流(WWF)设计器·                              
制作自定义工作流(WWF)设计器·                                    
// Assign the default view of the rootdesigner to WorkflowView
制作自定义工作流(WWF)设计器
·                                    this.workflowView = rootDesigner.GetView(ViewTechnology.Default) as          WorkflowView;
制作自定义工作流(WWF)设计器·                            
制作自定义工作流(WWF)设计器·                                    
// Add the workflow view control to winforms app
制作自定义工作流(WWF)设计器
·                                    this.workflowViewSplitter.Panel1.Controls.Add(this.workflowView);
制作自定义工作流(WWF)设计器·                                    
this.workflowView.Focus();
制作自定义工作流(WWF)设计器·                                    
this.propertyGrid.Site = designerHost.RootComponent.Site;
制作自定义工作流(WWF)设计器·                              }

制作自定义工作流(WWF)设计器·                            }

制作自定义工作流(WWF)设计器

 

还需要一个DesignerHost类,用来装载各种服务,和向外提供各类服务接口。

http://msdn2.microsoft.com/en-us/library/Aa480213.wfdsgnrehst02(en-us,MSDN.10).gif

 制作自定义工作流(WWF)设计器

主要功能和自定义的服务(Services)

System.Workflow.ComponentModel提供了一些默认类的实现,比方说“IIdentifierCreationService, IReferenceService, IworkflowCompilerOptionsService”等。但是如果要自定义设计器,可能需要你客户化自己的实现类(Service

1:上下文菜单和通用设计器的功能(Context Menu And Common Designer Features:);

   菜单WorkflowMenuCommandService继承自MenuCommandService,用来显示菜单命令。这些代码用来增加一些额外的命令菜单

制作自定义工作流(WWF)设计器·               // Create a new context menu
制作自定义工作流(WWF)设计器
·               ContextMenu contextMenu = new ContextMenu();
制作自定义工作流(WWF)设计器·               Dictionary
<CommandID, string> selectionCommands = new Dictionary<CommandID, string>();
制作自定义工作流(WWF)设计器·                
制作自定义工作流(WWF)设计器·               
// Add the required commands
制作自定义工作流(WWF)设计器
·               selectionCommands.Add(WorkflowMenuCommands.Cut, "Cut");
制作自定义工作流(WWF)设计器·               selectionCommands.Add(WorkflowMenuCommands.Copy, 
"Copy");
制作自定义工作流(WWF)设计器·               selectionCommands.Add(WorkflowMenuCommands.Paste, 
"Paste");
制作自定义工作流(WWF)设计器·               selectionCommands.Add(WorkflowMenuCommands.Delete, 
"Delete");
制作自定义工作流(WWF)设计器·               
foreach (CommandID id in selectionCommands.Keys)
制作自定义工作流(WWF)设计器制作自定义工作流(WWF)设计器·               
制作自定义工作流(WWF)设计器{
制作自定义工作流(WWF)设计器·                     MenuCommand command 
= FindCommand(id);
制作自定义工作流(WWF)设计器·                     
if (command != null)
制作自定义工作流(WWF)设计器制作自定义工作流(WWF)设计器·                      
制作自定义工作流(WWF)设计器{
制作自定义工作流(WWF)设计器·                        
// For each command create a new menu item and add an
制作自定义工作流(WWF)设计器
·                        MenuItem menuItem = new MenuItem(selectionCommands[id], new          EventHandler(OnMenuClicked));
制作自定义工作流(WWF)设计器·                        menuItem.Tag 
= command;
制作自定义工作流(WWF)设计器·                        contextMenu.MenuItems.Add(menuItem);
制作自定义工作流(WWF)设计器·                     }

制作自定义工作流(WWF)设计器·               }

制作自定义工作流(WWF)设计器·                
制作自定义工作流(WWF)设计器·               
// Handle the event when the MenuItem is clicked
制作自定义工作流(WWF)设计器
·               private void OnMenuClicked(object sender, EventArgs e)
制作自定义工作流(WWF)设计器制作自定义工作流(WWF)设计器·               
制作自定义工作流(WWF)设计器{
制作自定义工作流(WWF)设计器·                
// Retrieve the menu item that was clicked
制作自定义工作流(WWF)设计器
·                MenuItem menuItem = sender as MenuItem;
制作自定义工作流(WWF)设计器·                
if (menuItem != null && menuItem.Tag is MenuCommand)
制作自定义工作流(WWF)设计器制作自定义工作流(WWF)设计器·                     
制作自定义工作流(WWF)设计器{
制作自定义工作流(WWF)设计器·                        
// invoke the command corresponding to the menu item clicked
制作自定义工作流(WWF)设计器
·                        MenuCommand command = menuItem.Tag as MenuCommand;
制作自定义工作流(WWF)设计器·                        command.Invoke();
制作自定义工作流(WWF)设计器·                     }

制作自定义工作流(WWF)设计器·               }

制作自定义工作流(WWF)设计器


这样,在界面上就可以显示出你自己的上下文菜单了

关于菜单命令的响应处理:

制作自定义工作流(WWF)设计器·               // Invoke the standard command with the command id of the command clicked
制作自定义工作流(WWF)设计器
·               this.workflowDesignerControl1.InvokeStandardCommand(WorkflowMenuCommands.Expand);
制作自定义工作流(WWF)设计器·                
制作自定义工作流(WWF)设计器·               
public void InvokeStandardCommand(CommandID cmd)
制作自定义工作流(WWF)设计器制作自定义工作流(WWF)设计器·                  
制作自定义工作流(WWF)设计器{
制作自定义工作流(WWF)设计器·                     IMenuCommandService menuService 
=
制作自定义工作流(WWF)设计器·                     GetService(
typeof(IMenuCommandService)) as IMenuCommandService;
制作自定义工作流(WWF)设计器·                     
if (menuService != null)
制作自定义工作流(WWF)设计器·                     menuService.GlobalInvoke(cmd);
制作自定义工作流(WWF)设计器·                  }

制作自定义工作流(WWF)设计器


http://msdn2.microsoft.com/en-us/library/Aa480213.wfdsgnrehst03(en-us,MSDN.10).gif

制作自定义工作流(WWF)设计器
2
:生成后台代码MemberCreationService,和EventBindingService

   MemberCreationService可以用来生成关于Member,Filed的之类的定义

   EventBindingService则可以生成和设计界面上事件关联的代码的映射。比方说“CodeActivty”要执行的代码xxx_Excute函数和后台编译后的代码的关联。

制作自定义工作流(WWF)设计器·               // create code member method
制作自定义工作流(WWF)设计器

制作自定义工作流(WWF)设计器·               CodeMemberMethod method 
= new CodeMemberMethod();
制作自定义工作流(WWF)设计器
制作自定义工作流(WWF)设计器·               method.Name 
= methodName;
制作自定义工作流(WWF)设计器
制作自定义工作流(WWF)设计器·               method.Parameters.AddRange(paramCollection);
制作自定义工作流(WWF)设计器
制作自定义工作流(WWF)设计器·               method.ReturnType 
= new CodeTypeReference(returnType);
制作自定义工作流(WWF)设计器
制作自定义工作流(WWF)设计器·               method.Attributes 
= modifiers;
制作自定义工作流(WWF)设计器
制作自定义工作流(WWF)设计器·                
制作自定义工作流(WWF)设计器
制作自定义工作流(WWF)设计器·               
//push the method into the code compile unit
制作自定义工作流(WWF)设计器

制作自定义工作流(WWF)设计器·               typeDeclaration.Members.Insert(index, method);
制作自定义工作流(WWF)设计器
制作自定义工作流(WWF)设计器·                
制作自定义工作流(WWF)设计器
制作自定义工作流(WWF)设计器·               
// refresh the code compile unit
制作自定义工作流(WWF)设计器

制作自定义工作流(WWF)设计器·               TypeProvider typeProvider 
= (TypeProvider)this.serviceProvider.GetService(typeof(ITypeProvider));
制作自定义工作流(WWF)设计器
制作自定义工作流(WWF)设计器·               typeProvider.RefreshCodeCompileUnit(
this.ccu,new EventHandler(RefreshCCU));
制作自定义工作流(WWF)设计器
制作自定义工作流(WWF)设计器


 其后台代码可能这样

制作自定义工作流(WWF)设计器·               public partial class Workflow1 : SequentialWorkflowActivity
制作自定义工作流(WWF)设计器制作自定义工作流(WWF)设计器·               
制作自定义工作流(WWF)设计器{
制作自定义工作流(WWF)设计器·                       
private void EventHandler(object sender, System.EventArgs e)
制作自定义工作流(WWF)设计器制作自定义工作流(WWF)设计器·                       
制作自定义工作流(WWF)设计器{
制作自定义工作流(WWF)设计器·                       }

制作自定义工作流(WWF)设计器·               }

制作自定义工作流(WWF)设计器


xml的定义可能这样:

3:显示工具箱的ToolBoxService

  这个类继承自:IToolboxService,他可以显示工作流设计中需要的各类组件。

http://msdn2.microsoft.com/en-us/library/Aa480213.wfdsgnrehst04(en-us,MSDN.10).gif

制作自定义工作流(WWF)设计器
4
:显示组件属性的ActivityBind Dialog: IPropertyValueUIService

一般使用PropertyValueUIItem来传递数据

http://msdn2.microsoft.com/en-us/library/Aa480213.wfdsgnrehst05(en-us,MSDN.10).gif

制作自定义工作流(WWF)设计器
5
Rules Dialog:用来编辑各种Rule

   这个用来编辑rule,ruleSet

http://msdn2.microsoft.com/en-us/library/Aa480213.wfdsgnrehst07(en-us,MSDN.10).gif

 制作自定义工作流(WWF)设计器

6:处理状态机State Machine Features:

   这段代码用来处理状态机



制作自定义工作流(WWF)设计器1.                          // Save the layout in case of State Machine Workflow
制作自定义工作流(WWF)设计器
2.                          string layoutFile = Path.Combine(Path.GetDirectoryName(this.xoml), Path.GetFileNameWithoutExtension(this.xoml) + ".layout");
制作自定义工作流(WWF)设计器
3.                          ActivityDesigner rootdesigner = host.GetDesigner(rootActivity) as ActivityDesigner;
制作自定义工作流(WWF)设计器
4.                          XmlWriter layoutwriter = XmlWriter.Create(layoutFile);
制作自定义工作流(WWF)设计器
5.                          IList errors = null;
制作自定义工作流(WWF)设计器
6.                          SaveDesignerLayout(layoutwriter, rootdesigner, out errors);
制作自定义工作流(WWF)设计器
7.                          layoutwriter.Close();
制作自定义工作流(WWF)设计器
8.                           
制作自定义工作流(WWF)设计器
9.                          // Load the layout
制作自定义工作流(WWF)设计器
10.                       string layoutFile = Path.Combine(Path.GetDirectoryName(this.xoml), Path.GetFileNameWithoutExtension(this.xoml) + ".layout");
制作自定义工作流(WWF)设计器
11.                       if (File.Exists(layoutFile))
制作自定义工作流(WWF)设计器制作自定义工作流(WWF)设计器
12.                          制作自定义工作流(WWF)设计器{
制作自定义工作流(WWF)设计器
13.                             IList loaderrors = null;
制作自定义工作流(WWF)设计器
14.