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.166 -- Release Build+d3cb24a90fe44346300dfbb17444d7b350f42d79

C#View Source Request Example

public static Object? GetEnumValueByDescription(
	this string description,
	Type type,
	bool ignoreCase = false
)

VBView Source Request Example

<ExtensionAttribute>
Public Shared Function GetEnumValueByDescription ( 
	description As String,
	type As Type,
	Optional ignoreCase As Boolean = false
) As Object

C++View Source Request Example

public:
[ExtensionAttribute]
static Object^ GetEnumValueByDescription(
	String^ description, 
	Type^ type, 
	bool ignoreCase = false
)

JavaScriptView Source Request Example

Gemstone.EnumExtensions.EnumExtensions.GetEnumValueByDescription = function(description, type, ignoreCase);

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

ArgumentException

The type is not an enumeration.