windowsforms-devexpress-dot-xtraeditors-dot-repository-dot-repositoryitemcombobox-db85da3d.md
Provides the ability to custom paint the items displayed within the combo box editor’s drop down.
Namespace : DevExpress.XtraEditors.Repository
Assembly : DevExpress.XtraEditors.v25.2.dll
NuGet Package : DevExpress.Win.Navigation
[DXCategory("Events")]
public event ListBoxDrawItemEventHandler DrawItem
<DXCategory("Events")>
Public Event DrawItem As ListBoxDrawItemEventHandler
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. |
| Index | Gets the index of the item being painted. |
| Item | Gets the value of the processed item. |
| PaintArgs | |
| State | Gets the state of the item being painted. |
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 Handled property to true to override the default painting.
The editor’s ComboBoxEdit.DrawItem event is equivalent to the current event.
The following sample code handles the ComboBoxEdit.DrawItem event to custom paint the currently selected item. The result is shown in the image below:
using System.Drawing.Drawing2D;
using DevExpress.XtraEditors;
private void comboBoxEdit1_DrawItem(object sender, ListBoxDrawItemEventArgs e) {
if(e.State != DrawItemState.Selected) return;
using(var backBrush = new LinearGradientBrush(e.Bounds, Color.Blue, Color.LightBlue,
LinearGradientMode.Horizontal))
e.Cache.FillRectangle(backBrush, e.Bounds);
e.Cache.DrawString(e.Item.ToString(), e.Appearance.Font, Brushes.White,
e.Bounds);
e.Handled = true;
}
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
End If
Using backBrush = New LinearGradientBrush(e.Bounds, Color.Blue, Color.LightBlue, LinearGradientMode.Horizontal)
e.Cache.FillRectangle(backBrush, e.Bounds)
End Using
e.Cache.DrawString(e.Item.ToString(), e.Appearance.Font, Brushes.White, e.Bounds)
e.Handled = True
End Sub
The following code snippet (auto-collected from DevExpress Examples) contains a reference to the DrawItem event.
Note
The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.
winforms-imagecomboboxedit-disable-specific-items/CS/WindowsApplication33/Form1.cs#L33
imageComboBoxEdit1.Properties.DrawItem += new DevExpress.XtraEditors.ListBoxDrawItemEventHandler(Properties_DrawItem);
imageComboBoxEdit1.Properties.CloseUp += new CloseUpEventHandler(Properties_CloseUp);
winforms-imagecomboboxedit-disable-specific-items/VB/WindowsApplication33/Form1.vb#L29
imageComboBoxEdit1.Properties.Items.Add(New ImageComboBoxItem("Cancel", 3))
AddHandler imageComboBoxEdit1.Properties.DrawItem, New ListBoxDrawItemEventHandler(AddressOf Properties_DrawItem)
AddHandler imageComboBoxEdit1.Properties.CloseUp, New CloseUpEventHandler(AddressOf Properties_CloseUp)
See Also