Composite UI / SCSF and Krypton?

[PaulDeen]

Hi all,

Not sure if anyone intends to use Krypton with Composite UI and SCSF. But if you're thinking about it then this may be of interest.

I've written some Workspaces (KryptonNavigator and DockingWindows) and some UIExtensionAdapters for Ribbon (Tabs, Groups, Buttons, QAT bar, etc). These components mean you can add Krypton / DotNetMagic functionality to your composite apps in a few lines of code. At the moment, I've given the code out to people on an adhoc basis when they've asked me for it.

Would it be useful for anyone if I made these public (free of course)? Perhaps Phil would like to link to them if I did?

Cheers,

Paul

[Phil Wright]

Thanks for posting about the Composite UI code. I would like to take a look at the code for the Krypton related elements. Use of the Composite UI application block seems to be slowly growing and maybe it would be useful to add something like this to a future release.

[cornelha]

How can i get a copy of this code ?

[Phil Wright]

I was never sent a copy of the code and so we have to hope that PaulDeen emails a copy to both of us!

[cornelha]

I found this on CodeProject -> http://www.codeproject.com/useritems/sm ... ookbar.asp and i have started converting the controls etc to Krypton Controls. Hopefully once we have aquired our licence for the ribbon and Navigator this will be easier

CAB and SFCF seems brilliant

[PaulDeen]

Hi, sorry hadn't got around to finishing it. I was just making it so that you can define the contents of the ribbon in an xml document and wire them into the CAB commands / UI extension sites that way. At the moment it requires it to be done through code which works, but isn't ideal.

As soon as this work is done (a couple of evenings left to finish) I'll post a link for you guys to download.

Cheers,

Paul

[cornelha]

Awesome !! Keep us posted

[jkr]

Any news on the KryptonNavigator Workspace ?

[PaulDeen]

Actually, I'll just give you the code to it.... it's very very simple because it fits quite well with the tab workspace provided in the source for CAB, here it goes anyway:

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Drawing;
using System.Windows.Forms;
using Microsoft.Practices.CompositeUI.SmartParts;
using Microsoft.Practices.CompositeUI.Utility;
using System.Collections.ObjectModel;
using Microsoft.Practices.CompositeUI.WinForms;
using Microsoft.Practices.CompositeUI;
using ComponentFactory.Krypton.Navigator;

namespace CometX.CabMagic.Workspaces
{
/// <summary>
/// Implements a Workspace that shows smartparts in a <see cref="TabControl"/>.
/// </summary>
[DesignerCategory("Code")]
[ToolboxBitmap(typeof(KryptonTabWorkspace), "KryptonTabWorkspace")]
public class KryptonTabWorkspace : KryptonNavigator, IComposableWorkspace<Control, TabSmartPartInfo>
{
private Dictionary<Control, KryptonPage> pages = new Dictionary<Control, KryptonPage>();
private WorkspaceComposer<Control, TabSmartPartInfo> composer;
private bool callComposerActivateOnIndexChange = true;
private bool populatingPages = false;

/// <summary>
/// Initializes a new instance of the <see cref="TabWorkspace"/> class
/// </summary>
public KryptonTabWorkspace()
{
composer = new WorkspaceComposer<Control, TabSmartPartInfo>(this);
}

/// <summary>
/// Dependency injection setter property to get the <see cref="WorkItem"/> where the
/// object is contained.
/// </summary>
[ServiceDependency]
public WorkItem WorkItem
{
set { composer.WorkItem = value; }
}

#region Properties

/// <summary>
/// Gets the collection of pages that the tab workspace uses.
/// </summary>
public ReadOnlyDictionary<Control, KryptonPage> TabPages
{
get { return new ReadOnlyDictionary<Control, KryptonPage>(pages); }
}

#endregion

#region Private

private void SetTabProperties(KryptonPage page, TabSmartPartInfo smartPartInfo)
{

try
{

page.Text = String.IsNullOrEmpty(smartPartInfo.Title) ? page.Text : smartPartInfo.Title;

KryptonPage currentSelection = this.SelectedPage ;
callComposerActivateOnIndexChange = false;
if (smartPartInfo.Position == TabPosition.Beginning)
{

this.Pages.Insert(0,page);

}
else if (this.Pages.Contains(page) == false)
{
this.Pages.Add(page);
}

// Preserve selection through the operation.
if (currentSelection != null)
{
this.SelectedPage = currentSelection;
}

}
finally
{
callComposerActivateOnIndexChange = true;
}
}

private KryptonPage[] GetPages()
{
KryptonPage[] pages = new KryptonPage[this.Pages.Count];
for (int i = 0; i < pages.Length; i++)
{
pages[i] = this.Pages[i];
}

return pages;
}

private void ShowExistingTab(Control smartPart)
{
string key = pages[smartPart].Name;
this.Pages[key].Show();
}

private KryptonPage GetOrCreateTabPage(Control smartPart)
{
KryptonPage page = null;

// If the tab was added with the control at design-time, it will have a parent control,
// and somewhere up its containment chain we'll find one of our tabs.
Control current = smartPart;
while (current != null && page == null)
{
current = current.Parent;
page = current as KryptonPage;
}

if (page == null)
{
page = new KryptonPage();
page.Controls.Add(smartPart);
smartPart.Dock = DockStyle.Fill;
page.Name = Guid.NewGuid().ToString();

pages.Add(smartPart, page);
}
else if (pages.ContainsKey(smartPart) == false)
{
pages.Add(smartPart, page);
}

return page;
}

private void PopulatePages()
{
// If the page count matches don't waste the
// time repopulating the pages collection
if (!populatingPages && pages.Count != this.Pages.Count)
{
foreach (KryptonPage page in this.Pages)
{
if (this.pages.ContainsValue(page) == false)
{
Control control = GetControlFromPage(page);
if (control != null && composer.SmartParts.Contains(control) == false)
{
TabSmartPartInfo tabinfo = new TabSmartPartInfo();
tabinfo.ActivateTab = false;
// Avoid circular calls to this method.
populatingPages = true;
try
{
Show(control, tabinfo);

}
finally
{
populatingPages = false;
}
}
}
}
}
}

private void ControlDisposed(object sender, EventArgs e)
{
Control control = sender as Control;
if (control != null && this.pages.ContainsKey(control))
{
composer.ForceClose(control);
}
}

private Control GetControlFromSelectedPage()
{
return GetControlFromPage(this.SelectedPage);
}

private Control GetControlFromPage(KryptonPage page)
{
Control control = null;
if (page.Controls.Count > 0)
{
control = page.Controls[0];
}

return control;
}

#endregion

#region Internal implementation

/// <summary>
/// Hooks up tab pages added at design-time.
/// </summary>
protected override void OnCreateControl()
{
base.OnCreateControl();
PopulatePages();
}

private void ActivateSiblingTab()
{
if (this.SelectedIndex > 0)
{
this.SelectedIndex = this.SelectedIndex - 1;
}
else if (this.SelectedIndex < this.Pages.Count - 1)
{
this.SelectedIndex = this.SelectedIndex + 1;
}
else
{
composer.SetActiveSmartPart(null);
}
}

private void ResetSelectedIndexIfNoTabs()
{
// First control to come in is special. We need to
// set the selected index to a non-zero index so we
// get the appropriate behavior for activation.
if (this.Pages.Count == 0)
{
try
{
callComposerActivateOnIndexChange = false;
this.SelectedIndex = -1;
}
finally
{
callComposerActivateOnIndexChange = true;
}
}
}

#endregion

#region Protected virtual implementations

/// <summary>
/// Activates the smart part.
/// </summary>
protected virtual void OnActivate(Control smartPart)
{
PopulatePages();

string key = pages[smartPart].Name;

try
{
callComposerActivateOnIndexChange = false;
SelectedPage = Pages[key];
//Pages[key].Show();
}
finally
{
callComposerActivateOnIndexChange = true;
}
}

/// <summary>
/// Applies the smart part display information to the smart part.
/// </summary>
protected virtual void OnApplySmartPartInfo(Control smartPart, TabSmartPartInfo smartPartInfo)
{
PopulatePages();
string key = pages[smartPart].Name;
SetTabProperties(Pages[key], smartPartInfo);
if (smartPartInfo.ActivateTab)
{
Activate(smartPart);
}
}

/// <summary>
/// Closes the smart part.
/// </summary>
protected virtual void OnClose(Control smartPart)
{
PopulatePages();
//Pages.Remove(pages[smartPart]);
pages.Remove(smartPart);

smartPart.Disposed -= ControlDisposed;
//smartPart.Dispose();
}

/// <summary>
/// Hides the smart part.
/// </summary>
protected virtual void OnHide(Control smartPart)
{
if (smartPart.Visible)
{
PopulatePages();
string key = pages[smartPart].Name;
Pages[key].Hide();
ActivateSiblingTab();
}
}

/// <summary>
/// Shows the control.
/// </summary>
protected virtual void OnShow(Control smartPart, TabSmartPartInfo smartPartInfo)
{
PopulatePages();
ResetSelectedIndexIfNoTabs();

KryptonPage page = GetOrCreateTabPage(smartPart);
SetTabProperties(page, smartPartInfo);

if (smartPartInfo.ActivateTab)
{
Activate(smartPart);
}

smartPart.Disposed += ControlDisposed;
}

/// <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 TabSmartPartInfo ConvertFrom(ISmartPartInfo source)
{
return SmartPartInfo.ConvertTo<TabSmartPartInfo>(source);
}

#endregion

#region IComposableWorkspace<Control,TabSmartPartInfo> Members

/// <summary>
/// See <see cref="IComposableWorkspace{TSmartPart, TSmartPartInfo}.OnActivate"/> for more information.
/// </summary>
void IComposableWorkspace<Control, TabSmartPartInfo>.OnActivate(Control smartPart)
{
OnActivate(smartPart);
}

/// <summary>
/// See <see cref="IComposableWorkspace{TSmartPart, TSmartPartInfo}.OnApplySmartPartInfo"/> for more information.
/// </summary>
void IComposableWorkspace<Control, TabSmartPartInfo>.OnApplySmartPartInfo(Control smartPart, TabSmartPartInfo smartPartInfo)
{
OnApplySmartPartInfo(smartPart, smartPartInfo);
}

/// <summary>
/// See <see cref="IComposableWorkspace{TSmartPart, TSmartPartInfo}.OnShow"/> for more information.
/// </summary>
void IComposableWorkspace<Control, TabSmartPartInfo>.OnShow(Control smartPart, TabSmartPartInfo smartPartInfo)
{
OnShow(smartPart, smartPartInfo);
}

/// <summary>
/// See <see cref="IComposableWorkspace{TSmartPart, TSmartPartInfo}.OnHide"/> for more information.
/// </summary>
void IComposableWorkspace<Control, TabSmartPartInfo>.OnHide(Control smartPart)
{
OnHide(smartPart);
}

/// <summary>
/// See <see cref="IComposableWorkspace{TSmartPart, TSmartPartInfo}.OnClose"/> for more information.
/// </summary>
void IComposableWorkspace<Control, TabSmartPartInfo>.OnClose(Control smartPart)
{
OnClose(smartPart);
}

/// <summary>
/// See <see cref="IComposableWorkspace{TSmartPart, TSmartPartInfo}.RaiseSmartPartActivated"/> for more information.
/// </summary>
void IComposableWorkspace<Control, TabSmartPartInfo>.RaiseSmartPartActivated(WorkspaceEventArgs e)
{
OnSmartPartActivated(e);
}

/// <summary>
/// See <see cref="IComposableWorkspace{TSmartPart, TSmartPartInfo}.RaiseSmartPartClosing"/> for more information.
/// </summary>
void IComposableWorkspace<Control, TabSmartPartInfo>.RaiseSmartPartClosing(WorkspaceCancelEventArgs e)
{
OnSmartPartClosing(e);
}

/// <summary>
/// See <see cref="IComposableWorkspace{TSmartPart, TSmartPartInfo}.ConvertFrom"/> for more information.
/// </summary>
TabSmartPartInfo IComposableWorkspace<Control, TabSmartPartInfo>.ConvertFrom(ISmartPartInfo source)
{
return SmartPartInfo.ConvertTo<TabSmartPartInfo>(source);
}

#endregion

#region IWorkspace Members

/// <summary>
/// See <see cref="IWorkspace.SmartPartClosing"/> for more information.
/// </summary>
public event EventHandler<WorkspaceCancelEventArgs> SmartPartClosing;

/// <summary>
/// See <see cref="IWorkspace.SmartPartActivated"/> for more information.
/// </summary>
public event EventHandler<WorkspaceEventArgs> SmartPartActivated;

/// <summary>
/// See <see cref="IWorkspace.SmartParts"/> for more information.
/// </summary>
[Browsable(false)]
[DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
public ReadOnlyCollection<object> SmartParts
{
get { return composer.SmartParts; }
}

/// <summary>
/// See <see cref="IWorkspace.ActiveSmartPart"/> for more information.
/// </summary>
[Browsable(false)]
[DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)]
public object ActiveSmartPart
{
get { return composer.ActiveSmartPart; }
}

/// <summary>
/// Shows the smart part in a new tab with the given information.
/// </summary>
public void Show(object smartPart, ISmartPartInfo smartPartInfo)
{
composer.Show(smartPart, smartPartInfo);
}

/// <summary>
/// Shows the smart part in a new tab.
/// </summary>
public void Show(object smartPart)
{
composer.Show(smartPart);
}

/// <summary>
/// Hides the smart part and its tab.
/// </summary>
public void Hide(object smartPart)
{
composer.Hide(smartPart);
}

/// <summary>
/// Closes the smart part and removes its tab.
/// </summary>
public void Close(object smartPart)
{
composer.Close(smartPart);
}

/// <summary>
/// Activates the tab the smart part is contained in.
/// </summary>
/// <param name="smartPart"></param>
public void Activate(object smartPart)
{
composer.Activate(smartPart);
}

/// <summary>
/// Applies new layout information on the tab of the smart part.
/// </summary>
public void ApplySmartPartInfo(object smartPart, ISmartPartInfo smartPartInfo)
{
composer.ApplySmartPartInfo(smartPart, smartPartInfo);
}

#endregion
}
}



and the smartpart info class

using System.Drawing;
using Microsoft.Practices.CompositeUI.SmartParts;
using System.ComponentModel;
using Crownwood.DotNetMagic.Controls;
using Microsoft.Practices.CompositeUI.WinForms;


namespace CometX.CabMagic.Workspaces
{
[ToolboxBitmap(typeof(TabSmartPartInfo), "TabSmartPartInfo")]
public class TabSmartPartInfo : SmartPartInfo
{

private TabPosition innerPosition = TabPosition.End;

private bool innerActivateTab = true;

private string innerWorkItemName = System.String.Empty;

// '' <summary>
// '' Specifies whether the tab will get focus when shown.
// '' </summary>
[Category("Layout")]
[DefaultValue(true)]
public bool ActivateTab
{
get
{
return innerActivateTab;
}
set
{
innerActivateTab = value;
}
}

[Category("Layout")]
[DefaultValue(TabPosition.End)]
public TabPosition Position
{
get
{
return innerPosition;
}
set
{
innerPosition = value;
}
}
}
}





Hope this helps,

Paul

[jkr]

thank you

i did this a few days back using the tab work space (because the navigator is still a tab) and the outlook workspace from scsf contrib.

the SetTabProperties is a little different because i wanted the page to be at a certain position (in outlook mode especially)

private void SetTabProperties(KryptonPage page, KryptonNavigatorSmartPartInfo smartPartInfo)
{
page.Text = String.IsNullOrEmpty(smartPartInfo.Title) ? page.Text : smartPartInfo.Title;
try
{
page.Text = smartPartInfo.Title;
page.TextTitle = smartPartInfo.Title;
page.ImageSmall = smartPartInfo.Image;

if (this.Pages.Count == 0)
this.Pages.Add(page);
else
this.Pages.Insert(this.Pages.Count - smartPartInfo.Index, page);

}
finally
{
callComposerActivateOnIndexChange = true;
}
}