An Outlook-like Control

• Download source - 2,952.8 KB

Introduction

This is a control that behaves like the tab control, but has visual cues that look more like the navigation panel in Outlook. Since this is more of a tab control than a navigation panel control, you are free to add as many tabs as you like. The control is made of a collection of tabs, where each tab has two drawing surfaces and an icon. The icon is used when a tab is not visible. Please note that this control is not thread-safe; I will make it thread-safe at some point. If you are interested in making it thread-safe, you will have to modify the Change theme code in all of the controls in the solution.

How to Use the Control

1. Include the following DLLs in your project debug directory, or at least in a directory whose path is known to VS. Better yet, place them in the GAC:
   • AdrdCBC.dll
   • AdrdHDC.dll
   • AdrdNavigationThemes.dll
   • AdrdTBC.dll
   • HDCUserControl.dll
   • NavCtl.dll
   • OtherThemes.dll
2. Set a reference to NavCtl.dll in your project.
3. Add the control to your toolbox. To do this, right click on the toolbox and click "Choose Items."
4. In the "Choose Toolbox Items" dialog box, click "Browse..." and find NavCtl.dll. Alternatively...
5. Once selected, the controls AdrdNC and TabC will be added to your toolbox active tab.
6. Drag and drop the control on any form.
7. Now add a new user control to your project. This user control must visually inherit from the HDCControl as in the next two figures.
8. Design your user control by adding other controls to it.
9. In your code view of the containing form, create a locally scoped variable of type AdrdNavigationTabCollection. The following is a code example.
   C#

   public partial class Form1 : Form
   {
       AdrdNavigationTabCollection TabsCollection = 
           new AdrdNavigationTabCollection();
   
   }

10. In the form Load event, create a variable of type AdrdNavigationTab.
    C#

    AdrdNavigationTab tab = new AdrdNavigationTab();

11. Assign the user control you created in steps 7 and 8 to the AdrdNavigationTab variable HeaderControl and DetailControl properties.
    C#

    tab.HeaderControl = new YOURCONTROL();
    tab.DetailControl = new YOURCONTROL ();

    Note: replace "YOURCONTROL" with your user control name.

12. Add the instant of AdrdNavigationTab you created in step 10 to the collection you created in step 9.
    C#

    TabsCollection.Add(tab);

13. Assign the instant of the collection AdrdNavigationTabCollection to the AllTabsCollection property of the control.
    C#

    this.adrdNC1.AllTabsCollection = TabsCollection;

14. (OPTIONAL) Create the OnTabAction and OnChildClick handlers.
    C#

    this.adrdNC1.OnTabAction += new TabActions(adrdNC1_OnTabAction);
    this.adrdNC1.OnChildClick += new 
    ChildControlWasClickedActions(adrdNC1_OnChildClick);

Important Steps

1. Make sure all your user controls (tabs) inherit from HDCControl.
   C#

   public partial class YOURCONTROL : HDCUserControl.HDCControl

2. To actually make the control pass values back and forth between the different surfaces and/or the containing form, always call the OnAction method of the HDCControl instant. For example, if you included a TreeView control on your HDCControl instant drawing surface and you want to update your containing form with the node text when the node selected is changed, you would do the following:
   • Call the OnAction method in the TreeView AfterSelection event handler like this:
     C#

     void tv_AfterSelect(object sender, 
         System.Windows.Forms.TreeViewEventArgs e)
     {
         OnAction(this, "Node selection Changed");
     }

   • In your container form, code the AdrdNC control OnTabAction event.
3. OnTabAction will pass you the HDCControl control instant that raised the OnAction event and the AdrdNavigationTab item. So, you can have both drawing surfaces to the control and can cause changes on either of the drawing surfaces and/or the containing form.

The attached solution contains a "TestHarness" project that includes most of the implementations of the control. Also, there is a DOC directory in the attached solution that holds some documentation I started working on while developing the control. It's not complete, though.

History

• 17 September, 2007 -- Original version posted
• 26 September, 2007 -- Image added to article