SCSF 之 DockPanel 扩展

       本文主要介绍利用DockPanel实现自定义的Smart Client Soft Factory（SCSF）中的Workspace，在使用SCSF开发多文档Winform应用程序时实现类似Visual Studio多文档界面.

 

      DockPanel是非常好用的开发类似Visual Studio多文档界面组件。可以从http://sourceforge.net/projects/dockpanelsuite/下载使用。

     

      Smart Client Software Factory是Microsoft patterns & practices中的智能客户端开发用户界面框架。其中实现了很多常用的Workspace类，如TabWorkspace,WindowWorkspace,MdiWorkspace,ZoneWorkspace等等，可以使用这些Workspace类方便的显示、管理我们的视图。此外还实现了WorkspaceComposer的泛型类，此类实现了基本的Workspace管理SmartPart的功能，我们可以采用组合的方式（SCSF中的大部分Workspace都是组合该类来实现的）和IWorkspace接口（SCSF中的Workspace必须实现该接口）实现我们自定义的Workspace类。

      类图如下：

   

                        

  

      下面我们看看WorkspaceComposer类的两个泛型参数TSmartPart和TSmartPartInfo。在SCSF中WorkspaceComposer类的定义为：

     

      public class WorkspaceComposer<TSmartPart, TSmartPartInfo> : Workspace<TSmartPart, TSmartPartInfo> where TSmartPartInfo : Microsoft.Practices.CompositeUI.SmartParts.ISmartPartInfo, new()

     

      从后面的where约束看出TSmartPart是一个可以通过new运算符创建的引用类型（应该视图类的基类行来实例话），一般为Control（所有用户界面类都继承自Control类）类来实例化即可，第二个泛型参数TSmartPartInfo是实现ISmartPartInfo接口的类型。顾名思义ISmartPartInfo是SmartPart的信息类，也就是描述视图（SmartPart）的显示位置、显示方式等信息的类，Workspace管理或者显示一个视图时根据SmartPartInfo来管理。每种Workspace显示视图时可能需要不同的信息，因此在此对显示信息类抽象并独立开来，我们可以参考SCSF中TabSmartPartInfo,WindowsSmartPartInfo等类的实现代码，很容易就实现我们的SmartPartInfo类。

    

      到此我们有了DockPanelWorkspace,DockPanelSmartPartInfo类。那么Workspace如何获得SmartPartInfo呢？

很幸运 WorkspaceComposer类为我们做好了一切，只需按步骤实现相应的方法即可，这里简单讲一下其实现机制。

     有两种方式可以将一个视图(SmartPart)的信息传递给Workspace。

 

     1.调用Workspace的成员方法

    

      public void Show(object smartPart, ISmartPartInfo smartPartInfo) { composer.Show(smartPart, smartPartInfo); }

     

     2.视图（SmartPart）类实现ISmartPartInfoProvider接口，返回自己的配置信息。我们在Workspace的Show方法实现代码中可以看到。

    

      public void Show(object smartPart) { Guard.ArgumentNotNull(smartPart, "smartPart"); ThrowIfUnsupportedSP(smartPart); TSmartPart typedSmartPart = (TSmartPart)smartPart; // Behavior is slightly different than the other overload, as we don't want to // reapply the SPI in this case. if (smartParts.Contains(typedSmartPart)) { Activate(smartPart); } else { ISmartPartInfo info = null; //获得Provider ISmartPartInfoProvider provider = smartPart as ISmartPartInfoProvider; if (workItem != null) { info = workItem.GetSmartPartInfo<TSmartPartInfo>(smartPart); if (info == null && provider != null) { info = provider.GetSmartPartInfo(typeof(TSmartPartInfo)); } if (info == null) { info = workItem.GetSmartPartInfo<SmartPartInfo>(smartPart); } if (info == null && provider != null) { info = provider.GetSmartPartInfo(typeof(SmartPartInfo)); } } else if (provider != null) { info = provider.GetSmartPartInfo(typeof(TSmartPartInfo)); if (info == null) { info = provider.GetSmartPartInfo(typeof(SmartPartInfo)); } } if (info == null) { info = CreateDefaultSmartPartInfo(typedSmartPart); } Show(typedSmartPart, info); } }  

 

    综上述分析我们基本可以实现我们的DockPanelWorkspace类，下面是完善后的类图关系

 

     

 

   下面是实现代码希望对大家学习Smar Client Soft Factory有所帮助，也希望多多指点：）。

 

       DockPanelWorkspace代码：

   

       using System; using System.Collections.Generic; using System.Text; using Microsoft.Practices.CompositeUI.SmartParts; using System.Windows.Forms; using WeifenLuo.WinFormsUI.Docking; using Microsoft.Practices.CompositeUI; using Microsoft.Practices.CompositeUI.Utility; using System.ComponentModel; namespace School.Infrastructure.Library.UI { /// <summary> /// 此类从DockPanel继承，使DockPanel能支持CompsiteWinform的Workspace机制 /// raymond_yu 2009-12 /// </summary> public class DockPanelWorkspace:DockPanel,IWorkspace,IComposableWorkspace<Control,DockPanelSmartPartInfo> { private WorkItem _workItem; private WorkspaceComposer<Control, DockPanelSmartPartInfo> composer; private Dictionary<Control, IDockContent> dockContents; private bool callComposerActivate = true; private bool initialized = false; private bool populatingWindows = false; public DockPanelWorkspace() { composer = new WorkspaceComposer<Control, DockPanelSmartPartInfo>(this); dockContents = new Dictionary<Control, IDockContent>(); base.ActiveContentChanged += new EventHandler(OnActiveContent_Changed); } [ServiceDependency] public WorkItem WorkItem { set { composer.WorkItem = value; _workItem = value; } } [Browsable(false)] [DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)] public ReadOnlyDictionary<Control, IDockContent> DockContents { get { return new ReadOnlyDictionary<Control, IDockContent>(dockContents); } } #region Load & Save Layout public void LoadLayout(string xmlFileName) { try { this.SuspendLayout(); //remove all contents foreach (KeyValuePair<Control, IDockContent> item in DockContents) { item.Value.DockHandler.DockPanel = null; } base.LoadFromXml(xmlFileName, this.OnDeserializeDockContent); foreach(IDockContent content in this.Contents) { Console.WriteLine(content.GetType().ToString()); } } finally { this.ResumeLayout(false, false); } } public void SaveLayout(string xmlFileName) { base.SaveAsXml(xmlFileName); } private IDockContent OnDeserializeDockContent(string persistString) { string[] persist = persistString.Split(','); //foreach (KeyValuePair<Control, IDockContent> item in this.dockContents) //{ // if (((IDockPanelSmartPart)item.Key).Guid.ToString() == persist[2]) // return item.Value; //} Control smartPart = this.FindSmartPart(this._workItem, persist[2]); return smartPart == null ? null : this.dockContents[smartPart]; } #endregion #region Find SmartParts //private Control FindByGuid(Guid guid) //{ // foreach (KeyValuePair<Control, IDockContent> content in this.dockContents) // { // IDockPanelSmartPart smartPart = content.Key as IDockPanelSmartPart; // if (smartPart != null) // { // if (smartPart.Guid == guid) // { // return content.Key; // } // } // } // return null; //} private Control FindSmartPart(WorkItem workItem, string id) { if (workItem.SmartParts.Contains(id)) return workItem.SmartParts[id] as Control; foreach (KeyValuePair<string, WorkItem> childItem in workItem.WorkItems) { Control resutl = FindSmartPart(childItem.Value, id); if (resutl != null) return resutl; } return null; } private string FindSmartPartId(WorkItem workItem, Control smartPart) { foreach (KeyValuePair<string, object> item in workItem.SmartParts) { if (Object.ReferenceEquals(item.Value, smartPart)) return item.Key; } foreach (KeyValuePair<string, WorkItem> childItem in workItem.WorkItems) { string id = FindSmartPartId(childItem.Value, smartPart); if (id != null) return id; } return null; } #endregion #region IWorkspace Members public void Activate(object smartPart) { composer.Activate(smartPart); } public object ActiveSmartPart { get { return composer.ActiveSmartPart; } } public void ApplySmartPartInfo(object smartPart, ISmartPartInfo smartPartInfo) { composer.ApplySmartPartInfo(smartPart, smartPartInfo); } public void Close(object smartPart) { composer.Close(smartPart); } public void Hide(object smartPart) { composer.Hide(smartPart); } public void Show(object smartPart) { composer.Show(smartPart); } public void Show(object smartPart, ISmartPartInfo smartPartInfo) { composer.Show(smartPart, smartPartInfo); } public event EventHandler<WorkspaceEventArgs> SmartPartActivated = null; public event EventHandler<WorkspaceCancelEventArgs> SmartPartClosing = null; public System.Collections.ObjectModel.ReadOnlyCollection<object> SmartParts { get { return composer.SmartParts; } } #endregion #region IComposableWorkspace<Control,DockPanelSmartPartInfo> Members DockPanelSmartPartInfo IComposableWorkspace<Control, DockPanelSmartPartInfo>.ConvertFrom(ISmartPartInfo source) { return this.ConvertFrom(source); } void IComposableWorkspace<Control, DockPanelSmartPartInfo>.OnActivate(Control smartPart) { OnActivate(smartPart); } void IComposableWorkspace<Control, DockPanelSmartPartInfo>.OnApplySmartPartInfo(Control smartPart, DockPanelSmartPartInfo smartPartInfo) { OnApplySmartPartInfo(smartPart, smartPartInfo); } void IComposableWorkspace<Control, DockPanelSmartPartInfo>.OnClose(Control smartPart) { OnClose(smartPart); } void IComposableWorkspace<Control, DockPanelSmartPartInfo>.OnHide(Control smartPart) { OnHide(smartPart); } void IComposableWorkspace<Control, DockPanelSmartPartInfo>.OnShow(Control smartPart, DockPanelSmartPartInfo smartPartInfo) { OnShow(smartPart,smartPartInfo); } void IComposableWorkspace<Control, DockPanelSmartPartInfo>.RaiseSmartPartActivated(WorkspaceEventArgs e) { OnSmartPartActivated(e); } void IComposableWorkspace<Control, DockPanelSmartPartInfo>.RaiseSmartPartClosing(WorkspaceCancelEventArgs e) { OnSmartPartClosing(e); } #endregion #region Protected virtual implementations /// <summary> /// Activates the smart part. /// </summary> protected virtual void OnActivate(Control smartPart) { PopulateWindows(); IDockContent content = this.dockContents[smartPart]; try { callComposerActivate = false; content.DockHandler.Show(); content.DockHandler.Activate(); } finally { callComposerActivate = true; } } private void OnActiveContent_Changed(object sender, EventArgs e) { if (callComposerActivate && base.Contents.Count != 0) { IDockContent content = this.ActiveContent; foreach (KeyValuePair<Control, IDockContent> item in this.dockContents) { if (item.Value == content) { this.Activate(item.Key); return; } } composer.SetActiveSmartPart(null); } } /// <summary> /// Applies the smart part display information to the smart part. /// </summary> protected virtual void OnApplySmartPartInfo(Control smartPart, DockPanelSmartPartInfo smartPartInfo) { PopulateWindows(); SetContentProperties(dockContents[smartPart], smartPartInfo); if (smartPartInfo.ActivateContent) { Activate(smartPart); } } private void SetContentProperties(IDockContent dockContent, DockPanelSmartPartInfo smartPartInfo) { DockContent content = (DockContent)dockContent; content.TabText = smartPartInfo.Title; content.ToolTipText = smartPartInfo.Description; content.Icon = smartPartInfo.Icon; content.Location = smartPartInfo.Location; content.Width = smartPartInfo.Width; content.Height = smartPartInfo.Height; content.HideOnClose = smartPartInfo.HideOnClose; content.AutoHidePortion = smartPartInfo.AutoHidePortion; content.DockAreas = smartPartInfo.DockAreas; } /// <summary> /// Closes the smart part. /// </summary> protected virtual void OnClose(Control smartPart) { PopulateWindows(); smartPart.Disposed -= ControlDisposed; this.dockContents.Remove(smartPart); //this.composer.ForceClose(smartPart); //smartPart.Dispose(); } /// <summary> /// Hides the smart part. /// </summary> protected virtual void OnHide(Control smartPart) { if (smartPart.Visible) { PopulateWindows(); this.dockContents[smartPart].DockHandler.Hide(); } } /// <summary> /// Shows the control. /// </summary> protected virtual void OnShow(Control smartPart, DockPanelSmartPartInfo smartPartInfo) { PopulateWindows(); IDockContent content = GetOrCreateDockContent(smartPart); SetContentProperties(content, smartPartInfo); if (smartPartInfo.DockState == DockState.Document) { if (this.DocumentStyle == DocumentStyle.SystemMdi) { Form childForm = (Form)content; childForm.MdiParent = this.FindForm(); childForm.Show(); } else { content.DockHandler.Show(this,smartPartInfo.DockState); } } else { Control previousSmartPart = String.IsNullOrEmpty(smartPartInfo.PreviousSmartPart) ? null : FindSmartPart(this._workItem,smartPartInfo.PreviousSmartPart); if (previousSmartPart == null || !this.dockContents.ContainsKey(previousSmartPart)) { content.DockHandler.Show(this, smartPartInfo.DockState); } else { IDockContent precontent = this.dockContents[previousSmartPart]; content.DockHandler.Show(precontent.DockHandler.Pane, smartPartInfo.DockAlignment, smartPartInfo.Proportion); } } smartPart.Show(); if (smartPartInfo.ActivateContent) { Activate(smartPart); } //smartPart.Disposed += ControlDisposed; } protected virtual IDockContent GetOrCreateDockContent(Control smartPart) { if (this.dockContents.ContainsKey(smartPart)) { return this.dockContents[smartPart]; } Control current = smartPart; DockContent content = smartPart as DockContent; if (content == null) { string id = FindSmartPartId(this._workItem, smartPart); if (String.IsNullOrEmpty(id)) { id = Guid.NewGuid().ToString(); } content = new DockContent(); content.Name = id; content.DockHandler.GetPersistStringCallback = delegate() { return String.Format("{0},{1},{2}", content.GetType().Name, smartPart.GetType().Name, content.Name); }; content.Controls.Add(smartPart); smartPart.Dock = DockStyle.Fill; } if (!this.dockContents.ContainsKey(smartPart)) { smartPart.Disposed += ControlDisposed; content.FormClosing += new FormClosingEventHandler(content_FormClosing); content.FormClosed += new FormClosedEventHandler(content_FormClosed); this.dockContents.Add(smartPart, content); } return content; } /// <summary> /// Raises the <see cref="SmartPartActivated"/> event. /// </summary> protected virtual void OnSmartPartActivated(WorkspaceEventArgs e) { if (SmartPartActivated != null) { SmartPartActivated(this, e); } } /// <summary> /// Raises the <see cref="SmartPartClosing"/> event. /// </summary> protected virtual void OnSmartPartClosing(WorkspaceCancelEventArgs e) { if (SmartPartClosing != null) { SmartPartClosing(this, e); } } /// <summary> /// Converts a smart part information to a compatible one for the workspace. /// </summary> protected virtual DockPanelSmartPartInfo ConvertFrom(ISmartPartInfo source) { return SmartPartInfo.ConvertTo<DockPanelSmartPartInfo>(source); } private void content_FormClosed(object sender, FormClosedEventArgs e) { DockContent content = sender as DockContent; if (content == null) return; if (this.dockContents.ContainsKey((Control)sender)) { //this.dockContents.Remove((Control)sender); this.composer.ForceClose((Control)sender); } else { Control smartPart = content.Controls[0]; //this.dockContents.Remove(smartPart); this.composer.ForceClose((Control)smartPart); } } private void content_FormClosing(object sender, FormClosingEventArgs e) { DockContent content = sender as DockContent; if (content == null) return; if (this.dockContents.ContainsKey((Control)sender)) { WorkspaceCancelEventArgs args = new WorkspaceCancelEventArgs(sender); OnSmartPartClosing(args); e.Cancel = args.Cancel; } else { WorkspaceCancelEventArgs args = new WorkspaceCancelEventArgs(content.Controls[0]); OnSmartPartClosing(args); e.Cancel = args.Cancel; } } private void ControlDisposed(object sender, EventArgs e) { Control control = sender as Control; if (control != null && this.dockContents.ContainsKey(control)) { composer.ForceClose(control); } } private void PopulateWindows() { if (this.initialized) return; this.initialized = true; IDockContent[] panelContents = new IDockContent[this.Contents.Count];// this.Contents.CopyTo( this.Contents.CopyTo(panelContents, 0); if (!this.populatingWindows && this.dockContents.Count != panelContents.Length) { foreach (IDockContent content in panelContents) { if (this.dockContents.ContainsValue(content) == false) { Control smartPart = GetControlFromContent(content); if (smartPart != null && this.SmartParts.Contains(smartPart) == false) { DockPanelSmartPartInfo smartPartInfo = new DockPanelSmartPartInfo(); // Avoid circular calls to this method. this.populatingWindows = true; try { Show(smartPart, smartPartInfo); } finally { this.populatingWindows = false; } } } } } } private Control GetControlFromContent(IDockContent content) { Control control = (Control)content; return (control.Controls.Count > 0) ? control.Controls[0] : null; } #endregion } }

     

       DockPanelSmartPartInfo代码：

     

       using System; using System.Collections.Generic; using System.Linq; using System.Text; using Microsoft.Practices.CompositeUI.SmartParts; using WeifenLuo.WinFormsUI.Docking; using System.Drawing; using System.ComponentModel; using System.Windows.Forms; namespace School.Infrastructure.Library.UI { /// <summary> /// SmartPart显示信息，DockPanelWorkspace根据该信息将SmartPart显示在相应位置 /// raymond_yu 2009-12 /// </summary> public class DockPanelSmartPartInfo:SmartPartInfo { private DockAreas _dockAreas; private DockState _dockState; private Icon _icon = null; private bool _activateContent = true; private bool _closeOnHide = false; private double _autoHidePortion = 0.25f; private Point _location = default(Point); private int _width = 0; private int _height = 0; private DockAlignment _dockAlignment = DockAlignment.Bottom; private string _previousSmartPart = string.Empty; private double _proportion = 0.5; public DockPanelSmartPartInfo() : base() { _dockAreas = DockAreas.DockBottom | DockAreas.DockLeft | DockAreas.DockRight | DockAreas.DockTop | DockAreas.Document | DockAreas.Float; _dockState = DockState.Document; } [Category("Layout")] [DefaultValue(false)] public bool ActivateContent { get { return _activateContent; } set { _activateContent = value; } } [Category("Layout")] public DockAreas DockAreas { get { return _dockAreas; } set { _dockAreas = value; } } [Category("Layout")] public DockState DockState { get { return _dockState; } set { _dockState = value; } } [Category("Layout")] [DefaultValue(null)] public Icon Icon { get { return _icon; } set { _icon = value; } } [Category("Layout")] [DefaultValue(false)] public bool HideOnClose { get { return _closeOnHide; } set { _closeOnHide = value; } } [Category("Layout")] [DefaultValue(0.25)] public double AutoHidePortion { get { return _autoHidePortion; } set { _autoHidePortion = value; } } [Category("Layout")] [DefaultValue(0)] public int Width { get { return _width; } set { _width = value; } } [Category("Layout")] [DefaultValue(0)] public int Height { get { return _height; } set { _height = value; } } [Category("Layout")] [DefaultValue(null)] public Point Location { get { return _location; } set { _location = value; } } [Category("Layout")] [DefaultValue(DockAlignment.Bottom)] public DockAlignment DockAlignment { get { return _dockAlignment; } set { _dockAlignment = value; } } [Category("Layout")] [DefaultValue("")] public string PreviousSmartPart { get { return _previousSmartPart; } set { _previousSmartPart = value; } } public double Proportion { get { return _proportion; } set { _proportion = value; } } } }