ListBoxDrawItemEventArgs Class

Provides data for the BaseListBoxControl.DrawItem event.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v18.1.dll

Declaration

C#

public class ListBoxDrawItemEventArgs :
    EventArgs

VB.NET

Public Class ListBoxDrawItemEventArgs
    Inherits EventArgs

Related API Members

ListBoxDrawItemEventArgs is the data class for the following events:

• BaseListBoxControl.DrawItem
• CheckedComboBoxEdit.DrawListBoxItem
• ComboBoxEdit.DrawItem
• RepositoryItemCheckedComboBoxEdit.DrawListBoxItem
• RepositoryItemComboBox.DrawItem

Remarks

The list box control enables you to custom paint its items. This is performed by handling the BaseListBoxControl.DrawItem event. The ListBoxDrawItemEventArgs class introduces properties which allow you to obtain data needed to paint a specific item displayed within the control. The ListBoxDrawItemEventArgs.Handled property specifies whether default item painting is prohibited. You must set this property to true so that item custom painting implemented in the event handler can take effect.

ListBoxDrawItemEventArgs objects are automatically created and passed to BaseListBoxControl.DrawItem event handlers.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ListBoxDrawItemEventArgs class.

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.

C#

how-to-show-images-in-the-columns-filter-drop-down-list-e2573/CS/WindowsApplication3/Form1.cs#L40

void OnDrawItem(object sender, ListBoxDrawItemEventArgs e) {
    ColumnFilterPopup.FilterComboBox fComboBox = sender as ColumnFilterPopup.FilterComboBox;

how-to-show-the-delete-button-when-an-end-user-hovers-the-mouse-over-the-listbox-item-e3397/CS/DeleteItemFromListBox/DeleteHelper.cs#L59

private void DrawButton(ListBoxDrawItemEventArgs e)
{

how-to-create-a-custom-font-edit-control-that-supports-a-skinned-font-dialog-e3683/CS/RepositoryItemCustomFontEdit.cs#L66

internal static void DrawFontBoxItem(ListBoxDrawItemEventArgs e, RepositoryItemCustomFontEdit item, bool IsDrawStyle, string sCurrentFontName)
{

how-to-show-images-in-the-checkedcomboboxedit-edit-box-and-its-dropdown-window-e2804/CS/WindowsApplication3/CheckedImageComboBoxEdit.cs#L48

void OnDrawItem(object sender, ListBoxDrawItemEventArgs e) {
    if(e.Index == 0) return;

how-to-animate-images-in-imagecomboboxedit-e4086/CS/AnimateImageComboBox/RepositoryItemMyImageComboBox.cs#L39

protected override void RaiseDropDownCustomDrawItem(ListBoxDrawItemEventArgs e) {
    ImageComboBoxItem item = e.Item as ImageComboBoxItem;

VB.NET

how-to-show-images-in-the-columns-filter-drop-down-list-e2573/VB/WindowsApplication3/Form1.vb#L42

Private Sub OnDrawItem(ByVal sender As Object, ByVal e As ListBoxDrawItemEventArgs)
    Dim fComboBox As ColumnFilterPopup.FilterComboBox = TryCast(sender, ColumnFilterPopup.FilterComboBox)

how-to-show-the-delete-button-when-an-end-user-hovers-the-mouse-over-the-listbox-item-e3397/VB/DeleteItemFromListBox/DeleteHelper.vb#L56

Private Sub DrawButton(ByVal e As ListBoxDrawItemEventArgs)
    Dim bounds As Rectangle = GetRectangle(e.Bounds)

how-to-create-a-custom-font-edit-control-that-supports-a-skinned-font-dialog-e3683/VB/RepositoryItemCustomFontEdit.vb#L52

Friend Shared Overloads Sub DrawFontBoxItem(ByVal e As ListBoxDrawItemEventArgs, ByVal item As RepositoryItemCustomFontEdit, ByVal IsDrawStyle As Boolean, ByVal sCurrentFontName As String)
    If sCurrentFontName = String.Empty Then

how-to-show-images-in-the-checkedcomboboxedit-edit-box-and-its-dropdown-window-e2804/VB/WindowsApplication3/CheckedImageComboBoxEdit.vb#L61

Private Sub OnDrawItem(ByVal sender As Object, ByVal e As ListBoxDrawItemEventArgs)
    If e.Index = 0 Then

how-to-animate-images-in-imagecomboboxedit-e4086/VB/AnimateImageComboBox/RepositoryItemMyImageComboBox.vb#L41

Protected Overrides Sub RaiseDropDownCustomDrawItem(ByVal e As ListBoxDrawItemEventArgs)
    Dim item As ImageComboBoxItem = TryCast(e.Item, ImageComboBoxItem)

Inheritance

Object

EventArgs

ListBoxDrawItemEventArgs