ImageComboBoxItem.Description Property

Gets or sets the item’s display text.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v20.2.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

[DefaultValue("")]
[DXCategory("Appearance")]
public string Description { get; set; }

VB.NET

<DefaultValue("")>
<DXCategory("Appearance")>
Public Property Description As String

Property Value

Type	Default	Description
String	String.Empty	The string that specifies the item’s display text.

Remarks

The Description property specifies the item caption displayed in the drop-down window and the editor’s edit box.

To associate an image with the item, use the ImageIndex property. The GlyphAlignment property specifies the image alignment. If the image is aligned at the center, the item caption is hidden in the edit box. However, if the ImageComboBoxEdit control is used to edit a column in a Grid, Vertical Grid, Tree List, or Search Lookup Editor control, the Find Panel still finds the hidden captions.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Description 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-columns-filter-drop-down-list-e2573/CS/WindowsApplication3/Form1.cs#L59

    textRect.X += imageSize.Width + 3;
    e.Appearance.DrawString(e.Cache, iItem.Description, textRect);
}

how-to-translate-non-localizable-elements-in-the-layoutview-customization-form-e3241/CS/TemplateCardCaptionLocalization/MyDesignerControlSettingsManager.cs#L23

    foreach (ImageComboBoxItem item in items)
        item.Description = LocalizeItemCaption(item.Description);
}

VB.NET

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

    textRect.X += imageSize.Width + 3
    e.Appearance.DrawString(e.Cache, iItem.Description, textRect)
End Sub

how-to-translate-non-localizable-elements-in-the-layoutview-customization-form-e3241/VB/TemplateCardCaptionLocalization/MyDesignerControlSettingsManager.vb#L27

For Each item As ImageComboBoxItem In items
    item.Description = LocalizeItemCaption(item.Description)
Next item