Click here to Skip to main content
Click here to Skip to main content
Go to top

ToolStripPanel UIAdapter

, 25 Jun 2006
Rate this:
Please Sign up or sign in to vote.
Adding ToolStripPanel support to the Composite UI Application Block.

Introduction

I was very suppressed to find that CAB (Composite Application Block) did not support a higher level of the ToolStrip in its basic implementation. I resolved to solve this, and I added an adapter and factory for the ToolStripPanel initially, but I have been having trouble with the ToolStripContainer. So, as my first post, here is the ToolStripPanel code.

There are two parts to this. And two ways to do it. The first is to edit the existing ToolStrip UI factory to include the new code. But I do not like to do this as I may update CAB in the future and do not want to rely on having to implement the adaptations again.

The second is to inherit from the current classes in your own assembly and to adapt the class to support both. That way, you are extending, not replacing.

Here is the code for the new ToolStripUIAdapterFactory factory:

Public Class ToolStripPanelUIAdapter : _
             Inherits UIElementAdapter(Of ToolStrip)
        Private innerToolStripPanel As ToolStripPanel
        Public Sub New(ByVal objToolStripPanel As ToolStripPanel)
            Guard.ArgumentNotNull(objToolStripPanel, "objToolStripPanel")
            Me.innerToolStripPanel = objToolStripPanel
        End Sub
        Protected Overrides Function Add(ByVal uiElement As ToolStrip) _
                                                         As ToolStrip
            If Me.innerToolStripPanel Is Nothing Then
                Throw New InvalidOperationException()
            End If
            Me.innerToolStripPanel.Join(uiElement, 3)
            Return uiElement
        End Function
        Protected Overrides Sub Remove(ByVal uiElement As ToolStrip)
            If Me.innerToolStripPanel.Controls.Contains(uiElement) Then
                Me.innerToolStripPanel.Controls.Remove(uiElement)
            End If
        End Sub
End Class

As you can see, it inherits from the CAB class of the same name and overrides the same methods that it does, and adds the support for the new Adapter for the ToolStripPanel.

You can now add the factory to the UI Element Adapter Factory Catalog in the AfterShellCreated part of the main shell application:

Dim catalog As IUIElementAdapterFactoryCatalog = _
    RootWorkItem.Services.Get(Of IUIElementAdapterFactoryCatalog)()
catalog.RegisterFactory(New UIElements.ToolStripUIAdapterFactory())

The CAB framework will now handle ToolStripPanels as UI Extension Sites with the appropriate factory. Now all we need is the adapter...

Here is the code for the ToolStripPanel Adapter:

Public Class ToolStripPanelUIAdapter : Inherits UIElementAdapter(Of ToolStrip)
    Private innerToolStripPanel As ToolStripPanel
    Public Sub New(ByVal objToolStripPanel As ToolStripPanel)
        Guard.ArgumentNotNull(objToolStripPanel, "objToolStripPanel")
        Me.innerToolStripPanel = objToolStripPanel
    End Sub
    Protected Overrides Function Add(ByVal uiElement As ToolStrip) _
                                                     As ToolStrip
        If Me.innerToolStripPanel Is Nothing Then
            Throw New InvalidOperationException()
        End If
        Me.innerToolStripPanel.Join(uiElement, 3)
        Return uiElement
    End Function
    Protected Overrides Sub Remove(ByVal uiElement As ToolStrip)
        If Me.innerToolStripPanel.Controls.Contains(uiElement) Then
            Me.innerToolStripPanel.Controls.Remove(uiElement)
        End If
    End Sub
End Class

This provides the functionality to allow you to register a site that is of type ToolStripPanel:

RootWorkItem.UIExtensionSites.RegisterSite("MainToolStripPanelSiteName", 
             Me.Shell.InnerToolStripContainer.TopToolStripPanel)

This code registers the top panel, but you can register another or all of them, but only on separate sites. Once you have registered the site, you can create and add ToolStrips to it:

Dim objToolStip As New System.Windows.Forms.ToolStrip
LocalWorkItem.UIExtensionSites("MainToolStripPanelSiteName").Add(objToolStip)
LocalWorkItem.UIExtensionSites.RegisterSite("MyCustomToolStripSitename", _
                                            objToolStip)

Don't forget the second registration that allows you to add a button to the ToolStrip.

All done... You should now be able to create dynamic tool strips and populate them. If you want to customise a command, you will need to create a command adapter for the ToolStripPanel and add it to CAB.

License

This article, along with any associated source code and files, is licensed under The Microsoft Public License (Ms-PL)

Share

About the Author

Martin Hinshelwood
Instructor / Trainer naked ALM
United States United States

About the Author: Martin has worked with many customers in government, finance, manufacturing, health and technology to help them improve their processes and deliver more. He provides management and technical consulting that intends to expose processes and practices to gain transparency, uncover impediments to value delivery and reduce cycle-time as part of an organisations path to agility. Martin is a Professional Scrum Trainer as well as a Visual Studio ALM MVP and Visual Studio ALM Ranger. He writes regularly on http://nakedalm.com/blog, and speaks often on Scrum, good practices and Visual Studio ALM.

You can get in touch with Martin through naked ALM.

Follow on   Twitter   Google+

Comments and Discussions

 
Questionlol cab... PinmemberElkay17-Dec-12 6:45 
GeneralMistake Pinmembernayato17-Jan-07 23:31 
GeneralRe: Mistake PinmemberEdward Wilson14-May-07 7:05 
GeneralCAB? CAB! Pinmembermav.northwind26-Jun-06 4:15 
GeneralRe: CAB? CAB! Pinmemberpointnetsolutions26-Jun-06 9:41 
GeneralRe: CAB? CAB! Pinmemberhinshelwm26-Jun-06 10:11 
GeneralRe: CAB? CAB! PinmemberElkay2-May-13 6:16 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web04 | 2.8.140921.1 | Last Updated 26 Jun 2006
Article Copyright 2006 by Martin Hinshelwood
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid