EnumDescriptor Class

Supplies metadata information on an enumeration used in an XAF application.

Namespace: DevExpress.ExpressApp.Utils

Assembly: DevExpress.ExpressApp.v24.2.dll

NuGet Package: DevExpress.ExpressApp

Declaration

C#

public class EnumDescriptor :
    IEnumDescriptor

VB.NET

Public Class EnumDescriptor
    Implements IEnumDescriptor

Remarks

The EnumDescriptor class’ properties and methods provide access to the enumeration metadata - the enumeration values, associated display captions and image. The most useful members of the EnumDescriptor class are the EnumDescriptor.GetCaption and EnumDescriptor.GetImageInfo methods. The following code snippet illustrates their use. The code retrieves images and display captions associated with MyEnum enumeration values.

C#

using System.Drawing;
//...
EnumDescriptor myDescriptor = new EnumDescriptor(typeof(MyEnum));
foreach(object enumValue in myDescriptor.Values) {
    string caption = myDescriptor.GetCaption(enumValue);
    var image = myDescriptor.GetImageInfo(enumValue).Image;
    //process caption and image
}

VB.NET

Dim myDescriptor As New EnumDescriptor(GetType(MyEnum))
For Each enumValue As Object In myDescriptor.Values
    Dim caption As String = myDescriptor.GetCaption(enumValue)
    Dim image As Drawing.Image = myDescriptor.GetImageInfo(enumValue).Image
    'process caption and image
Next enumValue

Inheritance

Object

EnumDescriptor