Display an Integer Property as an Enumeration

• Oct 18, 2023
• 3 minutes to read

This topic describes how to display a business class integer property as an enumeration, in case you do not wish to modify (or cannot modify) the source code of this class.

Note

ASP.NET Core Blazor applications do not support displaying of a business class integer property as an enumeration.

Consider the following SampleObject business class.

C# (EF Core)

[DefaultClassOptions]
public class SampleObject : BaseObject {
    public virtual string Name { get; set; }
    public virtual int IntegerProperty { get; set; }
}

// Make sure that you use options.UseChangeTrackingProxies() in your DbContext settings.

C# (XPO)

[DefaultClassOptions]
public class SampleObject : BaseObject {
    public SampleObject(Session session) : base(session) { }
    private string name;
    public string Name {
        get { return name; }
        set { SetPropertyValue(nameof(Name), ref name, value); }
    }
    private int integerProperty;
    public int IntegerProperty {
        get { return integerProperty; }
        set { SetPropertyValue(nameof(IntegerProperty), ref integerProperty, value); }
    }
}

VB.NET (XPO)

<DefaultClassOptions>
Public Class SampleObject
    Inherits BaseObject

    Public Sub New(ByVal session As Session)
        MyBase.New(session)
    End Sub
    Private _name As String
    Public Property Name() As String
        Get
            Return _name
        End Get
        Set(ByVal value As String)
            SetPropertyValue(NameOf(Name), _name, value)
        End Set
    End Property
    Private _integerProperty As Integer
    Public Property IntegerProperty() As Integer
        Get
            Return _integerProperty
        End Get
        Set(ByVal value As Integer)
            SetPropertyValue(NameOf(IntegerProperty), _integerProperty, value)
        End Set
    End Property
End Class

Assume that this class is located in an external assembly, and you cannot modify its code. The task is to display enumeration values instead of integers (e.g., Value1 for zero, Value2 for 1, etc.). Follow the steps below to learn how to solve this task.

1. Implement an enumeration whose values will be mapped to integer values.

   C#

   public enum SampleEnum { Value1, Value2, Value3}
   

   VB.NET

   Public Enum SampleEnum
       Value1
       Value2
       Value3
   End Enum
   

2. Create a custom MyEnumIntPropertyEditor Property Editor by inheriting the EnumIntPropertyEditor<SampleEnum> class in the WinForms module project (MySolution.Module.Win). If your solution does not contain this project, add this editor to the WinForms application project (MySolution.Win). Note that your editor should be public.

   C#

   using DevExpress.ExpressApp.Editors;
   using DevExpress.ExpressApp.Model;
   using DevExpress.ExpressApp.Win.Editors;
   // ...
   [PropertyEditor(typeof(int), false)]
   public class MyEnumIntPropertyEditor : EnumIntPropertyEditor<SampleEnum> {
       public MyEnumIntPropertyEditor(Type objectType, IModelMemberViewItem model)
           : base(objectType, model) {  }
   }
   

   VB.NET

   Imports DevExpress.ExpressApp.Editors
   Imports DevExpress.ExpressApp.Model
   Imports DevExpress.ExpressApp.Win.Editors
   ' ...
   <PropertyEditor(GetType(Integer), False)>
   Public Class MyEnumIntPropertyEditor
       Inherits EnumIntPropertyEditor(Of SampleEnum)
       Public Sub New(ByVal objectType As Type, ByVal model As IModelMemberViewItem)
           MyBase.New(objectType, model)
       End Sub
   End Class
   

3. Run the Model Editor for the WinForms module project. Set the IModelCommonMemberViewItem.PropertyEditorType property of the BOModel | OwnMembers | IntegerProperty node to MyEnumIntPropertyEditor.

4. In an ASP.NET Web Forms module project, create a custom MyEnumIntPropertyEditor Property Editor by inheriting the ASPxEnumIntPropertyEditor<SampleEnum> class. Note that your editor should be public.

   C#

   using DevExpress.ExpressApp.Editors;
   using DevExpress.ExpressApp.Web.Editors.ASPx;
   using DevExpress.ExpressApp.Model;
   // ...
   [PropertyEditor(typeof(int), false)]
   public class ASPxMyEnumIntPropertyEditor : ASPxEnumIntPropertyEditor<SampleEnum> {
       public ASPxMyEnumIntPropertyEditor(Type objectType, IModelMemberViewItem model)
           : base(objectType, model) {  }
   }
   

   VB.NET

   Imports DevExpress.ExpressApp.Editors
   Imports DevExpress.ExpressApp.Web.Editors.ASPx
   Imports DevExpress.ExpressApp.Model
   ' ...
   <PropertyEditor(GetType(Integer), False)>
   Public Class ASPxMyEnumIntPropertyEditor
       Inherits ASPxEnumIntPropertyEditor(Of SampleEnum)
       Public Sub New(ByVal objectType As Type, ByVal model As IModelMemberViewItem)
           MyBase.New(objectType, model)
       End Sub
   End Class
   

5. Run the Model Editor for the ASP.NET Web Forms module project. Set the IModelCommonMemberViewItem.PropertyEditorType property of the BOModel | OwnMembers | IntegerProperty node to ASPxMyEnumIntPropertyEditor.

The images below illustrate the results in a WinForms application and an ASP.NET Web Forms application.

WinForms

ASP.NET Web Forms