ImageComboBoxItemCollection.AddEnum<TEnum>(Converter<TEnum, String>) Method

Adds new items to the collection that will represent elements of the specified enumeration. The display captions of the items are generated by the specified converter.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v24.1.dll

NuGet Package: DevExpress.Win.Navigation

Declaration

C#

public void AddEnum<TEnum>(
    Converter<TEnum, string> displayTextConverter
)

VB.NET

Public Sub AddEnum(Of TEnum)(
    displayTextConverter As Converter(Of TEnum, String)
)

Parameters

Name	Type	Description
displayTextConverter	Converter<TEnum, String>	A System.Converter delegate that will generate item display captions.

Type Parameters

Name
TEnum

Remarks

This method fetches elements from the specified enumeration and creates new items within the collection that will represent these elements. An item’s value and description are set so as to identify the corresponding element. So, when a specific item is selected in the ImageComboBoxEdit control, the editor’s edit value will be set to the corresponding enumeration element.

Item display captions (descriptions) are generated by the specified converter.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AddEnum<TEnum>(Converter<TEnum, String>) method.

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#

winforms-textedit-advanced-mode/CS/TextEditSample/EmployeeDataHelper.cs#L182

static bool AddEnum<TEnum>(Converter<TEnum, string> displayTextConverter, RepositoryItemImageComboBox e) {
    e.Items.AddEnum<TEnum>(displayTextConverter);
    return true;

VB.NET

winforms-textedit-advanced-mode/VB/TextEditSample/EmployeeDataHelper.vb#L198

Private Shared Function AddEnum(Of TEnum)(ByVal displayTextConverter As Converter(Of TEnum, String), ByVal e As RepositoryItemImageComboBox) As Boolean
    e.Items.AddEnum(Of TEnum)(displayTextConverter)
    Return True