EnumDescriptor.GetCaption(Object) Method

Returns the display caption associated with a specified value of the enumeration represented by the EnumDescriptor.

Namespace: DevExpress.ExpressApp.Utils

Assembly: DevExpress.ExpressApp.v18.2.dll

Declaration

public string GetCaption(
    object value
)
Public Function GetCaption(
    value As Object
) As String

Parameters

Type Name Description
Object value

An object representing the enumeration value whose corresponding display caption will be retrieved.

Returns

Type Description
String

A string representing the display caption associated with the specified value of the enumeration represented by the EnumDescriptor.

Remarks

The following code snippet illustrates use of the GetCaption method. The code retrieves images and display captions associated with MyEnum enumeration values.

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