CapyKit/Documentation/Help/T_CapyKit_Extensions_EnumerationExtensions.md
Jordan Wages 735d7c4c91 Documentation + Unfinished SecurityHelper
Committing the unfinished changes to the SecurityHelper as I flesh it out during the migration. Also starting a documentation folder powered by Sandcastle.
2024-04-19 23:12:24 -05:00

66 lines
2.5 KiB
Markdown

# EnumerationExtensions Class
Provides static extentions methods for providing additional functionality for <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank" rel="noopener noreferrer">Enum</a> types.
## Definition
**Namespace:** <a href="N_CapyKit_Extensions">CapyKit.Extensions</a>
**Assembly:** CapyKit (in CapyKit.dll) Version: 1.0.0+6cdd805be49c3b769a116584ea6904955ecd820d
**C#**
``` C#
public static class EnumerationExtensions
```
**VB**
``` VB
<ExtensionAttribute>
Public NotInheritable Class EnumerationExtensions
```
**C++**
``` C++
[ExtensionAttribute]
public ref class EnumerationExtensions abstract sealed
```
**F#**
``` F#
[<AbstractClassAttribute>]
[<SealedAttribute>]
[<ExtensionAttribute>]
type EnumerationExtensions = class end
```
<table><tr><td><strong>Inheritance</strong></td><td><a href="https://learn.microsoft.com/dotnet/api/system.object" target="_blank" rel="noopener noreferrer">Object</a> → EnumerationExtensions</td></tr>
</table>
## Methods
<table>
<tr>
<td><a href="M_CapyKit_Extensions_EnumerationExtensions_GetDescription">GetDescription</a></td>
<td>An <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank" rel="noopener noreferrer">Enum</a> extension method that gets a description.</td></tr>
<tr>
<td><a href="M_CapyKit_Extensions_EnumerationExtensions_GetName">GetName</a></td>
<td>An <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank" rel="noopener noreferrer">Enum</a> extension method that gets a name.</td></tr>
<tr>
<td><a href="M_CapyKit_Extensions_EnumerationExtensions_GetPrettyName">GetPrettyName</a></td>
<td>An <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank" rel="noopener noreferrer">Enum</a> extension method that gets a human readable name.</td></tr>
<tr>
<td><a href="M_CapyKit_Extensions_EnumerationExtensions_GetValue">GetValue</a></td>
<td>An <a href="https://learn.microsoft.com/dotnet/api/system.enum" target="_blank" rel="noopener noreferrer">Enum</a> extension method that gets an integer value representing the enumation.</td></tr>
<tr>
<td><a href="M_CapyKit_Extensions_EnumerationExtensions_Parse__1">Parse(T)(T, String)</a></td>
<td>A <em>T</em> extension method that parses a string into an enumeration.</td></tr>
<tr>
<td><a href="M_CapyKit_Extensions_EnumerationExtensions_Parse__1_1">Parse(T)(T, String, Boolean)</a></td>
<td>A <em>T</em> extension method that parses a string into an enumeration.</td></tr>
</table>
## See Also
#### Reference
<a href="N_CapyKit_Extensions">CapyKit.Extensions Namespace</a>