Enumeration Properties in Entity Framework

• Jun 11, 2019

The example below illustrates how to implement Enumeration Properties in an Entity Framework Code-First class.

C#

public TextOnlyEnum TextOnlyEnumProperty { get; set; }
public TextAndImageEnum TextAndImageEnumProperty { get; set; }
// ...
public enum TextOnlyEnum { Minor, Moderate, Severe }
public enum TextAndImageEnum {
    [ImageName("State_Priority_Low")]
    Low,
    [ImageName("State_Priority_Normal")]
    Normal,
    [ImageName("State_Priority_High")]
    High 
}

VB.NET

Public Property TextOnlyEnumProperty() As TextOnlyEnum
Public Property TextAndImageEnumProperty() As TextAndImageEnum
' ...
Public Enum TextOnlyEnum
    Minor
    Moderate
    Severe
End Enum
Public Enum TextAndImageEnum
    <ImageName("State_Priority_Low")>
    Low
    <ImageName("State_Priority_Normal")>
    Normal
    <ImageName("State_Priority_High")>
    High
End Enum

To be able to use this enumeration type in design-time criteria editors, register it in the constructor of your ModuleBase descendant using the EnumProcessingHelper.RegisterEnum method as follows.

C#

using DevExpress.Data.Filtering;
//...
public sealed partial class MySolutionModule : ModuleBase {
    public MySolutionModule() {
        InitializeComponent();
        EnumProcessingHelper.RegisterEnum(typeof(MySolution.Module.BusinessObjects.MyClass.TextOnlyEnum));
        //...
    }
    //...
}

VB.NET

Imports DevExpress.Data.Filtering
'...
Partial Public NotInheritable Class MySolutionModule
    Inherits ModuleBase
    Public Sub New()
        InitializeComponent()
        EnumProcessingHelper.RegisterEnum(GetType(MySolution.Module.BusinessObjects.MyClass.TextOnlyEnum))
        '...
    End Sub
    '...
End Class