ListBoxDrawItemEventArgs.Index Property

Gets the index of the item being painted.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v18.2.dll

Declaration

C#

public int Index { get; }

VB.NET

Public ReadOnly Property Index As Integer

Property Value

Type	Description
Int32	An integer value representing the zero-based index of the item being painted.

Remarks

Use the Index property to obtain the processed item’s index. It can be useful, for instance, when you need to custom paint an individual item.

You can also use the event parameter’s ListBoxDrawItemEventArgs.Item and ListBoxDrawItemEventArgs.State properties to obtain the item’s value and state.

Example

The following sample code handles the BaseListBoxControl.DrawItem event to custom paint the items displayed within the ListBoxControl. The odd and even items are painted with different appearance settings. A specific painting is applied to the currently selected item.

The image below shows the result.

C#

using DevExpress.XtraEditors;

private void listBoxControl1_DrawItem(object sender, ListBoxDrawItemEventArgs e) {
   Brush backBrush1 = new SolidBrush(Color.FromArgb(224, 251, 254));
   Brush backBrush2 = new SolidBrush(Color.FromArgb(198, 241, 249));
   Brush backBrush3 = new SolidBrush(Color.FromArgb(253, 192, 47));
   // declare field representing the text of the item being drawn
   string itemText = (sender as ListBoxControl).GetItemText(e.Index);
   if ((e.State & DrawItemState.Selected) != 0){
      e.Cache.FillRectangle(backBrush3, e.Bounds);
      ControlPaint.DrawBorder3D(e.Graphics, e.Bounds);
      e.Cache.DrawString(itemText, new Font(e.Appearance.Font.Name, 
        e.Appearance.Font.Size, FontStyle.Bold), new SolidBrush(Color.Black), 
        e.Bounds, e.Appearance.GetStringFormat());
      e.Handled = true;
      return;
   }
   if(e.Index % 2 == 0){
      e.Cache.FillRectangle(backBrush1, e.Bounds);
   }
   else{
      e.Cache.FillRectangle(backBrush2, e.Bounds);
   }
   e.Cache.DrawString(itemText, e.Appearance.Font, new SolidBrush(Color.Black), 
     e.Bounds, e.Appearance.GetStringFormat());
   e.Handled = true;
}

VB.NET

Private Sub ListBoxControl1_DrawItem(ByVal sender As Object, _
  ByVal e As DevExpress.XtraEditors.ListBoxDrawItemEventArgs) _
  Handles ListBoxControl1.DrawItem
   Dim backBrush1 As New SolidBrush(Color.FromArgb(224, 251, 254))
   Dim backBrush2 As New SolidBrush(Color.FromArgb(198, 241, 249))
   Dim backBrush3 As New SolidBrush(Color.FromArgb(253, 192, 47))
   ' declare field representing the text of the item being drawn
   Dim itemText As String = (TryCast(sender, ListBoxControl)).GetItemText(e.Index)
   If Not (e.State And DrawItemState.Selected) = 0 Then
      e.Cache.FillRectangle(backBrush3, e.Bounds)
      ControlPaint.DrawBorder3D(e.Graphics, e.Bounds)
      e.Cache.DrawString(itemText, New Font(e.Appearance.Font.Name, e.Appearance.Font.Size, _
        FontStyle.Bold), New SolidBrush(Color.Black), e.Bounds, e.Appearance.GetStringFormat())
      e.Handled = True
      Exit Sub
   End If
   If e.Index Mod 2 = 0 Then
      e.Cache.FillRectangle(backBrush1, e.Bounds)
   Else
      e.Cache.FillRectangle(backBrush2, e.Bounds)
   End If
   e.Cache.DrawString(itemText, e.Appearance.Font, New SolidBrush(Color.Black), e.Bounds, 
     e.Appearance.GetStringFormat())
   e.Handled = True
End Sub

Related GitHub Examples

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

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-checkedcomboboxedit-edit-box-and-its-dropdown-window-e2804/CS/WindowsApplication3/CheckedImageComboBoxEdit.cs#L49

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

how-to-change-the-color-of-a-specific-item-in-the-listboxcontrol-e3170/CS/WindowsApplication1/Form1.cs#L24

{
    e.Appearance.BackColor = e.Index % 2 == 0 ? Color.LightCyan : Color.MistyRose;
    if (checkedListBoxControl1.GetItemChecked(e.Index))

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

if (item.Images is ImageCollection) {
    Image image = (item.Images as ImageCollection).Images[e.Index];
    image.SelectActiveFrame(new FrameDimension(image.FrameDimensionsList[0]), 0);

how-to-implement-the-checkstyle-feature-for-checkedcomboboxedit-e4041/CS/CustomEdit/CustomCheckedComboBoxEdit.cs#L69

CheckedListBoxViewInfo vi = lbControl.GetViewInfo() as CheckedListBoxViewInfo;
CheckedListBoxViewInfo.CheckedItemInfo checkItemInfo = vi.GetItemByIndex(e.Index) as CheckedListBoxViewInfo.CheckedItemInfo;
checkItemInfo.CheckArgs.CheckStyle = Properties.CheckStyle;

how-to-implement-the-word-wrap-functionality-in-the-listboxcontrol-e1227/CS/S131055/Form1.cs#L45

e.Appearance.DrawBackground(e.Cache, e.Bounds);
TextUtils.DrawString(e.Graphics, control.GetItemText(e.Index), control.Appearance.Font,
    control.Appearance.ForeColor, e.Bounds);

VB.NET

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

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

how-to-change-the-color-of-a-specific-item-in-the-listboxcontrol-e3170/VB/WindowsApplication1/Form1.vb#L21

Private Sub checkedListBoxControl1_DrawItem(ByVal sender As Object, ByVal e As DevExpress.XtraEditors.ListBoxDrawItemEventArgs) Handles checkedListBoxControl1.DrawItem
    If e.Index Mod 2 = 0 Then
        e.Appearance.BackColor = Color.LightCyan

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

If TypeOf item.Images Is ImageCollection Then
    Dim image As Image = (TryCast(item.Images, ImageCollection)).Images(e.Index)
    image.SelectActiveFrame(New FrameDimension(image.FrameDimensionsList(0)), 0)

how-to-implement-the-checkstyle-feature-for-checkedcomboboxedit-e4041/VB/CustomEdit/CustomCheckedComboBoxEdit.vb#L67

Dim vi As CheckedListBoxViewInfo = TryCast(lbControl.GetViewInfo(), CheckedListBoxViewInfo)
Dim checkItemInfo As CheckedListBoxViewInfo.CheckedItemInfo = TryCast(vi.GetItemByIndex(e.Index), CheckedListBoxViewInfo.CheckedItemInfo)
checkItemInfo.CheckArgs.CheckStyle = Properties.CheckStyle

how-to-implement-the-word-wrap-functionality-in-the-listboxcontrol-e1227/VB/S131055/Form1.vb#L44

e.Appearance.DrawBackground(e.Cache, e.Bounds)
TextUtils.DrawString(e.Graphics, control.GetItemText(e.Index), control.Appearance.Font, control.Appearance.ForeColor, e.Bounds)
e.Handled = True