ImageCombo.cs

using System;
using System.ComponentModel;
using System.Drawing;
using System.Windows.Forms;
using be.gaudry.model.drawing;
 
namespace be.gaudry.view.controls
{
	public class ImageComboBox : ComboBox
	{
        #region constructors and declarations
        private ImageList imageList;
        private ContentAlignment textAlignment;
        private ContentAlignment imageAlignment;
        private StringFormat stringFormat;
        private SolidBrush solidBrush;
        private bool allowDuplicates, allowTextEdition;
 
        public ImageComboBox()
        {
            this.DrawMode = DrawMode.OwnerDrawFixed;
            textAlignment = ContentAlignment.MiddleLeft;
            imageAlignment = ContentAlignment.MiddleLeft;
            solidBrush = new SolidBrush(this.ForeColor);
            stringFormat = new StringFormat();
            //this.DropDownStyle = ComboBoxStyle.DropDown;
            setAlignment();
        }
 
        #endregion
 
		#region Attributes
        /// <summary>
        /// Specifies alignment of text on the drawing surface.
        /// </summary>
		[
        Category("ImageComboBox"),
        Browsable(true),
        Description("Specifies alignment of text on the drawing surface."),
        DefaultValue(ContentAlignment.MiddleLeft)
        ]
		public ContentAlignment TextAlignment
		{
			get{return textAlignment;}
			set{textAlignment = value;}
		}
        /// <summary>
        /// Specifies alignment of the image on the drawing surface.
        /// </summary>
        [
        Category("ImageComboBox"),
        Browsable(true),
        Description("Specifies alignment of the image on the drawing surface."),
        DefaultValue(ContentAlignment.MiddleLeft)
        ]
        public ContentAlignment ImageAlignment
		{
			get{return imageAlignment;}
			set{imageAlignment = value;}
		}
        /// <summary>
        /// Gets or sets the <code>ImageList</code> to use.
        /// </summary>
        [
        Category("ImageComboBox"),
        Browsable(true),
        Description("Provides methods to manage a collection of System.Drawing.Image objects."),
        DefaultValue(null)
        ]
        public ImageList ImageList
		{
			get{return imageList;}
			set{imageList = value;}
		}
        /// <summary>
        /// Allows duplicates in the collection of values 
        /// Default value is true(quickest).
        /// </summary>
        [
        Category("ImageComboBox"),
        Browsable(true),
        Description("Allows duplicates in the collection of values (quickest)."),
        DefaultValue(true)
        ]
        public bool AllowDuplicates
        {
            get { return allowDuplicates; }
            set { allowDuplicates = value; }
        }
        /// <summary>
        /// Allows text edition. 
        /// Default value is false.
        /// </summary>
        [
        Category("ImageComboBox"),
        Browsable(true),
        Description("Allows text edition."),
        DefaultValue(false)
        ]
        public bool AllowTextEdition
        {
            get { return allowTextEdition; }
            set { allowTextEdition = value; }
        }
        /// <summary>
        /// Gets or sets the text that is selected in the editable portion of a <code>be.gaudry.view.controls.ImageComboBox</code>.
        /// </summary>
        [
        Category("ImageComboBox"),
        Browsable(false),
        Description("Gets or sets the text that is selected in the editable portion of a be.gaudry.view.controls.ImageComboBox."),
        DefaultValue(null)
        ]
        public String SelectedInnerText
        {
            get { return (SelectedItem!=null)?SelectedItem.ToString():null; }
            set
            {
                if (string.Empty.Equals(value))
                    return;
                int j = Items.Count;
                for (int i = 0; i > j; i++)
                {
                    if ((value).Equals(((ImageComboBoxItem)Items[i]).Text))
                    {
                        SelectedIndex = i;
                        return;
                    }
                }
            }
        }
		#endregion
 
        #region private methods
        private void setAlignment()
        {
            //Horizontal align
            if (this.TextAlignment == ContentAlignment.BottomLeft ||
                this.TextAlignment == ContentAlignment.MiddleLeft ||
                this.TextAlignment == ContentAlignment.TopLeft
                )
                stringFormat.Alignment = StringAlignment.Near;
 
            if (this.TextAlignment == ContentAlignment.BottomCenter ||
                this.TextAlignment == ContentAlignment.MiddleCenter ||
                this.TextAlignment == ContentAlignment.TopCenter
                )
                stringFormat.Alignment = StringAlignment.Center;
 
            if (this.TextAlignment == ContentAlignment.BottomRight ||
                this.TextAlignment == ContentAlignment.MiddleRight ||
                this.TextAlignment == ContentAlignment.TopRight
                )
                stringFormat.Alignment = StringAlignment.Far;
 
            //Vertical align
            if (this.TextAlignment == ContentAlignment.BottomCenter ||
                this.TextAlignment == ContentAlignment.BottomLeft ||
                this.TextAlignment == ContentAlignment.BottomRight
                )
                stringFormat.LineAlignment = StringAlignment.Far;
 
            if (this.TextAlignment == ContentAlignment.TopCenter ||
                this.TextAlignment == ContentAlignment.TopLeft ||
                this.TextAlignment == ContentAlignment.TopRight
                )
                stringFormat.LineAlignment = StringAlignment.Near;
 
            if (this.TextAlignment == ContentAlignment.MiddleCenter ||
                this.TextAlignment == ContentAlignment.MiddleLeft ||
                this.TextAlignment == ContentAlignment.MiddleRight
                )
                stringFormat.LineAlignment = StringAlignment.Center;
        } 
        #endregion
 
        #region public methods
        /// <summary>
        /// todo
        /// </summary>
        /// <param name="text"></param>
        public void addItem(String text)
        {
            //create a new item
            throw new NotImplementedException();
        }
        /// <summary>
        /// Add a new item, and select an image from the imagelist
        /// </summary>
        /// <param name="text"></param>
        /// <param name="imageId"></param>
        public void addItem(String text, int imageId)
        {
            ImageComboBoxItem iCBI = new ImageComboBoxItem(text, imageId);
            if (!allowDuplicates && Items.Contains(iCBI))
                return;
            Items.Add(iCBI);
        }
        /// <summary>
        /// todo
        /// </summary>
        /// <param name="text"></param>
        /// <param name="image"></param>
        public void addItem(String text, Image image)
        {
            //add image in the imagelist
            //create a new item
            if (imageList == null)
            {
                imageList = new ImageList();
            }
            image = ImageHelper.getResized(image, ImageList.ImageSize.Width, ImageList.ImageSize.Height);
            int i = imageList.Images.AddStrip(image);
            addItem(text, i);
        }
        /// <summary>
        /// todo
        /// </summary>
        /// <param name="text"></param>
        public void pushItem(String text)
        {
            //create a new item
            throw new NotImplementedException();
        }
        public void pushItem(String text, int imageId)
        {
            ImageComboBoxItem iCBI = new ImageComboBoxItem(text, imageId);
            if (!allowDuplicates && Items.Contains(iCBI))
                Items.Remove(iCBI);
            Items.Insert(0, iCBI);
        }
 
        public void pushItem(String text, Image image)
        {
            //add image in the imagelist
            //create a new item
            throw new NotImplementedException();
        }
        /// <summary>
        /// Add the current text as first item, set the image index, 
        /// and set this item as selected
        /// </summary>
        /// <param name="imageId"></param>
        public void pushAndSelect(int imageId)
        {
            ImageComboBoxItem iCBI = new ImageComboBoxItem(Text, imageId);
            if (!allowDuplicates && Items.Contains(iCBI))
                Items.Remove(iCBI);
            Items.Insert(0, iCBI);
            SelectedIndex = 0;
        }
        /// <summary>
        /// Add the current text as first item, set the image index, 
        /// and set this item as selected
        /// </summary>
        /// <param name="imageId"></param>
        public void pushAndSelect(String text, int imageId)
        {
            ImageComboBoxItem iCBI = new ImageComboBoxItem(text, imageId);
            if (!allowDuplicates && Items.Contains(iCBI))
            {
                Items.Remove(iCBI);
            }
            Items.Insert(0, iCBI);
            SelectedIndex = 0;
        }
 
        public void cleanDuplicates()
        {
            for (int i = 0; i < Items.Count - 1; i++)
            {
                for (int j = Items.Count - 1; j > i; j--)
                {
                    if ((Items[i]).Equals(Items[j]))
                    {
                        Items.RemoveAt(j);
                    }
                }
            }
        }
        #endregion
 
        #region overrided methods
        protected override void OnDrawItem(System.Windows.Forms.DrawItemEventArgs e)
        {
            //this.DropDownStyle = ComboBoxStyle.DropDown;
 
            base.OnDrawItem(e);
 
            if (e.Index == -1)
                return;
 
            if (this.ImageList != null)
            {
                ImageComboBoxItem imageCBI = (ImageComboBoxItem)this.Items[e.Index];
                Image imgToDisplay = this.ImageList.Images[imageCBI.ImageIndex];
 
                Rectangle oRect = new Rectangle(
                    e.Bounds.Left,
                    e.Bounds.Top,
                    e.Bounds.Width - this.ImageList.ImageSize.Width,
                    e.Bounds.Height
                    );
 
                int iX = 0, iY = 0;
 
                switch (this.ImageAlignment)
                {
 
                    case ContentAlignment.TopLeft:
                        iX = e.Bounds.Left;
                        iY = e.Bounds.Top;
                        oRect.X = this.ImageList.ImageSize.Width;
                        break;
                    case ContentAlignment.MiddleLeft:
                        iX = e.Bounds.Left;
                        iY = e.Bounds.Top + (this.ItemHeight - this.ImageList.ImageSize.Height) / 2;
                        oRect.X = this.ImageList.ImageSize.Width;
                        break;
                    case ContentAlignment.BottomLeft:
                        iX = e.Bounds.Left;
                        iY = e.Bounds.Top + this.ItemHeight - this.ImageList.ImageSize.Height;
                        oRect.X = this.ImageList.ImageSize.Width;
                        break;
 
                    case ContentAlignment.TopRight:
                        iX = e.Bounds.Right - this.ImageList.ImageSize.Width;
                        iY = e.Bounds.Top;
                        break;
                    case ContentAlignment.MiddleRight:
                        iX = e.Bounds.Right - this.ImageList.ImageSize.Width;
                        iY = e.Bounds.Top + (this.ItemHeight - this.ImageList.ImageSize.Height) / 2;
                        break;
                    case ContentAlignment.BottomRight:
                        iX = e.Bounds.Right - this.ImageList.ImageSize.Width;
                        iY = e.Bounds.Top + this.ItemHeight - this.ImageList.ImageSize.Height;
                        break;
 
                    case ContentAlignment.TopCenter:
                        iX = e.Bounds.Left + (e.Bounds.Width - this.ImageList.ImageSize.Width) / 2;
                        iY = e.Bounds.Top;
                        oRect.Width = e.Bounds.Width;
                        break;
                    case ContentAlignment.MiddleCenter:
                        iX = e.Bounds.Left + (e.Bounds.Width - this.ImageList.ImageSize.Width) / 2;
                        iY = e.Bounds.Top + (this.ItemHeight - this.ImageList.ImageSize.Height) / 2;
                        oRect.Width = e.Bounds.Width;
                        break;
                    case ContentAlignment.BottomCenter:
                        iX = e.Bounds.Left + (e.Bounds.Width - this.ImageList.ImageSize.Width) / 2;
                        iY = e.Bounds.Top + this.ItemHeight - this.ImageList.ImageSize.Height;
                        oRect.Width = e.Bounds.Width;
                        break;
                }
 
                e.Graphics.FillRectangle(SystemBrushes.Window, e.Bounds);
                if ((e.State & DrawItemState.Focus) != 0)
                    e.Graphics.FillRectangle(SystemBrushes.Highlight, e.Bounds);
 
                e.Graphics.DrawImage(imgToDisplay, iX, iY);
 
                e.Graphics.DrawString(this.Items[e.Index].ToString(), this.Font, solidBrush, oRect, stringFormat);
                return;
            }
            e.Graphics.DrawString(this.Items[e.Index].ToString(), this.Font, solidBrush, e.Bounds);
        } 
        #endregion
 
        #region innerClass
        private class ImageComboBoxItem
	    {
 
		    #region declarations and constructors
 
            private object iCBiValue;
            private int imageIndex;
 
            public ImageComboBoxItem()
            { 
                this.imageIndex = 0;
            }
 
            public ImageComboBoxItem(Object iCBiValue, Int32 imageIndex)
            { 
                this.iCBiValue = iCBiValue;
                this.imageIndex = imageIndex;
            }
		    #endregion
 
		    #region properties
            public String Text
            {
                get { return iCBiValue.ToString(); }
            }
		    public Object Value
		    {
			    get{return iCBiValue;}
			    set{iCBiValue = value;}
		    }
 
		    public Int32 ImageIndex
		    {
			    get{return imageIndex;}
			    set{imageIndex = value;}
		    }
		    #endregion
 
		    #region overrides methods
		    public override string ToString()
		    {
                return iCBiValue.ToString();
            }
            public override int GetHashCode()
            {
                return string.Concat(imageIndex.ToString(),iCBiValue.ToString()).GetHashCode();
            }
            public override bool Equals(object obj)
            {
                ImageComboBoxItem icbi = obj as ImageComboBoxItem;
                if (icbi == null)
                {
                    return false;
                }
                if (imageIndex != icbi.imageIndex)
                {
                    return false;
                }
                if (iCBiValue == null && icbi.iCBiValue == null)
                {
                    return true;
                }
                if (icbi.iCBiValue == null)
                {
                    return false;
                }
                //icbi.iCBiValue.GetType()
                return icbi.iCBiValue.Equals(iCBiValue);
            }
		    #endregion
	    }
        #endregion
    }
}