Click here to Skip to main content
15,867,756 members
Articles / Programming Languages / C#
Article

Implementing an OwnerDrawn ComboBox

Rate me:
Please Sign up or sign in to vote.
4.83/5 (24 votes)
3 Feb 20021 min read 327.6K   3.6K   61   37
This article shows how to create an OwnerDrawn combobox

Sample Image - OwnerDrawnComboBox.gif

Introduction

Hi there, I've been waiting for ages and ages for someone to kindly post the code for an owner drawn ComboBox but alas, to no avail. That's right, I'm your average, lowly leech and I've been stealing code off CodeProject for a long time now. Well looks like this time I actually had to go write something on my own. My guess is it was too simple a problem for most of you to bother with. But please do keep writing articles for relative beginners because most of us have to start with the simple things first. Luckily, writing the code turned out to be childs play with the .NET framework.

Ok, lets begin. First thing to do is drop a ComboBox onto a form and change it's DrawMode property to OwnerDrawFixed. This will mean that all the items appearing in the ComboBox will have the same dimensons. If you're going to draw items in the ComboBox that are of variable sizes then you would change the property to OwnerDrawVariable and be forced to deal with a MeasureItem event. I won't be covering that here. Next, create a DataSource for the ComboBox, as well as a corresponding collection of images. In my case I simply used two Arrays The following code should now be easy enough to follow

The Code

using System;
using System.Drawing;
using System.Collections;
using System.ComponentModel;
using System.Windows.Forms;
using System.Data;

namespace WindowsApplication7
{    
    public class Form1 : System.Windows.Forms.Form
    {        
        private System.ComponentModel.Container components = null;
        private String[] arr;
        private Image[] imageArr;
        private System.Windows.Forms.ComboBox comboBox1;        
        public Font myFont;        
        
        public Form1()
        {            
            InitializeComponent();
            myFont = new System.Drawing.Font("Comic Sans", 11);
            
            arr = new String[4];
            arr[0] = "Smiley Red Face";
            arr[1] = "Smiley Cry";
            arr[2] = "Smiley Big Grin";
            arr[3]  = "Smiley Suss";
            
            this.comboBox1.DataSource = arr; //set the combo's data source to out array

            imageArr = new Image[4];

            /* I stole these images off CP. I specifically chose these images because they 
            are all little 16x16 sized gifs. If you're going to use your own images make 
            sure they are all the same size, otherwise your code won't work as advertised. 
            In that case you will have to set the DrawMode property of your combobox to 
            OwnnerDrawVariable and catch the MeasureItem event*/

            imageArr[0] = new Bitmap("C:\\smiley_redface.gif");
            imageArr[1] = new Bitmap("C:\\smiley_cry.gif");
            imageArr[2] = new Bitmap("C:\\smiley_biggrin.gif");
            imageArr[3] = new Bitmap("C:\\smiley_suss.gif");
        }        
        
        //You have your windows forms designer generated code here

        [STAThread]
        static void Main() 
        {
            Application.Run(new Form1());
        }

        private void comboBox1_DrawItem(object sender, 
                                        System.Windows.Forms.DrawItemEventArgs e)
        {    
            // Let's highlight the currently selected item like any well 
            // behaved combo box should
            e.Graphics.FillRectangle(Brushes.Bisque, e.Bounds);                
            e.Graphics.DrawString(arr[e.Index], myFont, Brushes.Blue, 
                                  new Point(imageArr[e.Index].Width*2,e.Bounds.Y));       
            e.Graphics.DrawImage(imageArr[e.Index], new Point(e.Bounds.X, e.Bounds.Y));   
            
            //is the mouse hovering over a combobox item??            
            if((e.State & DrawItemState.Focus)==0)
            {                                                    
                //this code keeps the last item drawn from having a Bisque background. 
                e.Graphics.FillRectangle(Brushes.White, e.Bounds);                    
                e.Graphics.DrawString(arr[e.Index], myFont, Brushes.Blue, 
                                      new Point(imageArr[e.Index].Width*2,e.Bounds.Y));
                e.Graphics.DrawImage(imageArr[e.Index], new Point(e.Bounds.X, e.Bounds.Y)); 
            }    
        }                                                                
    }
}

Conclusion

Ok, that's it, my very first CodeProject article, go easy on me. The code started out quite long and tedious but I whittled it down as my understanding of DrawItemEventArgs became a bit clearer. I'm not too sure if it's cool to have the ComboBox default backcolor to be anything other than white. But that seems to be more a matter of taste.

Regards, Senkwe

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
Web Developer
South Africa South Africa
Nada

Comments and Discussions

 
GeneralMy vote of 5 Pin
Manoj Kumar Choubey20-Feb-12 1:49
professionalManoj Kumar Choubey20-Feb-12 1:49 
QuestionHow do I implement and host an owner drawn combobox inside DataGridView cells in C# Pin
Rodzaidi11-May-08 23:25
Rodzaidi11-May-08 23:25 
QuestionAny plan to have Vista look for DropDownLists? Pin
Steph17x28-Sep-07 5:32
Steph17x28-Sep-07 5:32 
GeneralUse this technique to display enumerations with spaces Pin
Boinst15-Apr-07 23:19
Boinst15-Apr-07 23:19 
Hi, thanks for the article, It was a great reference point for a particular problem I had: Populating a ComboBox with values from an enum, and having readable values appear in the ComboBox. Of course, there are a billion ways to do it, but using your technique is the most elegant I have seen thus far.

To share the love, here's the code I used. Nothing original, but someone might find it handy one day:

In the constructor:
__CmbBox.DataSource = Enum.GetValues(typeof(MyEnumeration));
__CmbBox.DrawMode = DrawMode.OwnerDrawFixed;
__CmbBox.DrawItem += new DrawItemEventHandler(UserDrawnComboBox_DrawItem);


Then, the event handler:
/// <summary>Draws the combobox so that there are spaces in the enum name instead_of_under_scores.</summary>
/// <remarks>see also: http://www.codeproject.com/cs/combobox/ownerdrawncombobox.asp
/// FOSS FTW!</remarks>
void UserDrawnComboBox_DrawItem(object sender, DrawItemEventArgs e)
{
    ComboBox CmbSender = (ComboBox)sender;
    string text = CmbSender.Items[e.Index].ToString().Replace('_', ' ');
    SolidBrush TextBrush = new SolidBrush(CmbSender.ForeColor);
    Brush BackgroundBrush = ((e.State & DrawItemState.Focus) == 0) //mouse hover?
                        ? new SolidBrush(CmbSender.BackColor)
                        : SystemBrushes.Highlight;

    e.Graphics.FillRectangle(BackgroundBrush, e.Bounds);
    e.Graphics.DrawString(text, CmbSender.Font, TextBrush, new Point(e.Bounds.X, e.Bounds.Y));
}


Thanks again!


NewsAdvanced list box and combo box Pin
brett5630-Nov-05 5:24
brett5630-Nov-05 5:24 
GeneralColors in Combo Box Pin
yahya_1322-Jan-05 22:22
yahya_1322-Jan-05 22:22 
GeneralRe: Colors in Combo Box Pin
MoustafaS6-May-05 9:26
MoustafaS6-May-05 9:26 
GeneralChanges to have a kind of simple ComboTree Pin
Vejas6-Jun-04 23:00
Vejas6-Jun-04 23:00 
GeneralShow ComboBox in Web Application Form Pin
selcanberber9-Jan-04 0:56
selcanberber9-Jan-04 0:56 
QuestionHow to write a check combo Pin
xalee15-Dec-03 13:45
xalee15-Dec-03 13:45 
AnswerRe: How to write a check combo Pin
b.hartmann20-Jan-04 20:47
b.hartmann20-Jan-04 20:47 
Generaldrawing a form as the object Pin
Almighty Bob4-Sep-03 7:01
Almighty Bob4-Sep-03 7:01 
GeneralRe: drawing a form as the object Pin
Alex Korchemniy4-Oct-03 11:11
Alex Korchemniy4-Oct-03 11:11 
GeneralComboBox Error Behavior Pin
Donny Lai1-Sep-03 18:25
Donny Lai1-Sep-03 18:25 
GeneralMaxDropDownItems Pin
Uriel Cohen3-Feb-03 19:47
Uriel Cohen3-Feb-03 19:47 
GeneralThanks for the post Pin
6-Mar-02 15:35
suss6-Mar-02 15:35 
GeneralRe: Thanks for the post Pin
omkamal30-Jul-03 6:30
omkamal30-Jul-03 6:30 
GeneralRe: Thanks for the post Pin
AniaD24-Oct-03 13:03
AniaD24-Oct-03 13:03 
GeneralPartially working Pin
tedda31-Jan-02 5:15
tedda31-Jan-02 5:15 
GeneralRe: Partially working Pin
Neo Anderson31-Jan-02 6:44
Neo Anderson31-Jan-02 6:44 
GeneralRe: Partially working Pin
Senkwe Chanda31-Jan-02 19:42
Senkwe Chanda31-Jan-02 19:42 
GeneralRe: Partially working Pin
Senkwe Chanda1-Feb-02 2:32
Senkwe Chanda1-Feb-02 2:32 
GeneralRe: Partially working Pin
tedda1-Feb-02 2:58
tedda1-Feb-02 2:58 
GeneralRe: Partially working Pin
Senkwe Chanda1-Feb-02 3:07
Senkwe Chanda1-Feb-02 3:07 
GeneralRe: Partially working Pin
mtg8281431-Jul-03 4:07
mtg8281431-Jul-03 4:07 

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

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