ComboBoxEdit.DrawItem Event

Provides the ability to custom paint the items displayed within the combo box editor’s drop down.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v18.2.dll

Declaration

C#

[DXCategory("Events")]
public event ListBoxDrawItemEventHandler DrawItem

VB.NET

<DXCategory("Events")>
Public Event DrawItem As ListBoxDrawItemEventHandler

Event Data

The DrawItem event's data class is ListBoxDrawItemEventArgs. The following properties provide information specific to this event:

Property	Description
AllowDrawSkinBackground	Gets or sets whether the item background is colored according to the currently applied skin.
Appearance	Gets the appearance settings used to paint the item currently being processed.
Bounds	Gets the bounding rectangle of the item being painted.
Cache	Gets an object which specifies the storage for the most used pens, fonts and brushes.
Graphics	Gets an object used to paint an item.
Handled	Gets or sets a value specifying whether default painting is required.
Index	Gets the index of the item being painted.
Item	Gets the value of the processed item.
State	Gets the state of the item being painted.

The event data class exposes the following methods:

Method	Description
DefaultDraw()	Performs default painting of an element.
GetItemInfo()	This member supports the internal infrastructure, and is not intended to be used directly from your code.

Remarks

Handle the DrawItem event to override the default item painting. This event is raised each time an item is about to be painted. The event parameter’s properties allow you to identify the processed item, its boundaries, state, appearance settings, etc. You must set the ListBoxDrawItemEventArgs.Handled property to true to override the default painting.

Example

The following sample code handles the ComboBoxEdit.DrawItem event to custom paint the currently selected item. The result is shown in the image below:

C#

using System.Drawing.Drawing2D;
using DevExpress.XtraEditors;

private void comboBoxEdit1_DrawItem(object sender, ListBoxDrawItemEventArgs e) {
   if(e.State != DrawItemState.Selected) return;
   e.Cache.FillRectangle(new LinearGradientBrush(e.Bounds,Color.Blue, Color.LightBlue, 
     LinearGradientMode.Horizontal), e.Bounds);
   e.Cache.DrawString(e.Item.ToString(), e.Appearance.Font, new SolidBrush(Color.White), 
     e.Bounds, e.Appearance.GetStringFormat());
   e.Handled = true;
}

VB.NET

Imports System.Drawing.Drawing2D
' ...
Private Sub ComboBoxEdit1_DrawItem(ByVal sender As Object, _
 ByVal e As DevExpress.XtraEditors.ListBoxDrawItemEventArgs) _
 Handles ComboBoxEdit1.DrawItem
   If e.State <> DrawItemState.Selected Then Return
   e.Cache.FillRectangle(New LinearGradientBrush(e.Bounds, Color.Blue, Color.LightBlue, _
     LinearGradientMode.Horizontal), e.Bounds)
   e.Cache.DrawString(e.Item.ToString(), e.Appearance.Font, New SolidBrush(Color.White), _
     e.Bounds, e.Appearance.GetStringFormat())
   e.Handled = True
End Sub