ListBoxDrawItemEventArgs Class

Provides data for the BaseListBoxControl.DrawItem event.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v20.2.dll

NuGet Package: DevExpress.Win.Navigation

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.

Inheritance

Object

EventArgs

ListBoxDrawItemEventArgs