CapyKit/Documentation/Help/M_CapyKit_Extensions_EnumerationExtensions_GetDescription.md

GetDescription Method

An Enum extension method that gets a description.

Definition

Namespace: CapyKit.Extensions
Assembly: CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d

C#

public static string GetDescription(
	this Enum enumeration
)

VB

<ExtensionAttribute>
Public Shared Function GetDescription ( 
	enumeration As Enum
) As String

C++

public:
[ExtensionAttribute]
static String^ GetDescription(
	Enum^ enumeration
)

F#

[<ExtensionAttribute>]
static member GetDescription : 
        enumeration : Enum -> string 

Parameters

  Enum

The enumeration to act on.

Return Value

String
The description if available, otherwise the string representation of the enumeration.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type Enum. 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).

See Also

Reference

EnumerationExtensions Class
CapyKit.Extensions Namespace