XP Style Collapsible GroupBox

jordanhammond

Rate me:

4.84/5 (33 votes)

31 Jan 20063 min read

246.1K

8.1K

160

This article describes an XP style collapsible GroupBox.

Introduction

Sometimes, there is the need to display information in a container that can be collapsed. Sure there are controls like the XP Sidebar et all, but for my requirements, I wanted something that looked and worked exactly like a standard GroupBox. So, I simply extended the GroupBox control to provide this functionality.

Background

I searched the web for existing controls and came across one by jeffb42 which was pretty much what I wanted, however I have been developing in .NET 2.0 only for some time now, and the old format design did not sit well with the normal GroupBoxes on my forms. Also, that version did not allow me to easily add other controls to the box for some reason. So, I created my own based on the one by jeffb42.

Using the code

This control is so simple that it barely warrants instructions. It can be used as a normal GroupBox is. Full design time support is provided so simply drag & drop the control onto your form and add what you wish to it.

Behind the control

Looking through the code, one can see that not much was required to create this control. The usual suspects were overridden to control the paint and the handling of the mouse clicking the Collapsed state toggle button.

protected override void OnMouseUp(MouseEventArgs e)
{
    if (m_toggleRect.Contains(e.Location))
        ToggleCollapsed();
    else
        base.OnMouseUp(e);
}

protected override void OnPaint(PaintEventArgs e)
{
    HandleResize();
    DrawGroupBox(e.Graphics);
    DrawToggleButton(e.Graphics);
}

For the painting, I used a method found in System.Windows.Forms called DrawGroupBox. This takes away all need to draw arcs and lines or worry about matching the colour of the normal GroupBox. However, when the GroupBox text is drawn on this box, you will get a strikeout effect. To overcome this, I draw a line the same length as the measured text in the colour of the control so that it will not be seen.

void DrawGroupBox(Graphics g)
{
    // Get windows to draw the GroupBox
    Rectangle bounds = new Rectangle(ClientRectangle.X, 
       ClientRectangle.Y + 6, ClientRectangle.Width, 
       ClientRectangle.Height - 6);
    GroupBoxRenderer.DrawGroupBox(g, bounds, Enabled ? 
       GroupBoxState.Normal : GroupBoxState.Disabled);

    // Text Formating positioning & Size
    StringFormat sf = new StringFormat();
    int i_textPos = (bounds.X + 8) + m_toggleRect.Width + 2;
    int i_textSize = (int)g.MeasureString(Text, this.Font).Width;
    i_textSize = i_textSize < 1 ? 1 : i_textSize;
    int i_endPos = i_textPos + i_textSize + 1;

    // Draw a line to cover the GroupBox
    // border where the text will sit
    g.DrawLine(SystemPens.Control, i_textPos, 
               bounds.Y, i_endPos, bounds.Y);

    // Draw the GroupBox text
    using (SolidBrush drawBrush = new 
               SolidBrush(Color.FromArgb(0, 70, 213)))
        g.DrawString(Text, this.Font, drawBrush, i_textPos, 0);
}

void DrawToggleButton(Graphics g)
{
    if(IsCollapsed)
        g.DrawImage(Properties.Resources.plus, m_toggleRect);
    else
        g.DrawImage(Properties.Resources.minus, m_toggleRect);
}

Points of Interest

If you are using this control in a DockStyle state of Fill then you will notice the control does not collapse. This is because the parent control forces the control to fill its space. Therefore, there is an event on the control which fires when the collapsed state changes. This can be used by the parent control to resize itself to the size of the GroupBox.

History

OK, after a request for a 1.1 version of this control, I thought I would give it a shot. After not using Visual Studio 2003 for around a year, it was a shock to switch back to it. Now, a lot of the methods that I used in the 2.0 solution were not available in 1.1, especially drawing a rounded rectangle. Rather than calculating all the points and curves myself, I looked through CodeProject because surely someone had done it before. And of course someone has, Arun Reginald's article provided a simple solution.

The rest is pretty much the same as in the 2.0 solution. I used Barretto VN's idea to add XP theming to all the controls used in the project.

License

This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here

Written By

jordanhammond

Web Developer

United Kingdom

I write code.

/// <summary> /// CollapsibleGroupBoxDesigner is an control designer for the that /// CollapsibleGroupBox. Allows mouse clicks on the collapse button. /// </summary> [System.Security.Permissions.PermissionSet(System.Security.Permissions.SecurityAction.Demand, Name = "FullTrust")] public class CollapsibleGroupBoxDesigner : System.Windows.Forms.Design.ParentControlDesigner { // This boolean state reflects whether the mouse is over the control. protected override bool GetHitTest(Point point) { CollapsibleGroupBox me = this.Control as CollapsibleGroupBox; if (me.m_toggleRect.Contains(me.PointToClient(point))) { // we can handle that; user clicked on toggle box. return true; } //Nope not interested return false; } }

/// <summary> /// GroupBox control that provides functionality to /// allow it to be collapsed. /// </summary> [ToolboxBitmap(typeof(CollapsibleGroupBox))] [DesignerAttribute(typeof(CollapsibleGroupBoxDesigner))] public partial class CollapsibleGroupBox : GroupBox { .... public Rectangle m_toggleRect = new Rectangle(8, 2, 11, 11); // not private .... /// <summary> /// Save the size if control is collapsed. VS will serialize the attribute for us. /// It is also shown in properties. /// </summary> [DefaultValue(false), Browsable(true), DesignerSerializationVisibility(DesignerSerializationVisibility.Visible)] public Size FullSize { get { return m_FullSize; } set { m_FullSize = value; } }

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