Welcome!

Microsoft Cloud Authors: Lori MacVittie, Elizabeth White, Yeshim Deniz, Serafima Al, Janakiram MSV

Related Topics: Microsoft Cloud

Microsoft Cloud: Article

Dependency Injection and Microsoft Windows Forms

A walkthrough using Microsoft's Composite UI Application Block

The patterns & practices group at Microsoft provides architectural and design guidance for users of Microsoft technologies. Part of the way they do this is by producing and distributing packages called "application blocks." An application block consists of a functional subsystem or software framework that can be valuable in several ways. Application blocks can be implemented in many types of applications as time-saving subsystems. They are also reference examples of software designed and developed using the best practices of Microsoft architecture. Application blocks are freely distributed with all source code and documentation.

The Composite User Interface Application Block
The Composite UI Application Block (called "CAB" in the online community) is the first application block that has been developed exclusively for .NET 2.0. It is an architectural framework that is designed to help developers quickly implement loosely coupled Windows Forms applications. It employs a number of industry standard design patterns, including Model/View/Controller, Inversion of Control/Dependency Injection, and Publish/Subscribe.

Dependency Injection is a design pattern that was originally developed in the Java community. The basic idea of Dependency Injection is to design software that consists of a number of highly cohesive modules that have predefined interfaces, and to determine the details of how the objects interact with one another at run time. A great in-depth article on Dependency Injection by Martin Fowler can be found at www.martinfowler.com/articles/injection.html.

The goal of this article is to provide a straightforward introduction to CAB that focuses on its implementation of Dependency Injection. It will do this by providing step-by-step instructions for the construction of a simple Windows Forms application.

The demo application that will be built is a very simple master/detail data viewer. The interface will consist of two list boxes. The list box on the left side of the form will display a set of categories. Clicking on one of the items in this list box will cause line items in that category to be displayed in the list box on the right. The sample data we will use will be a set of shopping lists stored in an XML file.

CAB Installation and Prerequisites
The CAB installation package can be downloaded from the Microsoft patterns & practices Web site. In order to install CAB, you must have the .NET 2.0 Framework installed on the development machine. This walkthrough assumes that you will be using Visual Studio 2005 and C# for development.

Create the Shell Application
Open Visual Studio 2005 and create a new project of type "Windows Application." Name the project "DataViewerShell" and change the name of the solution to "ListManager."

Before starting to code we need to bring the CAB assemblies into the solution. You can add references to the compiled assemblies directly, if you have already built CAB, or you can just include the projects in your solution. The CAB assemblies that are used for this walkthrough are: "CompositeUI," "CompositeUI.Utility," "CompositeUI.WinForms," and "ObjectBuilder."

After you have included the CAB assemblies, the first step is to create the shell form. Right-click on the project and add a new Windows Form. Name it "ShellForm.cs." To fulfill the requirements of our sample application, we will need two list boxes to show up on this form: one for the master data on the left and one for the details on the right. Using CAB however, the only thing we will do in the shell is to create placeholders (called "Workspaces") where the controls will reside.

A workspace is a type of control that is included in CAB. If you want to use the designer to add workspaces to the shell form, you may want to load them into the toolbox. Bring up the toolbox if it is hidden or closed, scroll to the bottom, right-click in the "General" section, and select "Choose Items." In the "Choose Toolbox Items" dialog, click on "Browse" and navigate to the location of the "Microsoft.Practices.CompositeUI.WinForms.dll" assembly. Click on this assembly and click "OK," and the CAB workspace controls should load up into your toolbox.

For this example, the type of Workspace we will use will be a DeckWorkspace. This type allows stacking of multiple controls in the same place, like a deck of cards, only displaying the one on top. Drag two DeckWorkspace controls onto the shell form and arrange them as shown in Figure 1. Name the workspace on the left "navigationWorkspace," and the one on the right "viewerWorkspace."

The only actual coding we need to do in the shell is to create the application itself. Add a new class to the project and name it "ShellApplication.cs." This class will define the application object that launches and hosts the shell form. The only thing you need to do to wire this application up for CAB is to have it inherit from "Microsoft.Practices.CompositeUI.WinForms.FormShellApplicaiton<TWorkItem, TShell>."

The type declaration for FormShellApplication<TWorkItem, TShell> takes in two types. TWorkItem is the type of the default WorkItem, which is a basic container class in CAB. The default WorkItem for this shell doesn't need to have any special code in it, as it just acts as an overall container, so we can pass the type "WorkItem," which is the base class. TShell represents the type of the shell form. For TShell, we will specify the type of the shell form that we just created, "ShellForm."

The final step is to add the default static void Main() method to launch an instance of the application. Listing 1 shows the code for the complete ShellApplication class. The base FormShellApplication class does all of the work for us upon initialization: it creates an instance of the default work item and launches an instance of the ShellForm.

The application should build and run at this point. Check in the properties of DataViewerShell that the output type is "Windows Application," then compile and launch the application in the debugger. You should see a blank ShellForm like the one shown in Figure 2.

Create the First Module
CAB provides base container classes called "Modules," which represent sets of related controls and functionality. Using Dependency Injection, modules can be plugged into a shell at run time. CAB user controls are called "SmartParts," since they are context-aware controls that participate in Dependency Injection. The first module we will create for the demo application will be the one that will house the ListBox on the left side of our shell.

Add a new project of type "Class Library" to your solution and name it "ListOrganizerModule." Add references to the four CAB assemblies, but not to the shell application project. The List Organizer module needs three classes in it; one for the user control that holds the ListBox, a WorkItem class to act as a container for injection into the shell, and a class that inherits from the ModuleInit class to house initialization code for the module.

First, create a new User Control and name it "ListOrganizerListBox." In the Visual Studio Designer, drag a ListBox control onto the user control and name it "listBoxLists." This user control will be inserted into the navigationWorkspace on the shell form. Resize the control so that it is approximately the size of the navigationWorkspace.

Next, create the WorkItem. Add a new class to the project, and name it "ListOrganizerWorkItem." Modify the class declaration so that it inherits from Microsoft.Practices.CompositeUI.WorkItem. All we need to do in this class is to write an overload of the "Run" method that takes in the workspace where we want the control to show up. The code for this is shown in Listing 2.

The overload of the "Run" method takes in a parameter of type IWorkspace. It calls the "Show" method on the IWorkspace, passing in a new instance of the ListOrganizerListBox user control. The new instance is created by calling the AddNew<TType> generic factory method on the WorkItem's "Items" property. This method creates an instance of the specified type, injects it into the WorkItem, and returns a reference to it.

Finally, we need to create the ModuleInit class (see Listing 3). This class is the default implementation of IModule, which is the interface that defines a module. Add a new class to the project and name it "ListOrganizerInit.cs." Modify the class declaration so that it inherits from Microsoft.Practices.CompositeUI.ModuleInit.

Add a private member and public property for the parent work item. Mark the property with the "ServiceDependency" attribute - doing this will cause CAB to automatically initialize the value when the application starts.

Override the Load method of the ModuleInit class to load our module into the shell. This override does three things. First, it calls the Load method on the base class. Second, it creates an instance of the ListOrganizerWorkItem class using the generic factory method on the parent work item's collection of work items. Finally, it calls the overload of "Run" on the ListOrganizerWorkItem that we created in that class, which loads our user control into the correct workspace on the shell form.

More Stories By Guy Starbuck

Guy Starbuck is a senior application architect for Stericycle, Inc. He has been working in the software industry for over nine years. Guy lives in Arlington Heights, IL with his wife and son.

Comments (6) View Comments

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


Most Recent Comments
Assen Bogdanov 03/03/06 11:07:47 AM EST

Hi,
I read and implemented the Dependency Injection article and it works beautifully!
I have a question. How does one link the various tab pages as opposed to just the first one? By providing just the control name, e.g. WorkItem.Workspaces["tabWorkspace"], everything always goes to the first TabPage. What would be the way to control which TabPage gets the link?

Thank you

Regards

Assen Bogdanov

realworldsa.dotnetdevelopersjournal.com 01/05/06 09:56:18 AM EST

Trackback Added: Dependency Injection, Generics, Enterprise Library 2.0, Composit; The Composite UI Application Block and the Enterprise Library 2.0 use Generics extensively and introduce dependency injection through the P&P ObjectBuilder framework.If you plan on using the Composite UI Application Block or the Enterprise Library 2.

SYS-CON Brazil News Desk 12/20/05 05:33:10 PM EST

Dependency Injection and Microsoft Windows Forms. The patterns & practices group at Microsoft provides architectural and design guidance for users of Microsoft technologies. Part of the way they do this is by producing and distributing packages called 'application blocks.' An application block consists of a functional subsystem or software framework that can be valuable in several ways. Application blocks can be implemented in many types of applications as time-saving subsystems. They are also reference examples of software designed and developed using the best practices of Microsoft architecture. Application blocks are freely distributed with all source code and documentation.

SYS-CON Belgium News Desk 12/20/05 03:42:56 PM EST

The patterns & practices group at Microsoft provides architectural and design guidance for users of Microsoft technologies. Part of the way they do this is by producing and distributing packages called 'application blocks.' An application block consists of a functional subsystem or software framework that can be valuable in several ways. Application blocks can be implemented in many types of applications as time-saving subsystems. They are also reference examples of software designed and developed using the best practices of Microsoft architecture. Application blocks are freely distributed with all source code and documentation.

SYS-CON Germany News Desk 12/20/05 03:11:31 PM EST

Dependency Injection and Microsoft Windows Forms
The patterns & practices group at Microsoft provides architectural and design guidance for users of Microsoft technologies. Part of the way they do this is by producing and distributing packages called 'application blocks.' An application block consists of a functional subsystem or software framework that can be valuable in several ways. Application blocks can be implemented in many types of applications as time-saving subsystems. They are also reference examples of software designed and developed using the best practices of Microsoft architecture. Application blocks are freely distributed with all source code and documentation.

.NET News Desk 12/20/05 02:25:27 PM EST

Dependency Injection and Microsoft Windows Forms. The patterns & practices group at Microsoft provides architectural and design guidance for users of Microsoft technologies. Part of the way they do this is by producing and distributing packages called 'application blocks.' An application block consists of a functional subsystem or software framework that can be valuable in several ways. Application blocks can be implemented in many types of applications as time-saving subsystems. They are also reference examples of software designed and developed using the best practices of Microsoft architecture. Application blocks are freely distributed with all source code and documentation.

@ThingsExpo Stories
In his keynote at 19th Cloud Expo, Sheng Liang, co-founder and CEO of Rancher Labs, discussed the technological advances and new business opportunities created by the rapid adoption of containers. With the success of Amazon Web Services (AWS) and various open source technologies used to build private clouds, cloud computing has become an essential component of IT strategy. However, users continue to face challenges in implementing clouds, as older technologies evolve and newer ones like Docker c...
DXWorldEXPO LLC announced today that ICC-USA, a computer systems integrator and server manufacturing company focused on developing products and product appliances, will exhibit at the 22nd International CloudEXPO | DXWorldEXPO. DXWordEXPO New York 2018, colocated with CloudEXPO New York 2018 will be held November 11-13, 2018, in New York City. ICC is a computer systems integrator and server manufacturing company focused on developing products and product appliances to meet a wide range of ...
Business professionals no longer wonder if they'll migrate to the cloud; it's now a matter of when. The cloud environment has proved to be a major force in transitioning to an agile business model that enables quick decisions and fast implementation that solidify customer relationships. And when the cloud is combined with the power of cognitive computing, it drives innovation and transformation that achieves astounding competitive advantage.
Cloud-enabled transformation has evolved from cost saving measure to business innovation strategy -- one that combines the cloud with cognitive capabilities to drive market disruption. Learn how you can achieve the insight and agility you need to gain a competitive advantage. Industry-acclaimed CTO and cloud expert, Shankar Kalyana presents. Only the most exceptional IBMers are appointed with the rare distinction of IBM Fellow, the highest technical honor in the company. Shankar has also receive...
Michael Maximilien, better known as max or Dr. Max, is a computer scientist with IBM. At IBM Research Triangle Park, he was a principal engineer for the worldwide industry point-of-sale standard: JavaPOS. At IBM Research, some highlights include pioneering research on semantic Web services, mashups, and cloud computing, and platform-as-a-service. He joined the IBM Cloud Labs in 2014 and works closely with Pivotal Inc., to help make the Cloud Found the best PaaS.
In his Opening Keynote at 21st Cloud Expo, John Considine, General Manager of IBM Cloud Infrastructure, led attendees through the exciting evolution of the cloud. He looked at this major disruption from the perspective of technology, business models, and what this means for enterprises of all sizes. John Considine is General Manager of Cloud Infrastructure Services at IBM. In that role he is responsible for leading IBM’s public cloud infrastructure including strategy, development, and offering m...
DXWorldEXPO LLC announced today that All in Mobile, a mobile app development company from Poland, will exhibit at the 22nd International CloudEXPO | DXWorldEXPO. All In Mobile is a mobile app development company from Poland. Since 2014, they maintain passion for developing mobile applications for enterprises and startups worldwide.
We are seeing a major migration of enterprises applications to the cloud. As cloud and business use of real time applications accelerate, legacy networks are no longer able to architecturally support cloud adoption and deliver the performance and security required by highly distributed enterprises. These outdated solutions have become more costly and complicated to implement, install, manage, and maintain.SD-WAN offers unlimited capabilities for accessing the benefits of the cloud and Internet. ...
Headquartered in Plainsboro, NJ, Synametrics Technologies has provided IT professionals and computer systems developers since 1997. Based on the success of their initial product offerings (WinSQL and DeltaCopy), the company continues to create and hone innovative products that help its customers get more from their computer applications, databases and infrastructure. To date, over one million users around the world have chosen Synametrics solutions to help power their accelerated business or per...
Founded in 2000, Chetu Inc. is a global provider of customized software development solutions and IT staff augmentation services for software technology providers. By providing clients with unparalleled niche technology expertise and industry experience, Chetu has become the premiere long-term, back-end software development partner for start-ups, SMBs, and Fortune 500 companies. Chetu is headquartered in Plantation, Florida, with thirteen offices throughout the U.S. and abroad.
Dion Hinchcliffe is an internationally recognized digital expert, bestselling book author, frequent keynote speaker, analyst, futurist, and transformation expert based in Washington, DC. He is currently Chief Strategy Officer at the industry-leading digital strategy and online community solutions firm, 7Summits.
Bill Schmarzo, author of "Big Data: Understanding How Data Powers Big Business" and "Big Data MBA: Driving Business Strategies with Data Science," is responsible for setting the strategy and defining the Big Data service offerings and capabilities for EMC Global Services Big Data Practice. As the CTO for the Big Data Practice, he is responsible for working with organizations to help them identify where and how to start their big data journeys. He's written several white papers, is an avid blogge...
I think DevOps is now a rambunctious teenager - it's starting to get a mind of its own, wanting to get its own things but it still needs some adult supervision," explained Thomas Hooker, VP of marketing at CollabNet, in this SYS-CON.tv interview at DevOps Summit at 20th Cloud Expo, held June 6-8, 2017, at the Javits Center in New York City, NY.
"MobiDev is a software development company and we do complex, custom software development for everybody from entrepreneurs to large enterprises," explained Alan Winters, U.S. Head of Business Development at MobiDev, in this SYS-CON.tv interview at 21st Cloud Expo, held Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA.
Major trends and emerging technologies – from virtual reality and IoT, to Big Data and algorithms – are helping organizations innovate in the digital era. However, to create real business value, IT must think beyond the ‘what’ of digital transformation to the ‘how’ to harness emerging trends, innovation and disruption. Architecture is the key that underpins and ties all these efforts together. In the digital age, it’s important to invest in architecture, extend the enterprise footprint to the cl...
Data is the fuel that drives the machine learning algorithmic engines and ultimately provides the business value. In his session at Cloud Expo, Ed Featherston, a director and senior enterprise architect at Collaborative Consulting, discussed the key considerations around quality, volume, timeliness, and pedigree that must be dealt with in order to properly fuel that engine.
Two weeks ago (November 3-5), I attended the Cloud Expo Silicon Valley as a speaker, where I presented on the security and privacy due diligence requirements for cloud solutions. Cloud security is a topical issue for every CIO, CISO, and technology buyer. Decision-makers are always looking for insights on how to mitigate the security risks of implementing and using cloud solutions. Based on the presentation topics covered at the conference, as well as the general discussions heard between sessio...
IoT is rapidly becoming mainstream as more and more investments are made into the platforms and technology. As this movement continues to expand and gain momentum it creates a massive wall of noise that can be difficult to sift through. Unfortunately, this inevitably makes IoT less approachable for people to get started with and can hamper efforts to integrate this key technology into your own portfolio. There are so many connected products already in place today with many hundreds more on the h...
No hype cycles or predictions of zillions of things here. IoT is big. You get it. You know your business and have great ideas for a business transformation strategy. What comes next? Time to make it happen. In his session at @ThingsExpo, Jay Mason, Associate Partner at M&S Consulting, presented a step-by-step plan to develop your technology implementation strategy. He discussed the evaluation of communication standards and IoT messaging protocols, data analytics considerations, edge-to-cloud tec...
DXWorldEXPO LLC announced today that the upcoming DXWorldEXPO | CloudEXPO New York event will feature 10 companies from Poland to participate at the "Poland Digital Transformation Pavilion" on November 12-13, 2018.