NDoc 1.3.1 SDK

EnumDescriptionConverter.GetEnumDescription Method (Type, String)

Gets the Description of a named value in an Enumeration

[Visual Basic]
Shared  OverloadsPublic Function GetEnumDescription( _ 
   ByVal value As Type, _ 
   ByVal name As String _ 
) As String
[C#]
public static string GetEnumDescription(
   Type value,
   string name
);
[C++]
public: static String* GetEnumDescription(
   Type* value,
   String* name
);
[JScript]
public static function GetEnumDescription(
   Type value,
   String name
): String;

Parameters

value
The type of the Enumeration
name
The name of the Enumeration value

Return Value

The description, if any, else the passed name

See Also

EnumDescriptionConverter Class | NDoc.Core.PropertyGridUI Namespace | EnumDescriptionConverter.GetEnumDescription Overload List