EnumExtensionsGetEnumValueByDescription Method

Gets the enumeration of the specified type whose description matches this description.

Definition

Namespace: Gemstone.EnumExtensions
Assembly: Gemstone.Common (in Gemstone.Common.dll) Version: 1.0.128 -- Release Build+d050cfc5563c89a1188cc3c6b2d417530856f490
public static Object? GetEnumValueByDescription(
	this string description,
	Type type,
	bool ignoreCase = false
)

Parameters

description  String
Description to be used for lookup of the enumeration.
type  Type
Type of the enumeration.
ignoreCase  Boolean  (Optional)
true to ignore case during the comparison; otherwise, false.

Return Value

Object
An enumeration of the specified type if a match is found, otherwise null.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type String. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

ArgumentExceptionThe type is not an enumeration.

See Also