Library tutorials & articles

Hosting Windows Forms Designers

Introduction

I decided to write this article not because there is a strong demand for this information, but because there is literally no existing information out there on the topic. The documentation is scarce if any, and aside from a few tidbits thrown out by Microsoft it is a daunting task. It requires you to already be very familiar with the design-time architecture, and have a strong grasp of all the interfaces you commonly use.

All the interfaces you rely on when developing designers and extending the design-time behaviour of your controls, it is now your responsibility to implement. Not only is this a non-trivial task, but it is one of those times where you have to implement a great deal before you can see any progress at all. That said, once you've written the code you'll never have to write it again (and since I'm going to be writing it for this article, you'll never have to write it in the first place).


The accompanying sample application demostrates the code we discuss in this article

Why would you want to host the Windows Forms Designers? Well, there could be lots of reasons. When I was faced with the problem it was because I was writing an IDE for .NET languages and I wanted a visual interface to configure GUIs, just like VS.NET has. When you consider the flexibility of the designer architecture, you realise you have a framework for designing any 2-dimensional hierarchical system. All the code for moving, resizing, creating, deleting and configuring items is already there.

The one you see in VS.NET is running from the framework, and is the same one we'll be writing the code to enable. All the designer stuff is already present in the framework, you just need to write the code to bind it all together. This was best left out of the framework because it is strongly tied to the host environment.

Comments

  1. 15 Jun 2009 at 14:22

    How would I go about saving a form that I have designed?

  2. 10 Dec 2008 at 11:35
    I know I'm replying to very old comments but, for the sake of keeping all info in ONE place and not distributed through different message boards, heres my 2 cents. For persistence, look for designer serialization visibility attribute and the related interfaces (IDesignerSerializationService and such). It's my though that when a component is loaded, the designer must know which properties need persistence. Either that or it uses discovery to find these when ever the designer code file is viewed. For the guy doing the XAML forms thing, changing the name of a component should raise ComponentRenaming/ComponentRenamed on IComponentChangeService or, at the very least, check INameCreationService to find if the name is valid.
  3. 20 Jul 2007 at 20:49

    I have (am still) modifying this code to create a stand-alone Xaml generator for forms. The Xaml is structured for direct consumption by Windows Presentation Foundation. This was a great starting place.

    In the course of my modifications and testing, I found a couple of bugs in the code which you may wish to correct in your source.

    The Name property is listed twice in the property grid.

    If you add a control (i.e. a Button), then change the name from the default (Button1) to anything else, then add another button, you get an unhandled exception. This does not occur if all like controls are added first then the names are modified. The cause is when the control is first added to the designer, it is added to the DesignerHost components collection using the default (Button1) control name as a key. When the Name property is updated, the components collection is not. When adding a second like control, the DesignerHost attempts to add it using the default name as well. However, since the first control was renamed, the default name of the second control is the same as it was for the first (Button1). An unhandled exception is thrown when the second control is added because the components collection already contains a control with the same key value.

    I corrected this by attaching a handler to the PropertyValueChanged event of the PropertyGrid which removes the original entry for the control and readds it with the new name as the key whenever the Name property value is changed.

  4. 17 Jan 2007 at 08:51
    hallo,
    how to change Designer for design PocketPC components?

    htx

    v!tek
  5. 30 Oct 2006 at 09:45

    Hi Tim, great article. I am currently creating a designer in a similar manner to your article, used to create pdf files. I am using it to add only textboxes and pictures, and can save the data to a database.  However I need to bring back the objects and add them to the form programmatically so the user can edit the objects (change the positions etc) Do you know how (or explain how) to add items to the designer surface programmatcally without using the drag and drop from the toolbox

    Thanks

    John Harry

  6. 19 Sep 2006 at 21:39

    Tim:

    Thanks for your nice article.

    How can I get the location of a control in the design surface. I want to show the coordinates when the user moves the control, but I can't figure how!





  7. 11 Jul 2006 at 08:37
    Did you ever figure out how to remove controls from the form?  I need to do that same now

  8. 20 Nov 2005 at 17:52

    Did you figure it out how to persist the designer content? I would appreciate any help on this
    Thanks
    Sgirase

  9. 13 Oct 2005 at 13:00

    Hi!


    That article is really great.  It gave me useful hints to start my application in perfectmanner , which looks like an .Net IDE . but can you please tell me how to remove a control from the designer form ....




  10. 15 Aug 2005 at 20:17

    Hello Tim,


     Thank you very much for this excellent article.  


     We have developed a graphical macro language in C# for our customers and one of the remaining hurdles that we have is the ability to edit the location of controls on a runtime form.  


     When the customer wants to edit our form, we scan our macro and generate controls on the form based upon the macro content.
     We would then like to display that form with the controls where the customer can position and size those controls like you can in this Designer example.  We would then iterate through the list of controls and remember their locations and sizes within the macro.


     Can you please lead us in the right direction?  We have been searching, trying, and reading many examples to no avail.  It appears that you possess this knowledge and could help us.  We are not inexperienced developers, I personally have been a software developer for 22 years in many languages.


      For example, how would you modify this example so that controls can be placed on the form with out the user clicking on the designer surface?


    Thank you very much for your reply,
    Rick Wirch

  11. 12 Aug 2005 at 01:56

    Good question ... I am actually tasked with building a Web Forms Designer.  I can load ASP.NET controls into my toolbox but of course can't drop those controls onto a Windows forms.  Can somebody help me!!  


    Much appreciated -
    Jon

  12. 15 Mar 2005 at 13:23

    Is it possible to use a treeview for that?

  13. 09 Feb 2005 at 12:45
    Hi!

    That article is really great.
    It gave me the needed hints to step into this subject as deep as I wanted to. As i'm currently trying tom write a lightweight IDE for customumizing my own applications, i need to know, how the content auf the designer could be persisted and reloaded.
    Is there any standard-mechanism for that, or will I have to implement my own handlers?

    Any help would be appreciated!
  14. 15 Dec 2004 at 07:28
    what about a Web Forms designer?
    Its possible to do something similar to your example using web forms designer?
  15. 08 Apr 2004 at 05:29

    This article is simply great. I wish to see more like this one.
    Arthur

  16. 01 Jan 1999 at 00:00

    This thread is for discussions of Hosting Windows Forms Designers.

Leave a comment

Sign in or Join us (it's free).

Tim Dawson

Related podcasts

  • A Practical Look at Silverlight 2 Part 1

    Now that Silverlight 2 is at the Olympics and making a big splash, we wanted to explore this fascinating technology more. Microsoft Silverlight 2 is a cross-browser, cross-platform, and cross-device plug-in for delivering the next generation of .NET based media experiences and rich interactive ap...

Events coming up

  • Dec 9

    GL.net Group Meeting - December 2009

    Gloucester, United Kingdom

    The beginning of this year holiday season will belong to mocks. Ronnie and Stephen will take us for a tour around exciting world of unit testing.

Want to stay in touch with what's going on? Follow us on twitter!