Click here to Skip to main content
Click here to Skip to main content

Collapsible Splitter control in C#

, 26 Aug 2003
Rate this:
Please Sign up or sign in to vote.
A Mozilla-style collapsing splitter control in C#

Introduction

This control was modeled from the collapsible splitter used in the Mozilla web browser, but with some added functionality. This control allows a linked form control to be dynamically expanded and collapsed by clicking on the splitter control button, and resized by dragging the splitter. Additionally, there is an option to expanded or contract the parent form so that the control to expand doesn't take any further form area.

How it works

The CollapsibleSplitter derives from the System.Windows.Forms.Splitter class, working with 2 overrides, mouse event handlers, and exposing 4 new properties. The code is relatively straight-forward, and is well commented. The only code that I will cover here is the control painting and interaction with the base splitter control.

In creating the control, I first started by creating a new derived class with Stephen Toub's DeriveClass utility. The next step was to draw the control surface, first by finding the clip rectangle for the base splitter and then defining a new rectangle located in the vertical center of the splitter for the collapser control.

protected override void OnPaint(PaintEventArgs e)
{
    // force the width to 8px so that everything
    // always draws correctly
    this.Width = 8;

    // create a Graphics object
    Graphics g = e.Graphics;

    // find the rectangle for the splitter and paint it
    Rectangle r = this.ClientRectangle; // fixed in version 1.1
    g.FillRectangle(new SolidBrush(this.BackColor), r);

    // create a new rectangle in the vertical center 
    // of the splitter for our collapse control button
    rr = new Rectangle(r.X, (int) r.Y + ((r.Height - 115)/2),
        8, 115);

    // draw the background color for our control image
    if(hot)
        g.FillRectangle(new SolidBrush(hotColor), 
            new Rectangle(rr.X + 1, rr.Y, 6, 115));
    else
        g.FillRectangle(new SolidBrush(this.BackColor), 
            new Rectangle(rr.X + 1, rr.Y, 6, 115));

    // draw the top & bottom lines for our control image
    g.DrawLine(new Pen(SystemColors.ControlDark, 1), 
        rr.X + 1, rr.Y, rr.X + rr.Width - 2, rr.Y);
    g.DrawLine(new Pen(SystemColors.ControlDark, 1), 
        rr.X + 1, rr.Y + rr.Height, rr.X + rr.Width - 2, 
        rr.Y + rr.Height);

    // draw the arrows for our control image
    // the ArrowPointArray is a point array that 
    // defines an arrow shaped polygon
    g.FillPolygon(new SolidBrush(SystemColors.ControlDarkDark), 
        ArrowPointArray(rr.X + 2, rr.Y + 3));

    g.FillPolygon(new SolidBrush(SystemColors.ControlDarkDark), 
        ArrowPointArray(rr.X + 2, rr.Y + rr.Height - 9));

    // draw the dots for our control image using a loop
    int x = rr.X + 3;
    int y = rr.Y + 14;

    // Visual Styles added in version 1.1
    switch(visualStyle)
    {
    case VisualStyles.Mozilla:
        for(int i=0; i < 30; i++)
        {
            // light dot
            g.DrawLine(
                new Pen(SystemColors.ControlLightLight), 
                x, y + (i*3), x+1, y + 1 + (i*3));

            // dark dot
            g.DrawLine(
                new Pen(SystemColors.ControlDarkDark), 
                x+1, y + 1 + (i*3), x+2, y + 2 + (i*3));

            // overdraw the background color as we actually 
            // drew 2px diagonal lines, not just dots..
            if(hot)
                g.DrawLine(new Pen(hotColor), 
                    x+2, y + 1 + (i*3), x+2, y + 2 + (i*3));
            else
                g.DrawLine(new Pen(this.BackColor), 
                    x+2, y + 1 + (i*3), x+2, y + 2 + (i*3));
        }
        break;

    case VisualStyles.DoubleDots:
        for(int i=0; i < 30; i++)
        {
            // light dot
            g.DrawRectangle(
                new Pen(SystemColors.ControlLightLight), 
                x, y + 1 + (i*3), 1, 1 );

            // dark dot
            g.DrawRectangle(
                new Pen(SystemColors.ControlDark), 
                x - 1, y +(i*3), 1, 1 );

            i++;

            // light dot
            g.DrawRectangle(
                new Pen(SystemColors.ControlLightLight), 
                x + 2, y + 1 + (i*3), 1, 1 );

            // dark dot
            g.DrawRectangle(
                new Pen(SystemColors.ControlDark), 
                x + 1, y  + (i*3), 1, 1 );
        }
        break;

    case VisualStyles.Win9x:
        g.DrawLine(new Pen(SystemColors.ControlLightLight), 
            x, y, x + 2, y);
        g.DrawLine(new Pen(SystemColors.ControlLightLight), 
            x, y, x,y + 90);
        g.DrawLine(new Pen(SystemColors.ControlDark), 
            x + 2, y, x + 2, y + 90);
        g.DrawLine(new Pen(SystemColors.ControlDark), 
            x, y + 90, x + 2, y + 90);
        break;

    case VisualStyles.XP:
        for(int i=0; i < 18; i++)
        {
            // light dot
            g.DrawRectangle(
                new Pen(SystemColors.ControlLight), 
                x, y + (i*5), 2, 2 );

            // light light dot
            g.DrawRectangle(
                new Pen(SystemColors.ControlLightLight), 
                x + 1, y + 1 + (i*5), 1, 1 );

            // dark dark dot
            g.DrawRectangle(
                new Pen(SystemColors.ControlDarkDark), 
                x, y +(i*5), 1, 1 );

            // dark fill
            g.DrawLine(
                new Pen(SystemColors.ControlDark), 
                x, y + (i*5), x, y + (i*5) + 1);

            g.DrawLine(
                new Pen(SystemColors.ControlDark), 
                x, y + (i*5), x + 1, y + (i*5));
        }
        break;

    case VisualStyles.Lines:
        for(int i=0; i < 44; i++)
        {
            g.DrawLine(new Pen(SystemColors.ControlDark), 
                x, y + (i*2), x + 2, y + (i*2));
        }

        break;
    }

    // dispose the Graphics object
    g.Dispose();
}

The control rectangle is used in the MouseMove event to determine if the cursor is within the control area (hot), or in the base controls splitter area.  Once we know whether the cursor is in the 'hot' area we can change various aspects of the control:  use a highlighted background color, ignore or pass on the MouseDown event, and also set the appropriate mouse cursor.

// this method was updated in version 1.11 to fix 
// a flickering problem discovered by John O'Byrne
private void OnMouseMove(object sender, MouseEventArgs e)
{
    // check to see if the mouse cursor position is within 
    // the bounds of our control
    if(e.X >= rr.X && e.X <= rr.X + rr.Width && 
        e.Y >= rr.Y && e.Y <= rr.Y + rr.Height)
    {
        if(!hot)
        {
            hot = true;
            this.Cursor = Cursors.Hand;
            this.Refresh();
        }
    }
    else
    {
        if(hot)
        {
            hot = false;
            this.Refresh();
        }

        if(!controlToHide.Visible)
            this.Cursor = Cursors.Default;
        else
            this.Cursor = Cursors.VSplit;
    }
}

protected override void OnMouseDown(MouseEventArgs e)
{
    // if the hider control isn't hot, 
    // let the base resize action occur
    if(!hot && !collapsed)
        base.OnMouseDown(e);
}

Using the control

The CollapsibleSplitter control can be added to the toolbox using the pre-compiled dll in the demo application, or simply copy the class into your project and manually reference it in your code.

To Add the Collapsible Splitter to your VS.Net toolbox, follow these steps:

  • Right-click on the VS.Net Toolbox and select "Customize Toolbox..."
  • Select the ".Net Framework Components" tab, and click the "Browse.." button
  • Browse to and open the "CollapsibleSplitter.dll" file from the demo application archive
  • Click OK to add Collapsible Splitter control to your Toolbox.

Once you have it on a form, set the Dock property, and then set the ControlToHideproperty so that the splitter knows which form control to interact with. All properties specific to the collapsing behaviour can be found under the Collapsing Options group in the properties window. Once created on your form, the view state can be programmatically toggled by calling the ToggleState method, and the current state can be retrieved from the IsCollapsed property.

I hope you find this control useful, and if you improve this control, please email me the updated source. If you have any comments or suggestions, please post your thoughts in the feedback section below.

Updates

Version 1.1 Changes:

  • OnPaint is now overridden instead of being a handled event, and the entire splitter is now painted rather than just the collapser control
  • The splitter rectangle is now correctly defined
  • The Collapsed property was renamed to IsCollapsed, and the code changed so that no value needs to be set
  • New visual styles added: Win9x, XP, DoubleDots and Lines

Version 1.11 Changes:

  • The OnMouseMove event handler was updated to address a flickering issue discovered by John O'Byrne

Version 1.2 Changes:

  • Added support for Horizontal Splitters

Version 1.3 Changes: (24 Aug 2003)

  • Added an optional 3D border
  • General code and comment cleaning
  • Flagged assembly with the CLSCompliant attribute
  • Added a simple designer class to filter unwanted properties
  • Added support for inclusion as a VS.Net ToolBox control
  • Added a ToolBox bitmap
  • Removed extraneous overrides
  • Added summaries
  • Removed the ParentFolder from public properties - this is now set automatically in the OnHandleCreated event
  • Added expand/collapse animation code

License

This article, along with any associated source code and files, is licensed under The Microsoft Public License (Ms-PL)

Share

About the Author

Furty
Web Developer
Thailand Thailand
Furty will code for food.

Comments and Discussions

 
GeneralIsCollapsed property issue with Animation Pinmembercsager2-Jun-04 8:30 
GeneralRe: IsCollapsed property issue with Animation PinmemberFurty2-Jun-04 16:01 
GeneralGood job!-----thanks PinmemberGE - NBGYF30-May-04 20:40 
GeneralRe: Good job!-----thanks PinmemberFurty30-May-04 23:21 
GeneralRe: Good job!-----thanks PinmemberGE - NBGYF21-Jun-05 21:44 
GeneralLooks real nice, great work! PinmemberiGhost15-Apr-04 22:51 
QuestionFlicker bug when hovering over the splitter? Pinmemberdxben29-Mar-04 13:03 
AnswerRe: Flicker bug when hovering over the splitter? PinmemberFurty29-Mar-04 13:08 
GeneralRe: Flicker bug when hovering over the splitter? Pinmemberdxben29-Mar-04 14:16 
QuestionWhy does it start collapsed? PinmemberJustin F.17-Mar-04 6:49 
AnswerRe: Why does it start collapsed? PinmemberFurty29-Mar-04 13:13 
GeneralLicense Information PinmemberFurty8-Mar-04 13:45 
Generalabout your module Pinmemberyu-yu7-Mar-04 19:18 
GeneralRe: about your module Pinmemberyu-yu7-Mar-04 21:22 
Generalcollapsiblesplitter location on windows form Pinmemberseash3-Mar-04 0:07 
GeneralCouple of Questions Pinmemberbimjo21-Feb-04 8:15 
GeneralRe: Couple of Questions PinmemberFurty21-Feb-04 14:29 
GeneralRe: Couple of Questions Pinmemberbimjo22-Feb-04 5:06 
Questionbug? Pinmemberbtrotter12-Jan-04 21:14 
AnswerRe: bug? PinmemberFurty16-Jan-04 19:04 
AnswerRe: bug? PinmemberZeGe19-Jan-04 23:45 
GeneralWOW, that's cool PinmemberRJ25-Nov-03 22:02 
GeneralIt works PinsitebuilderPaul Watson4-Nov-03 2:43 
GeneralCosMetic bug was found with Magic Menu Control PinmemberMag60428-Sep-03 8:55 
GeneralRe: CosMetic bug was found with Magic Menu Control PinmemberFurty28-Sep-03 14:28 
GeneralRe: CosMetic bug was found with Magic Menu Control PinmemberFurty1-Oct-03 14:40 
Generalsome fixes PinmemberTadeusz Dracz9-Sep-03 23:24 
GeneralUpdated Version PinmemberFurty23-Aug-03 19:16 
GeneralRe: Updated Version Pinmemberzhangzq7127-Aug-03 13:21 
GeneralRe: Updated Version PinmemberFurty29-Aug-03 1:36 
GeneralRe: Updated Version Pinmemberggp260811-Nov-03 13:34 
GeneralKnowing when the splitter collapses Pinmemberwenneman11-Aug-03 11:00 
GeneralRe: Knowing when the splitter collapses PinmemberFurty23-Aug-03 19:20 
QuestionAnyone know of a collapsible splitter written in MFC? Pinsussmika_Cohen16-Jun-03 3:08 
AnswerRe: Anyone know of a collapsible splitter written in MFC? PinmemberFurty23-Aug-03 19:23 
GeneralHelp a new guy Pinsussstfarm11-Feb-03 7:18 
GeneralCan't see on form... PinmemberBadDude16-Jan-03 4:51 
GeneralCollapsibleSplitter DLL in VB.NET PinmemberVenturerX10-Dec-02 9:36 
GeneralRe: CollapsibleSplitter DLL in VB.NET PinmemberFurty11-Dec-02 12:43 
GeneralRe: CollapsibleSplitter DLL in VB.NET PinmemberVenturerX27-Dec-02 6:21 
GeneralImproving Design-time Functionality PinmemberDerek Lakin9-Dec-02 3:11 
Generalexception thrown when using as a toolbox component PinmemberTadeusz Dracz4-Dec-02 5:40 
GeneralRe: exception thrown when using as a toolbox component PinmemberKarlTschuemperlin18-Jun-03 1:05 
QuestionHow to put this component into the toolbox? PinsussAnonymous20-Oct-02 1:05 
AnswerRe: How to put this component into the toolbox? PinmemberFurty20-Oct-02 1:48 
GeneralRe: How to put this component into the toolbox? PinsussAnonymous20-Oct-02 21:28 
GeneralRe: How to put this component into the toolbox? PinmemberFurty20-Oct-02 22:52 
GeneralRe: How to put this component into the toolbox? PinmemberFurty20-Oct-02 22:54 
GeneralRe: How to put this component into the toolbox? PinsussAnonymous21-Oct-02 3:12 
GeneralRe: How to put this component into the toolbox? Pinmembervbnetuk30-Jul-03 4:40 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

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

| Advertise | Privacy | Mobile
Web03 | 2.8.140827.1 | Last Updated 27 Aug 2003
Article Copyright 2002 by Furty
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid