ListBoxDrawItemEventArgs.State Property

Gets the state of the item being painted.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

C#

public DrawItemState State { get; }

VB.NET

Public ReadOnly Property State As DrawItemState

Property Value

Type	Description
DrawItemState	A DrawItemState enumeration member specifying the current state of an item being painted.

Remarks

Access this property to obtain the painted item’s state. For example, this can be useful when it is necessary to custom paint items depending on their state. This property value may be a combination of the DrawItemState enumeration members. The members can be combined by use of bitwise operators.

You can also use the event parameter’s ListBoxDrawItemEventArgs.Index property to identify the index of the processed item.

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 snippet (auto-collected from DevExpress Examples) contains a reference to the State 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-change-the-color-of-listbox-items-e789/CS/Form1.cs#L101

e.Appearance.ForeColor = Color.Green;
if((e.State & DrawItemState.Selected) == 0)
    e.Appearance.BackColor = Color.Yellow;

VB.NET

how-to-change-the-color-of-listbox-items-e789/VB/Form1.vb#L91

e.Appearance.ForeColor = Color.Green
If (e.State And DrawItemState.Selected) = 0 Then
    e.Appearance.BackColor = Color.Yellow