ImageComboBoxItemCollection.AddEnum(Type) Method

Adds new items to the collection that will represent elements of the specified enumeration.

Namespace: DevExpress.XtraEditors.Controls

Assembly: DevExpress.XtraEditors.v19.2.dll

Declaration

C#

public void AddEnum(
    Type enumType
)

VB.NET

Public Sub AddEnum(
    enumType As Type
)

Parameters

Name	Type	Description
enumType	Type	A Type object which represents the required enumeration.

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.

Example

The following example demonstrates how to add the values of the HorzAlignment enumeration to the ImageComboBoxEdit control. When a specific item is selected from the dropdown, the corresponding alignment is applied to a text editor.

The image below shows the result of executing the code below. In the image, the ‘Center’ item is selected in the ImageComboBoxEdit control and this centers the text within a text editor:

C#

using DevExpress.Utils;

// Add the enumerator's values as dropdown items to the ImageComboBoxEdit control.
imageComboBoxEdit1.Properties.Items.AddEnum(typeof(HorzAlignment));

// A SelectedIndexChanged event handler of the ImageComboBoxEdit control.
private void imageComboBoxEdit1_SelectedIndexChanged(object sender, System.EventArgs e) {
   var icBox = sender as ImageComboBoxEdit;
   if(icBox.SelectedIndex > 0) {
      // Get the selected item.
      ImageComboBoxItem item = icBox.SelectedItem as ImageComboBoxItem;
      // Apply the selected alignment to a text editor.
      textEdit1.Properties.Appearance.TextOptions.HAlignment = (HorzAlignment)item.Value;
   }
}

VB.NET

Imports DevExpress.Utils

' Add the enumerator's values as dropdown items to the ImageComboBoxEdit control.
ImageComboBoxEdit1.Properties.Items.AddEnum(GetType(HorzAlignment))

' A SelectedIndexChanged event handler of the ImageComboBoxEdit control.
Private Sub ImageComboBoxEdit1_SelectedIndexChanged(ByVal sender As System.Object, _
  ByVal e As System.EventArgs) Handles ImageComboBoxEdit1.SelectedIndexChanged
   Dim icBox = TryCast(sender, ImageComboBoxEdit)
   If icBox.SelectedIndex > 0 Then
      ' Get the selected item.
      Dim item As ImageComboBoxItem = TryCast(icBox.SelectedItem, ImageComboBoxItem)
      ' Apply the selected alignment to a text editor.
      textEdit1.Properties.Appearance.TextOptions.HAlignment = CType(item.Value, HorzAlignment)
   End If
End Sub

Related GitHub Examples

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

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

{
    item.Items.AddEnum(typeof(TransactionType));
    for (int i = 0; i < item.Items.Count; i++)

how-to-show-the-sort-dialog-in-a-grid-in-a-similar-manner-as-in-excel-e2941/CS/WindowsApplication3/SortForm.cs#L36

{
    repositoryItemImageComboBox1.Items.AddEnum(typeof(ColumnSortOrder));
    repositoryItemImageComboBox2.Items.AddEnum(typeof(ColumnSortMode));

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

{
    imageComboBoxEdit1.Properties.Items.AddEnum(typeof(System.Drawing.Drawing2D.HatchStyle));

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

{
    imageComboBoxEdit1.Properties.Items.AddEnum(typeof(CheckStyles));
}

how-to-display-enumeration-values-in-grid-cells-e402/CS/WindowsApplication274/Form1.cs#L26

RepositoryItemImageComboBox item = new RepositoryItemImageComboBox();
item.Items.AddEnum(typeof(temp));
gridControl1.RepositoryItems.Add(item);

VB.NET

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

Private Sub InitImageComboBox(ByVal item As RepositoryItemImageComboBox)
    item.Items.AddEnum(GetType(TransactionType))
    For i As Integer = 0 To item.Items.Count - 1

how-to-show-the-sort-dialog-in-a-grid-in-a-similar-manner-as-in-excel-e2941/VB/WindowsApplication3/SortForm.vb#L33

Private Sub SetUpRepositories()
    repositoryItemImageComboBox1.Items.AddEnum(GetType(ColumnSortOrder))
    repositoryItemImageComboBox2.Items.AddEnum(GetType(ColumnSortMode))

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

Private Sub CreateHatchStyleItems()
    imageComboBoxEdit1.Properties.Items.AddEnum(GetType(System.Drawing.Drawing2D.HatchStyle))

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

Private Sub FillImageComboBox()
    imageComboBoxEdit1.Properties.Items.AddEnum(GetType(CheckStyles))
End Sub

how-to-display-enumeration-values-in-grid-cells-e402/VB/WindowsApplication274/Form1.vb#L24

Dim item As New RepositoryItemImageComboBox()
item.Items.AddEnum(GetType(temp))
gridControl1.RepositoryItems.Add(item)