CapyKit/Docs/api/CapyKit.Extensions.EnumerationExtensions.yml

### YamlMime:ManagedReference
items:
- uid: CapyKit.Extensions.EnumerationExtensions
  commentId: T:CapyKit.Extensions.EnumerationExtensions
  id: EnumerationExtensions
  parent: CapyKit.Extensions
  children:
  - CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
  - CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
  - CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
  - CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
  - CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
  - CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
  langs:
  - csharp
  - vb
  name: EnumerationExtensions
  nameWithType: EnumerationExtensions
  fullName: CapyKit.Extensions.EnumerationExtensions
  type: Class
  source:
    remote:
      path: CapyKit/Extensions/EnumerationExtensions.cs
      branch: main
      repo: https://git.jordanwages.com/wagesj45/CapyKit.git
    id: EnumerationExtensions
    path: ../CapyKit/Extensions/EnumerationExtensions.cs
    startLine: 12
  assemblies:
  - CapyKit
  namespace: CapyKit.Extensions
  summary: Provides static extentions methods for providing additional functionality for <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> types.
  example: []
  syntax:
    content: public static class EnumerationExtensions
    content.vb: Public Module EnumerationExtensions
  inheritance:
  - System.Object
  inheritedMembers:
  - System.Object.Equals(System.Object)
  - System.Object.Equals(System.Object,System.Object)
  - System.Object.GetHashCode
  - System.Object.GetType
  - System.Object.MemberwiseClone
  - System.Object.ReferenceEquals(System.Object,System.Object)
  - System.Object.ToString
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
  commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String)
  id: Parse``1(``0,System.String)
  isExtensionMethod: true
  parent: CapyKit.Extensions.EnumerationExtensions
  langs:
  - csharp
  - vb
  name: Parse<T>(T, string)
  nameWithType: EnumerationExtensions.Parse<T>(T, string)
  fullName: CapyKit.Extensions.EnumerationExtensions.Parse<T>(T, string)
  type: Method
  source:
    remote:
      path: CapyKit/Extensions/EnumerationExtensions.cs
      branch: main
      repo: https://git.jordanwages.com/wagesj45/CapyKit.git
    id: Parse
    path: ../CapyKit/Extensions/EnumerationExtensions.cs
    startLine: 23
  assemblies:
  - CapyKit
  namespace: CapyKit.Extensions
  summary: A <code class="typeparamref">T</code> extension method that parses a string into an enumeration.
  example: []
  syntax:
    content: 'public static T Parse<T>(this T enumeration, string value) where T : Enum'
    parameters:
    - id: enumeration
      type: '{T}'
      description: The enumeration to act on.
    - id: value
      type: System.String
      description: The value.
    typeParameters:
    - id: T
      description: Generic type parameter.
    return:
      type: '{T}'
      description: A T.
    content.vb: Public Shared Function Parse(Of T As [Enum])(enumeration As T, value As String) As T
  overload: CapyKit.Extensions.EnumerationExtensions.Parse*
  nameWithType.vb: EnumerationExtensions.Parse(Of T)(T, String)
  fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of T)(T, String)
  name.vb: Parse(Of T)(T, String)
- uid: CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
  commentId: M:CapyKit.Extensions.EnumerationExtensions.Parse``1(``0,System.String,System.Boolean)
  id: Parse``1(``0,System.String,System.Boolean)
  isExtensionMethod: true
  parent: CapyKit.Extensions.EnumerationExtensions
  langs:
  - csharp
  - vb
  name: Parse<T>(T, string, bool)
  nameWithType: EnumerationExtensions.Parse<T>(T, string, bool)
  fullName: CapyKit.Extensions.EnumerationExtensions.Parse<T>(T, string, bool)
  type: Method
  source:
    remote:
      path: CapyKit/Extensions/EnumerationExtensions.cs
      branch: main
      repo: https://git.jordanwages.com/wagesj45/CapyKit.git
    id: Parse
    path: ../CapyKit/Extensions/EnumerationExtensions.cs
    startLine: 36
  assemblies:
  - CapyKit
  namespace: CapyKit.Extensions
  summary: A <code class="typeparamref">T</code> extension method that parses a string into an enumeration.
  example: []
  syntax:
    content: 'public static T Parse<T>(this T enumeration, string value, bool ignoreCase) where T : Enum'
    parameters:
    - id: enumeration
      type: '{T}'
      description: The enumeration to act on.
    - id: value
      type: System.String
      description: The string value of the <xref href="System.Enum" data-throw-if-not-resolved="false"></xref>.
    - id: ignoreCase
      type: System.Boolean
      description: True to ignore case.
    typeParameters:
    - id: T
      description: Generic type parameter.
    return:
      type: '{T}'
      description: A T.
    content.vb: Public Shared Function Parse(Of T As [Enum])(enumeration As T, value As String, ignoreCase As Boolean) As T
  overload: CapyKit.Extensions.EnumerationExtensions.Parse*
  nameWithType.vb: EnumerationExtensions.Parse(Of T)(T, String, Boolean)
  fullName.vb: CapyKit.Extensions.EnumerationExtensions.Parse(Of T)(T, String, Boolean)
  name.vb: Parse(Of T)(T, String, Boolean)
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
  commentId: M:CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
  id: GetValue(System.Enum)
  isExtensionMethod: true
  parent: CapyKit.Extensions.EnumerationExtensions
  langs:
  - csharp
  - vb
  name: GetValue(Enum)
  nameWithType: EnumerationExtensions.GetValue(Enum)
  fullName: CapyKit.Extensions.EnumerationExtensions.GetValue(System.Enum)
  type: Method
  source:
    remote:
      path: CapyKit/Extensions/EnumerationExtensions.cs
      branch: main
      repo: https://git.jordanwages.com/wagesj45/CapyKit.git
    id: GetValue
    path: ../CapyKit/Extensions/EnumerationExtensions.cs
    startLine: 46
  assemblies:
  - CapyKit
  namespace: CapyKit.Extensions
  summary: An <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> extension method that gets an integer value representing the enumation.
  example: []
  syntax:
    content: public static int GetValue(this Enum enumeration)
    parameters:
    - id: enumeration
      type: System.Enum
      description: The enumeration to act on.
    return:
      type: System.Int32
      description: The integer value of the enumeration.
    content.vb: Public Shared Function GetValue(enumeration As [Enum]) As Integer
  overload: CapyKit.Extensions.EnumerationExtensions.GetValue*
- uid: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
  commentId: M:CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
  id: GetName(System.Enum)
  isExtensionMethod: true
  parent: CapyKit.Extensions.EnumerationExtensions
  langs:
  - csharp
  - vb
  name: GetName(Enum)
  nameWithType: EnumerationExtensions.GetName(Enum)
  fullName: CapyKit.Extensions.EnumerationExtensions.GetName(System.Enum)
  type: Method
  source:
    remote:
      path: CapyKit/Extensions/EnumerationExtensions.cs
      branch: main
      repo: https://git.jordanwages.com/wagesj45/CapyKit.git
    id: GetName
    path: ../CapyKit/Extensions/EnumerationExtensions.cs
    startLine: 54
  assemblies:
  - CapyKit
  namespace: CapyKit.Extensions
  summary: An <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> extension method that gets a name.
  example: []
  syntax:
    content: public static string GetName(this Enum enumeration)
    parameters:
    - id: enumeration
      type: System.Enum
      description: The enumeration to act on.
    return:
      type: System.String
      description: The name of the enumeration.
    content.vb: Public Shared Function GetName(enumeration As [Enum]) As String
  overload: CapyKit.Extensions.EnumerationExtensions.GetName*
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
  commentId: M:CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
  id: GetPrettyName(System.Enum)
  isExtensionMethod: true
  parent: CapyKit.Extensions.EnumerationExtensions
  langs:
  - csharp
  - vb
  name: GetPrettyName(Enum)
  nameWithType: EnumerationExtensions.GetPrettyName(Enum)
  fullName: CapyKit.Extensions.EnumerationExtensions.GetPrettyName(System.Enum)
  type: Method
  source:
    remote:
      path: CapyKit/Extensions/EnumerationExtensions.cs
      branch: main
      repo: https://git.jordanwages.com/wagesj45/CapyKit.git
    id: GetPrettyName
    path: ../CapyKit/Extensions/EnumerationExtensions.cs
    startLine: 62
  assemblies:
  - CapyKit
  namespace: CapyKit.Extensions
  summary: An <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> extension method that gets a human readable name.
  example: []
  syntax:
    content: public static string GetPrettyName(this Enum enumeration)
    parameters:
    - id: enumeration
      type: System.Enum
      description: The enumeration to act on.
    return:
      type: System.String
      description: The human readable name of the enumeration.
    content.vb: Public Shared Function GetPrettyName(enumeration As [Enum]) As String
  overload: CapyKit.Extensions.EnumerationExtensions.GetPrettyName*
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
  commentId: M:CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
  id: GetDescription(System.Enum)
  isExtensionMethod: true
  parent: CapyKit.Extensions.EnumerationExtensions
  langs:
  - csharp
  - vb
  name: GetDescription(Enum)
  nameWithType: EnumerationExtensions.GetDescription(Enum)
  fullName: CapyKit.Extensions.EnumerationExtensions.GetDescription(System.Enum)
  type: Method
  source:
    remote:
      path: CapyKit/Extensions/EnumerationExtensions.cs
      branch: main
      repo: https://git.jordanwages.com/wagesj45/CapyKit.git
    id: GetDescription
    path: ../CapyKit/Extensions/EnumerationExtensions.cs
    startLine: 72
  assemblies:
  - CapyKit
  namespace: CapyKit.Extensions
  summary: An <xref href="System.Enum" data-throw-if-not-resolved="false"></xref> extension method that gets a description.
  example: []
  syntax:
    content: public static string GetDescription(this Enum enumeration)
    parameters:
    - id: enumeration
      type: System.Enum
      description: The enumeration to act on.
    return:
      type: System.String
      description: The description if available, otherwise the string representation of the enumeration.
    content.vb: Public Shared Function GetDescription(enumeration As [Enum]) As String
  overload: CapyKit.Extensions.EnumerationExtensions.GetDescription*
references:
- uid: System.Enum
  commentId: T:System.Enum
  parent: System
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.enum
  name: Enum
  nameWithType: Enum
  fullName: System.Enum
- uid: CapyKit.Extensions
  commentId: N:CapyKit.Extensions
  href: CapyKit.html
  name: CapyKit.Extensions
  nameWithType: CapyKit.Extensions
  fullName: CapyKit.Extensions
  spec.csharp:
  - uid: CapyKit
    name: CapyKit
    href: CapyKit.html
  - name: .
  - uid: CapyKit.Extensions
    name: Extensions
    href: CapyKit.Extensions.html
  spec.vb:
  - uid: CapyKit
    name: CapyKit
    href: CapyKit.html
  - name: .
  - uid: CapyKit.Extensions
    name: Extensions
    href: CapyKit.Extensions.html
- uid: System.Object
  commentId: T:System.Object
  parent: System
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.object
  name: object
  nameWithType: object
  fullName: object
  nameWithType.vb: Object
  fullName.vb: Object
  name.vb: Object
- uid: System.Object.Equals(System.Object)
  commentId: M:System.Object.Equals(System.Object)
  parent: System.Object
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
  name: Equals(object)
  nameWithType: object.Equals(object)
  fullName: object.Equals(object)
  nameWithType.vb: Object.Equals(Object)
  fullName.vb: Object.Equals(Object)
  name.vb: Equals(Object)
  spec.csharp:
  - uid: System.Object.Equals(System.Object)
    name: Equals
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
  - name: (
  - uid: System.Object
    name: object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: )
  spec.vb:
  - uid: System.Object.Equals(System.Object)
    name: Equals
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
  - name: (
  - uid: System.Object
    name: Object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: )
- uid: System.Object.Equals(System.Object,System.Object)
  commentId: M:System.Object.Equals(System.Object,System.Object)
  parent: System.Object
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
  name: Equals(object, object)
  nameWithType: object.Equals(object, object)
  fullName: object.Equals(object, object)
  nameWithType.vb: Object.Equals(Object, Object)
  fullName.vb: Object.Equals(Object, Object)
  name.vb: Equals(Object, Object)
  spec.csharp:
  - uid: System.Object.Equals(System.Object,System.Object)
    name: Equals
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
  - name: (
  - uid: System.Object
    name: object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: ','
  - name: " "
  - uid: System.Object
    name: object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: )
  spec.vb:
  - uid: System.Object.Equals(System.Object,System.Object)
    name: Equals
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
  - name: (
  - uid: System.Object
    name: Object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: ','
  - name: " "
  - uid: System.Object
    name: Object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: )
- uid: System.Object.GetHashCode
  commentId: M:System.Object.GetHashCode
  parent: System.Object
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
  name: GetHashCode()
  nameWithType: object.GetHashCode()
  fullName: object.GetHashCode()
  nameWithType.vb: Object.GetHashCode()
  fullName.vb: Object.GetHashCode()
  spec.csharp:
  - uid: System.Object.GetHashCode
    name: GetHashCode
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
  - name: (
  - name: )
  spec.vb:
  - uid: System.Object.GetHashCode
    name: GetHashCode
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
  - name: (
  - name: )
- uid: System.Object.GetType
  commentId: M:System.Object.GetType
  parent: System.Object
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.object.gettype
  name: GetType()
  nameWithType: object.GetType()
  fullName: object.GetType()
  nameWithType.vb: Object.GetType()
  fullName.vb: Object.GetType()
  spec.csharp:
  - uid: System.Object.GetType
    name: GetType
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.gettype
  - name: (
  - name: )
  spec.vb:
  - uid: System.Object.GetType
    name: GetType
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.gettype
  - name: (
  - name: )
- uid: System.Object.MemberwiseClone
  commentId: M:System.Object.MemberwiseClone
  parent: System.Object
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
  name: MemberwiseClone()
  nameWithType: object.MemberwiseClone()
  fullName: object.MemberwiseClone()
  nameWithType.vb: Object.MemberwiseClone()
  fullName.vb: Object.MemberwiseClone()
  spec.csharp:
  - uid: System.Object.MemberwiseClone
    name: MemberwiseClone
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
  - name: (
  - name: )
  spec.vb:
  - uid: System.Object.MemberwiseClone
    name: MemberwiseClone
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
  - name: (
  - name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
  commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
  parent: System.Object
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
  name: ReferenceEquals(object, object)
  nameWithType: object.ReferenceEquals(object, object)
  fullName: object.ReferenceEquals(object, object)
  nameWithType.vb: Object.ReferenceEquals(Object, Object)
  fullName.vb: Object.ReferenceEquals(Object, Object)
  name.vb: ReferenceEquals(Object, Object)
  spec.csharp:
  - uid: System.Object.ReferenceEquals(System.Object,System.Object)
    name: ReferenceEquals
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
  - name: (
  - uid: System.Object
    name: object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: ','
  - name: " "
  - uid: System.Object
    name: object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: )
  spec.vb:
  - uid: System.Object.ReferenceEquals(System.Object,System.Object)
    name: ReferenceEquals
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
  - name: (
  - uid: System.Object
    name: Object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: ','
  - name: " "
  - uid: System.Object
    name: Object
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object
  - name: )
- uid: System.Object.ToString
  commentId: M:System.Object.ToString
  parent: System.Object
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.object.tostring
  name: ToString()
  nameWithType: object.ToString()
  fullName: object.ToString()
  nameWithType.vb: Object.ToString()
  fullName.vb: Object.ToString()
  spec.csharp:
  - uid: System.Object.ToString
    name: ToString
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.tostring
  - name: (
  - name: )
  spec.vb:
  - uid: System.Object.ToString
    name: ToString
    isExternal: true
    href: https://learn.microsoft.com/dotnet/api/system.object.tostring
  - name: (
  - name: )
- uid: System
  commentId: N:System
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system
  name: System
  nameWithType: System
  fullName: System
- uid: CapyKit.Extensions.EnumerationExtensions.Parse*
  commentId: Overload:CapyKit.Extensions.EnumerationExtensions.Parse
  href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_Parse__1___0_System_String_
  name: Parse
  nameWithType: EnumerationExtensions.Parse
  fullName: CapyKit.Extensions.EnumerationExtensions.Parse
- uid: '{T}'
  commentId: '!:T'
  definition: T
  name: T
  nameWithType: T
  fullName: T
- uid: System.String
  commentId: T:System.String
  parent: System
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.string
  name: string
  nameWithType: string
  fullName: string
  nameWithType.vb: String
  fullName.vb: String
  name.vb: String
- uid: T
  name: T
  nameWithType: T
  fullName: T
- uid: System.Boolean
  commentId: T:System.Boolean
  parent: System
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.boolean
  name: bool
  nameWithType: bool
  fullName: bool
  nameWithType.vb: Boolean
  fullName.vb: Boolean
  name.vb: Boolean
- uid: CapyKit.Extensions.EnumerationExtensions.GetValue*
  commentId: Overload:CapyKit.Extensions.EnumerationExtensions.GetValue
  href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetValue_System_Enum_
  name: GetValue
  nameWithType: EnumerationExtensions.GetValue
  fullName: CapyKit.Extensions.EnumerationExtensions.GetValue
- uid: System.Int32
  commentId: T:System.Int32
  parent: System
  isExternal: true
  href: https://learn.microsoft.com/dotnet/api/system.int32
  name: int
  nameWithType: int
  fullName: int
  nameWithType.vb: Integer
  fullName.vb: Integer
  name.vb: Integer
- uid: CapyKit.Extensions.EnumerationExtensions.GetName*
  commentId: Overload:CapyKit.Extensions.EnumerationExtensions.GetName
  href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetName_System_Enum_
  name: GetName
  nameWithType: EnumerationExtensions.GetName
  fullName: CapyKit.Extensions.EnumerationExtensions.GetName
- uid: CapyKit.Extensions.EnumerationExtensions.GetPrettyName*
  commentId: Overload:CapyKit.Extensions.EnumerationExtensions.GetPrettyName
  href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetPrettyName_System_Enum_
  name: GetPrettyName
  nameWithType: EnumerationExtensions.GetPrettyName
  fullName: CapyKit.Extensions.EnumerationExtensions.GetPrettyName
- uid: CapyKit.Extensions.EnumerationExtensions.GetDescription*
  commentId: Overload:CapyKit.Extensions.EnumerationExtensions.GetDescription
  href: CapyKit.Extensions.EnumerationExtensions.html#CapyKit_Extensions_EnumerationExtensions_GetDescription_System_Enum_
  name: GetDescription
  nameWithType: EnumerationExtensions.GetDescription
  fullName: CapyKit.Extensions.EnumerationExtensions.GetDescription