Welcome!

Microsoft Cloud Authors: Janakiram MSV, Yeshim Deniz, David H Deans, Andreas Grabner, Stackify Blog

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
The Internet giants are fully embracing AI. All the services they offer to their customers are aimed at drawing a map of the world with the data they get. The AIs from these companies are used to build disruptive approaches that cannot be used by established enterprises, which are threatened by these disruptions. However, most leaders underestimate the effect this will have on their businesses. In his session at 21st Cloud Expo, Rene Buest, Director Market Research & Technology Evangelism at Ara...
WebRTC is great technology to build your own communication tools. It will be even more exciting experience it with advanced devices, such as a 360 Camera, 360 microphone, and a depth sensor camera. In his session at @ThingsExpo, Masashi Ganeko, a manager at INFOCOM Corporation, will introduce two experimental projects from his team and what they learned from them. "Shotoku Tamago" uses the robot audition software HARK to track speakers in 360 video of a remote party. "Virtual Teleport" uses a mu...
Internet of @ThingsExpo, taking place October 31 - November 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA, is co-located with 21st Cloud Expo and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The Internet of Things (IoT) is the most profound change in personal and enterprise IT since the creation of the Worldwide Web more than 20 years ago. All major researchers estimate there will be tens of billions devic...
Mobile device usage has increased exponentially during the past several years, as consumers rely on handhelds for everything from news and weather to banking and purchases. What can we expect in the next few years? The way in which we interact with our devices will fundamentally change, as businesses leverage Artificial Intelligence. We already see this taking shape as businesses leverage AI for cost savings and customer responsiveness. This trend will continue, as AI is used for more sophistica...
"When we talk about cloud without compromise what we're talking about is that when people think about 'I need the flexibility of the cloud' - it's the ability to create applications and run them in a cloud environment that's far more flexible,” explained Matthew Finnie, CTO of Interoute, in this SYS-CON.tv interview at 20th Cloud Expo, held June 6-8, 2017, at the Javits Center in New York City, NY.
SYS-CON Events announced today that SourceForge has been named “Media Sponsor” of SYS-CON's 21st International Cloud Expo, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. SourceForge is the largest, most trusted destination for Open Source Software development, collaboration, discovery and download on the web serving over 32 million viewers, 150 million downloads and over 460,000 active development projects each and every month.
SYS-CON Events announced today that DXWorldExpo has been named “Global Sponsor” of SYS-CON's 21st International Cloud Expo, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Digital Transformation is the key issue driving the global enterprise IT business. Digital Transformation is most prominent among Global 2000 enterprises and government institutions.
SYS-CON Events announced today that Nihon Micron will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Nihon Micron Co., Ltd. strives for technological innovation to establish high-density, high-precision processing technology for providing printed circuit board and metal mount RFID tags used for communication devices. For more inf...
SYS-CON Events announced today that Ryobi Systems will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Ryobi Systems Co., Ltd., as an information service company, specialized in business support for local governments and medical industry. We are challenging to achive the precision farming with AI. For more information, visit http:...
SYS-CON Events announced today that mruby Forum will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. mruby is the lightweight implementation of the Ruby language. We introduce mruby and the mruby IoT framework that enhances development productivity. For more information, visit http://forum.mruby.org/.
SYS-CON Events announced today that Mobile Create USA will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Mobile Create USA Inc. is an MVNO-based business model that uses portable communication devices and cellular-based infrastructure in the development, sales, operation and mobile communications systems incorporating GPS capabi...
SYS-CON Events announced today that Keisoku Research Consultant Co. will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Keisoku Research Consultant, Co. offers research and consulting in a wide range of civil engineering-related fields from information construction to preservation of cultural properties. For more information, vi...
SYS-CON Events announced today that MIRAI Inc. will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. MIRAI Inc. are IT consultants from the public sector whose mission is to solve social issues by technology and innovation and to create a meaningful future for people.
SYS-CON Events announced today that Daiya Industry will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Daiya Industry specializes in orthotic support systems and assistive devices with pneumatic artificial muscles in order to contribute to an extended healthy life expectancy. For more information, please visit https://www.daiyak...
SYS-CON Events announced today that Fusic will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Fusic Co. provides mocks as virtual IoT devices. You can customize mocks, and get any amount of data at any time in your test. For more information, visit https://fusic.co.jp/english/.
SYS-CON Events announced today that Interface Corporation will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Interface Corporation is a company developing, manufacturing and marketing high quality and wide variety of industrial computers and interface modules such as PCIs and PCI express. For more information, visit http://www.i...
Elon Musk is among the notable industry figures who worries about the power of AI to destroy rather than help society. Mark Zuckerberg, on the other hand, embraces all that is going on. AI is most powerful when deployed across the vast networks being built for Internets of Things in the manufacturing, transportation and logistics, retail, healthcare, government and other sectors. Is AI transforming IoT for the good or the bad? Do we need to worry about its potential destructive power? Or will we...
SYS-CON Events announced today that Enroute Lab will exhibit at the Japan External Trade Organization (JETRO) Pavilion at SYS-CON's 21st International Cloud Expo®, which will take place on Oct 31 – Nov 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA. Enroute Lab is an industrial design, research and development company of unmanned robotic vehicle system. For more information, please visit http://elab.co.jp/.
In his session at @ThingsExpo, Greg Gorman is the Director, IoT Developer Ecosystem, Watson IoT, will provide a short tutorial on Node-RED, a Node.js-based programming tool for wiring together hardware devices, APIs and online services in new and interesting ways. It provides a browser-based editor that makes it easy to wire together flows using a wide range of nodes in the palette that can be deployed to its runtime in a single-click. There is a large library of contributed nodes that help so...
DevOps at Cloud Expo – being held October 31 - November 2, 2017, at the Santa Clara Convention Center in Santa Clara, CA – announces that its Call for Papers is open. Born out of proven success in agile development, cloud computing, and process automation, DevOps is a macro trend you cannot afford to miss. From showcase success stories from early adopters and web-scale businesses, DevOps is expanding to organizations of all sizes, including the world's largest enterprises – and delivering real r...