PropertyConverter.EnumFromString(Type, String) Method

Definition

Converts the string representation to a value of the specified enumeration type.

This API supports the product infrastructure and is not intended to be used directly from your code.

public:
 static System::Object ^ EnumFromString(Type ^ enumType, System::String ^ value);
public static object EnumFromString (Type enumType, string value);
static member EnumFromString : Type * string -> obj
Public Shared Function EnumFromString (enumType As Type, value As String) As Object

Parameters

enumType
Type

A Type that represents the enumeration type to create from the value parameter.

value
String

The String that represents a value in the enumerator.

Returns

An enumeration of type enumType.

Exceptions

enumType or value is null.

enumType is not an Enum.

-or-

value is either an empty string ("") or contains only white spaces.

-or-

value is a name, but not one of the named constants defined for the enumeration.

Remarks

The EnumFromString method is used to convert a string value to its equivalent enumeration value.

Note

This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. To convert a string value to its equivalent enumeration value, use the Enum.Parse method.

Applies to

See also