Log In
Home
Support
Demos
Documentation
Blogs
Training
Webinars
[Expand]General Information
[Collapse]WinForms Controls
  Prerequisites
 [Expand]What's Installed
 [Expand]Build an Application
 [Expand]Controls and Libraries
 [Expand]Common Features
  Get More Help
 [Collapse]API Reference
  [Expand]DevExpress.DataAccess.UI.Design
  [Expand]DevExpress.DataAccess.UI.EntityFramework
  [Expand]DevExpress.DataAccess.UI.Excel
  [Expand]DevExpress.DataAccess.UI.Localization
  [Expand]DevExpress.DataAccess.UI.ObjectBinding
  [Expand]DevExpress.DataAccess.UI.Sql
  [Expand]DevExpress.DataAccess.UI.Wizard
  [Expand]DevExpress.DataAccess.UI.Wizard.Services
  [Expand]DevExpress.DataAccess.UI.Wizard.Views
  [Expand]DevExpress.DocumentView
  [Expand]DevExpress.DocumentView.Controls
  [Expand]DevExpress.LookAndFeel
  [Expand]DevExpress.LookAndFeel.Helpers
  [Expand]DevExpress.Skins
  [Expand]DevExpress.Snap
  [Expand]DevExpress.Snap.API.Native
  [Expand]DevExpress.Snap.Core
  [Expand]DevExpress.Snap.Core.API
  [Expand]DevExpress.Snap.Core.Fields
  [Expand]DevExpress.Snap.Core.Forms
  [Expand]DevExpress.Snap.Core.Options
  [Expand]DevExpress.Snap.Core.Services
  [Expand]DevExpress.Snap.Extensions
  [Expand]DevExpress.Snap.Extensions.Localization
  [Expand]DevExpress.Snap.Extensions.UI
  [Expand]DevExpress.Snap.Localization
  [Expand]DevExpress.Snap.Options
  [Expand]DevExpress.Snap.Services
  [Expand]DevExpress.Utils
  [Expand]DevExpress.Utils.Animation
  [Expand]DevExpress.Utils.Controls
  [Expand]DevExpress.Utils.Drawing
  [Expand]DevExpress.Utils.Menu
  [Expand]DevExpress.Utils.Taskbar
  [Expand]DevExpress.Utils.Taskbar.Core
  [Expand]DevExpress.Utils.UI.Localization
  [Expand]DevExpress.Utils.VisualEffects
  [Expand]DevExpress.Utils.Win
  [Expand]DevExpress.XtraBars
  [Expand]DevExpress.XtraBars.Alerter
  [Expand]DevExpress.XtraBars.Docking
  [Expand]DevExpress.XtraBars.Docking2010
  [Expand]DevExpress.XtraBars.Docking2010.Customization
  [Expand]DevExpress.XtraBars.Docking2010.Views
  [Expand]DevExpress.XtraBars.Docking2010.Views.NativeMdi
  [Expand]DevExpress.XtraBars.Docking2010.Views.Tabbed
  [Expand]DevExpress.XtraBars.Docking2010.Views.Widget
  [Expand]DevExpress.XtraBars.Docking2010.Views.WindowsUI
  [Expand]DevExpress.XtraBars.Localization
  [Expand]DevExpress.XtraBars.Navigation
  [Expand]DevExpress.XtraBars.Ribbon
  [Expand]DevExpress.XtraBars.Ribbon.Gallery
  [Expand]DevExpress.XtraBars.Ribbon.ViewInfo
  [Expand]DevExpress.XtraBars.ToastNotifications
  [Expand]DevExpress.XtraBars.Utils
  [Expand]DevExpress.XtraBars.WinRTLiveTiles
  [Expand]DevExpress.XtraCharts
  [Expand]DevExpress.XtraCharts.Designer
  [Expand]DevExpress.XtraCharts.Wizard
  [Expand]DevExpress.XtraDataLayout
  [Expand]DevExpress.XtraDiagram
  [Expand]DevExpress.XtraDiagram.Options
  [Expand]DevExpress.XtraEditors
  [Expand]DevExpress.XtraEditors.ButtonPanel
  [Expand]DevExpress.XtraEditors.Calendar
  [Expand]DevExpress.XtraEditors.Camera
  [Expand]DevExpress.XtraEditors.Container
  [Collapse]DevExpress.XtraEditors.Controls
   [Expand]AddingMRUItemEventArgs Class
    AddingMRUItemEventHandler Delegate
   [Expand]BaseContainerValidateEditorEventArgs Class
    BaseContainerValidateEditorEventHandler Delegate
    BestFitMode Enumeration
    BorderSide Enumeration
    BorderStyles Enumeration
    ButtonPredefines Enumeration
   [Expand]ButtonPressedEventArgs Class
    ButtonPressedEventHandler Delegate
    ButtonStates Enumeration
   [Expand]CalendarControl Class
   [Expand]CalendarControlBase Class
    CalendarInactiveDaysVisibility Enumeration
    CalendarSelectionBehavior Enumeration
   [Expand]CanGetNextPrevImageEventArgs Class
   [Expand]ChangingEventArgs Class
    ChangingEventHandler Delegate
   [Expand]CheckedListBoxItem Class
   [Expand]CheckedListBoxItemCollection Class
    CheckStyles Enumeration
   [Expand]ClosedEventArgs Class
    ClosedEventHandler Delegate
   [Expand]CloseUpEventArgs Class
    CloseUpEventHandler Delegate
    ColorText Enumeration
   [Expand]ComboBoxItem Class
   [Expand]ComboBoxItemCollection Class
   [Expand]ConvertEditValueEventArgs Class
    ConvertEditValueEventHandler Delegate
   [Expand]CustomDisplayTextEventArgs Class
    CustomDisplayTextEventHandler Delegate
    DateOnError Enumeration
    DetailLevel Enumeration
   [Expand]EditorButton Class
   [Expand]EditorButtonCollection Class
    EditValueChangedFiringMode Enumeration
   [Expand]ExceptionEventArgs Class
    ExceptionEventHandler Delegate
    ExceptionMode Enumeration
    FilterButtonShowMode Enumeration
   [Expand]GetImageEventArgs Class
   [Expand]GetNotInListValueEventArgs Class
    GetNotInListValueEventHandler Delegate
    HeaderClickMode Enumeration
    HourFormat Enumeration
   [Expand]ImageComboBoxItem Class
   [Expand]ImageComboBoxItemCollection Class
   [Expand]ImageListBoxItem Class
   [Expand]ImageListBoxItemCollection Class
   [Expand]ImageSlider Class
    InplaceType Enumeration
   [Expand]InvalidValueExceptionEventArgs Class
    InvalidValueExceptionEventHandler Delegate
   [Expand]ItemCheckEventArgs Class
    ItemCheckEventHandler Delegate
   [Expand]ItemCheckingEventArgs Class
    ItemCheckingEventHandler Delegate
   [Expand]ListBoxItem Class
   [Collapse]ListBoxItemCollection Class
     ListBoxItemCollection Members
    [Expand]ListBoxItemCollection Constructor
    [Expand]ListBoxItemCollection Properties
    [Expand]ListBoxItemCollection Events
    [Collapse]ListBoxItemCollection Methods
      Add Method
     [Collapse]AddEnum Method
       AddEnum(Type) Method
       AddEnum(Type, Boolean) Method
     [Expand]AddEnum<TEnum> Method
      AddRange Method
      BeginUpdate Method
      Contains Method
      EndUpdate Method
      IndexOf Method
      Insert Method
      Remove Method
   [Expand]Localizer Class
   [Expand]LookUpColumnInfo Class
   [Expand]LookUpColumnInfoCollection Class
   [Expand]MaskData Class
    MRUItemAddReason Enumeration
   [Expand]OpenLinkEventArgs Class
    OpenLinkEventHandler Delegate
   [Expand]PickImageItem Class
    PictureEditMaskLayoutMode Enumeration
    PictureEditMaskType Enumeration
   [Expand]PictureEditOptionsMask Class
    PictureSizeMode Enumeration
    PictureStoreMode Enumeration
    PopupBorderStyles Enumeration
   [Expand]ProcessNewValueEventArgs Class
    ProcessNewValueEventHandler Delegate
    ProgressKind Enumeration
    ProgressViewStyle Enumeration
   [Expand]QueryCheckStateByValueEventArgs Class
    QueryCheckStateByValueEventHandler Delegate
   [Expand]QueryCheckStatesEventArgs Class
   [Expand]QueryDisplayTextEventArgs Class
    QueryDisplayTextEventHandler Delegate
   [Expand]QueryResultValueEventArgs Class
    QueryResultValueEventHandler Delegate
   [Expand]QueryValueByCheckStateEventArgs Class
    QueryValueByCheckStateEventHandler Delegate
   [Expand]RadioGroupItem Class
   [Expand]RadioGroupItemCollection Class
    SearchMode Enumeration
    ShowDropDown Enumeration
   [Expand]SliderBase Class
   [Expand]SliderImageCollection Class
   [Expand]SpinEventArgs Class
    SpinEventHandler Delegate
    SpinStyles Enumeration
    StringId Enumeration
    StyleIndeterminate Enumeration
    TextCaseMode Enumeration
    TextEditStyles Enumeration
    TimeFormat Enumeration
    WeekNumberRule Enumeration
  [Expand]DevExpress.XtraEditors.CustomEditor
  [Expand]DevExpress.XtraEditors.DXErrorProvider
  [Expand]DevExpress.XtraEditors.Filtering
  [Expand]DevExpress.XtraEditors.Mask
  [Expand]DevExpress.XtraEditors.Persistent
  [Expand]DevExpress.XtraEditors.Repository
  [Expand]DevExpress.XtraEditors.ViewInfo
  [Expand]DevExpress.XtraFilterEditor
  [Expand]DevExpress.XtraGauges.Presets.Styles
  [Expand]DevExpress.XtraGauges.Win
  [Expand]DevExpress.XtraGauges.Win.Base
  [Expand]DevExpress.XtraGauges.Win.Gauges.Circular
  [Expand]DevExpress.XtraGauges.Win.Gauges.Digital
  [Expand]DevExpress.XtraGauges.Win.Gauges.Linear
  [Expand]DevExpress.XtraGauges.Win.Gauges.State
  [Expand]DevExpress.XtraGrid
  [Expand]DevExpress.XtraGrid.Columns
  [Expand]DevExpress.XtraGrid.EditForm
  [Expand]DevExpress.XtraGrid.FilterEditor
  [Expand]DevExpress.XtraGrid.Localization
  [Expand]DevExpress.XtraGrid.Views.BandedGrid
  [Expand]DevExpress.XtraGrid.Views.BandedGrid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Base
  [Expand]DevExpress.XtraGrid.Views.Base.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Card
  [Expand]DevExpress.XtraGrid.Views.Card.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Grid
  [Expand]DevExpress.XtraGrid.Views.Grid.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Layout
  [Expand]DevExpress.XtraGrid.Views.Layout.Events
  [Expand]DevExpress.XtraGrid.Views.Layout.ViewInfo
  [Expand]DevExpress.XtraGrid.Views.Printing
  [Expand]DevExpress.XtraGrid.Views.Tile
  [Expand]DevExpress.XtraGrid.Views.WinExplorer
  [Expand]DevExpress.XtraGrid.WinExplorer
  [Expand]DevExpress.XtraLayout
  [Expand]DevExpress.XtraLayout.Customization
  [Expand]DevExpress.XtraLayout.HitInfo
  [Expand]DevExpress.XtraLayout.Localization
  [Expand]DevExpress.XtraLayout.Utils
  [Expand]DevExpress.XtraMap
  [Expand]DevExpress.XtraMap.Printing
  [Expand]DevExpress.XtraNavBar
  [Expand]DevExpress.XtraNavBar.ViewInfo
  [Expand]DevExpress.XtraPdfViewer
  [Expand]DevExpress.XtraPdfViewer.Commands
  [Expand]DevExpress.XtraPdfViewer.Localization
  [Expand]DevExpress.XtraPivotGrid
  [Expand]DevExpress.XtraPivotGrid.Data
  [Expand]DevExpress.XtraPrinting
  [Expand]DevExpress.XtraPrinting.Control
  [Expand]DevExpress.XtraPrinting.Preview
  [Expand]DevExpress.XtraPrintingLinks
  [Expand]DevExpress.XtraReports.UI
  [Expand]DevExpress.XtraRichEdit
  [Expand]DevExpress.XtraRichEdit.Commands
  [Expand]DevExpress.XtraRichEdit.Export
  [Expand]DevExpress.XtraRichEdit.Import
  [Expand]DevExpress.XtraRichEdit.Localization
  [Expand]DevExpress.XtraRichEdit.Menu
  [Expand]DevExpress.XtraScheduler
  [Expand]DevExpress.XtraScheduler.Drawing
  [Expand]DevExpress.XtraScheduler.Printing
  [Expand]DevExpress.XtraScheduler.Reporting
  [Expand]DevExpress.XtraScheduler.Reporting.UI
  [Expand]DevExpress.XtraScheduler.Services
  [Expand]DevExpress.XtraScheduler.Services.Implementation
  [Expand]DevExpress.XtraScheduler.UI
  [Expand]DevExpress.XtraSpellChecker
  [Expand]DevExpress.XtraSpellChecker.Localization
  [Expand]DevExpress.XtraSplashForm
  [Expand]DevExpress.XtraSplashScreen
  [Expand]DevExpress.XtraSpreadsheet
  [Expand]DevExpress.XtraSpreadsheet.Services
  [Expand]DevExpress.XtraTab
  [Expand]DevExpress.XtraTab.Buttons
  [Expand]DevExpress.XtraTab.ViewInfo
  [Expand]DevExpress.XtraTabbedMdi
  [Expand]DevExpress.XtraToolbox
  [Expand]DevExpress.XtraTreeList
  [Expand]DevExpress.XtraTreeList.Columns
  [Expand]DevExpress.XtraTreeList.Data
  [Expand]DevExpress.XtraTreeList.Localization
  [Expand]DevExpress.XtraTreeList.Menu
  [Expand]DevExpress.XtraTreeList.Nodes
  [Expand]DevExpress.XtraTreeList.Nodes.Operations
  [Expand]DevExpress.XtraTreeList.StyleFormatConditions
  [Expand]DevExpress.XtraTreeMap
  [Expand]DevExpress.XtraVerticalGrid
  [Expand]DevExpress.XtraVerticalGrid.Events
  [Expand]DevExpress.XtraVerticalGrid.Localization
  [Expand]DevExpress.XtraVerticalGrid.Rows
  [Expand]DevExpress.XtraWaitForm
  [Expand]DevExpress.XtraWizard
[Expand]ASP.NET Controls and MVC Extensions
[Expand]ASP.NET Bootstrap Controls
[Expand]ASP.NET Core Bootstrap Controls
[Expand]WPF Controls
[Expand]Xamarin Controls
[Expand]Windows 10 App Controls
[Expand]Document Server
[Expand]Reporting
[Expand]Report Server
[Expand]Dashboard
[Expand]eXpressApp Framework
[Expand]CodeRush
[Expand]CodeRush Classic
[Expand]Cross-Platform Core Libraries
[Expand]Tools and Utilities
 End-User Documentation

ListBoxItemCollection.AddEnum(Type, Boolean) Method

Populates this ListBoxItemCollection with items generated from values of the specific enumeration. Allows generated items to store numeric enumeration values instead of enumeration constant names. This overload should be used only for the ListBoxItemCollection class descendants.

Namespace:DevExpress.XtraEditors.Controls
Assembly:DevExpress.XtraEditors.v17.2.dll

Expanded Syntax

Parameters

enumType
Type: Type
A type of enumeration whose values should be used to generate ListBoxItemCollection items.
addEnumeratorIntegerValues
Type: Boolean
true if values for generated items should store numeric enumerator values ; false if these values should store constant enumerator names instead. This parameter is not in effect when the method is called for ListBoxControl objects, since their child items do not have the Value-Description property pair.

Expanded Remarks

Many DevExpress editors and controls provide the capability to fetch enumeration values and generate items using these values. To do this, use the required AddEnum/AddEnum<T> method overload. These overloads provide various parameters.

  • addEnumeratorIntegerValues
    Typically, an editor item has the Value and Description properties. An item value is passed to the editor's BaseEdit.EditValue property, while an item description is shown to end-users on screen. By default, when you populate an editor from an enumeration, these two values are the same. If the addEnumeratorIntegerValues parameter is set to true, item values will store numeric constants related to enumeration values, not their constant names.

  • displayTextConverter
    This parameter allows you to specify a delegate that encapsulates a method which modifies item descriptions. Note that you can do the same thing by declaring Description attributes before enumeration values as shown below.

  • skipComposite
    When set to true, this parameter prevents the editor from generating items that correspond to enumeration values with composite bit-flags. Refer to this online article to learn more.

  • skipNone
    This parameter allows you to skip enumeration values that do not have manually assigned numeric values.

The figure below illustrates various DevExpress editors populated from a sample enumeration.

Expanded Example

The following example shows how to populate the CheckedListBoxControl and ImageListBoxControl with items using the BaseListBoxControl.AddEnum and BaseListBoxControl.AddEnum<TEnum> methods.

The image below shows the result of executing the code in the example. It is assumed that the controls are dropped on the form at design time.

Expanded See Also

How would you rate this topic?​​​​​​​