mirror of
https://github.com/wagesj45/CapyKit.git
synced 2024-10-18 15:01:52 -05:00
47 lines
1.9 KiB
Markdown
47 lines
1.9 KiB
Markdown
# GetDescription Method
|
||
|
||
|
||
An <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank" rel="noopener noreferrer">Enum</a> extension method that gets a description.
|
||
|
||
|
||
|
||
## Definition
|
||
**Namespace:** <a href="N_CapyKit_Extensions.md">CapyKit.Extensions</a>
|
||
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+735d7c4c91a8ae04c2d8cae4ce85ddf4909e5b7d
|
||
|
||
**C#**
|
||
``` C#
|
||
public static string GetDescription(
|
||
this Enum enumeration
|
||
)
|
||
```
|
||
**F#**
|
||
``` F#
|
||
[<ExtensionAttribute>]
|
||
static member GetDescription :
|
||
enumeration : Enum -> string
|
||
```
|
||
|
||
|
||
|
||
#### Parameters
|
||
<dl><dt> <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank" rel="noopener noreferrer">Enum</a></dt><dd>The enumeration to act on.</dd></dl>
|
||
|
||
#### Return Value
|
||
<a href="https://learn.microsoft.com/dotnet/api/system.string" target="_blank" rel="noopener noreferrer">String</a>
|
||
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 <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank" rel="noopener noreferrer">Enum</a>. When you use instance method syntax to call this method, omit the first parameter. For more information, see <a href="https://docs.microsoft.com/dotnet/visual-basic/programming-guide/language-features/procedures/extension-methods" target="_blank" rel="noopener noreferrer">
|
||
|
||
Extension Methods (Visual Basic)</a> or <a href="https://docs.microsoft.com/dotnet/csharp/programming-guide/classes-and-structs/extension-methods" target="_blank" rel="noopener noreferrer">
|
||
|
||
Extension Methods (C# Programming Guide)</a>.
|
||
|
||
## See Also
|
||
|
||
|
||
#### Reference
|
||
<a href="T_CapyKit_Extensions_EnumerationExtensions.md">EnumerationExtensions Class</a>
|
||
<a href="N_CapyKit_Extensions.md">CapyKit.Extensions Namespace</a>
|