ImageComboBoxItem.ImageIndex Property

Gets or sets the index of the image associated with the item.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v19.1.dll

Declaration

C#

[DefaultValue(-1)]
[ImageList("Images")]
public int ImageIndex { get; set; }

VB.NET

<DefaultValue(-1)>
<ImageList("Images")>
Public Property ImageIndex As Integer

Property Value

Type	Default	Description
Int32	-1	The index of the image associated with the item.

Remarks

Each item for an ImageComboBoxEdit control can be associated with a large and/or small image. Large images are stored in the RepositoryItemImageComboBox.LargeImages list and small images are stored in the RepositoryItemImageComboBox.SmallImages list. The ImageIndex property specifies the index of an image in these lists.

If both RepositoryItemImageComboBox.LargeImages and RepositoryItemImageComboBox.SmallImages properties contain images, the editor displays an item with a small image in the edit box and a large image in the dropdown. If only one of these lists is assigned, the editor uses images from the corresponding list to display items both in the edit box and the dropdown. If none of these properties are assigned, items are represented only by their captions. See the ImageComboBoxItem.Description property to set the item’s caption

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ImageIndex 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#

building-a-simple-expense-tracking-application-using-xtragrid-for-winforms-example-solution-e5063/CS/XtraGridTutorial.Step3/MainForm.cs#L55

{
    item.Items[i].ImageIndex = i;
}

how-to-create-custom-images-for-the-imagecomboboxedit-items-manually-in-code-e4414/CS/WindowsFormsApplication1/Form1.cs#L105

    imagesHS.Images.Add(bmp);
    item.ImageIndex = imagesHS.Images.Count - 1;
}

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

    ImageList imageList = iItem.Images as ImageList;
    return imageList.Images[iItem.ImageIndex];
}

VB.NET

building-a-simple-expense-tracking-application-using-xtragrid-for-winforms-example-solution-e5063/VB/XtraGridTutorial.Step3/MainForm.vb#L50

For i As Integer = 0 To item.Items.Count - 1
    item.Items(i).ImageIndex = i
Next i

how-to-create-custom-images-for-the-imagecomboboxedit-items-manually-in-code-e4414/VB/WindowsFormsApplication1/Form1.vb#L74

    imagesColors.Images.Add(bmp)
    item.ImageIndex = imagesColors.Images.Count - 1
Next item

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

    Dim imageList As ImageList = TryCast(iItem.Images, ImageList)
    Return imageList.Images(iItem.ImageIndex)
End Function