Konvertiere Enum in eine Datatable als Extension

    • VB.NET
    • .NET (FX) 4.0

      Konvertiere Enum in eine Datatable als Extension

      In meinen Projekt verwende ich häufig Enums. Nun wäre es ganz praktisch, diese auch in z.B. Comboboxen zu verwenden.
      Ich habe daher eine Extension erstellt, die eine beliebige Enum in eine Datatable umwandelt:
      • Die Enum darf beliebige ganzzahlige Typen annehmen
      • Die zurückgegebene Datatable enthält 2 Spalten:
        Datacolumn "Value" mit dem Wert des Enumerationseintrages
        Datacolumn "Description" mit der Beschreibung des Wertes als Text.
      • Der jeweilige Enum-Wert kann mit einem System.ComponentModel.DescritionAttribute dekoriert werden.
        Diese Angabe wird dann als beschreibender Text übernommen.
      • Ist ein solches Attribut nicht angegeben, so wird der als Text der Name des Enum-Eintrages verwendet.
        Etwa vorhandene Unterstriche im Namen werden in Leerzeichen umgewandelt.

      Die Extension ist nachstehend aufgeführt. Interessant ist dabei die Angabe von Namespace Global.System. Damit ist, losgelöst vom aktuellen Namespace, eine Erweiterung anderer Namespaces möglich:

      VB.NET-Quellcode

      1. Imports System.Runtime.CompilerServices
      2. Imports System.ComponentModel
      4. Namespace Global.System
      5. Public Module GlobalSystemEnumToDatatable
      7. ''' <summary>
      8. ''' Umwandlung eines Enum-Typen in eine Datatable. Alle ganzzahligen Typen werden unterstützt.
      9. ''' </summary>
      10. ''' <param name="EnumType"> Der Type der Enum, erstellt aus z.B. Gettype(MyEnum)</param>
      11. ''' <returns>Eine Datatable mit den Spalten "Value", die den ganzzahligen Wert des jeweilgen Enum-Wertes enthält,
      12. ''' und die Spalte "Description" mit dem beschreibenden Text.</returns>
      13. <Extension()> _
      14. Public Function ToDataTable(EnumType As System.Type) As DataTable
      15. If Not EnumType.IsEnum Then
      16. Throw New TypeAccessException(String.Format("{0}: Ungültige Verwendung. Die Erweiterung darf nur auf den Type System.Enum angewendet werden.", EnumType.ToString))
      17. End If
      18. Dim dt As DataTable = New DataTable(EnumType.ToString)
      19. dt.Columns.Add("Value", [Enum].GetUnderlyingType(EnumType))
      20. dt.Columns.Add("Description", GetType(System.String))
      21. For Each name As String In [Enum].GetNames(EnumType)
      22. dt.Rows.Add({[Enum].Parse(EnumType, name), GetEnumDescription(EnumType, name)})
      23. Next
      24. Return dt
      25. End Function
      26. ''' <summary>
      27. ''' Helferfunktion zum Ermitteln des den Enum-Werteses beschreibenden Textes.
      28. ''' </summary>
      29. ''' <param name="EnumType"> Der Type der zu untersuchenden Enum</param>
      30. ''' <param name="value"> Der Name des zu untersuchenden Wertes</param>
      31. ''' <returns>Ein den Enum-Eintrag beschreibender Text</returns>
      32. ''' <remarks>Der beschreibende Text wird aus dem Namen des Enum-Wertes abgeleitet. Unterstriche werden dabei in Leerzeichen konvertiert.
      33. ''' Ist der Wert mit System.ComponentModel.Descritionattribute dekoriert, so wird der Wert dieses Attributes zurückgegeben.</remarks>
      34. Private Function GetEnumDescription(EnumType As Type, value As String) As String
      35. Dim customAttribute = EnumType.GetField(value).GetCustomAttributes(GetType(DescriptionAttribute), False)
      36. Return If(customAttribute.Length > 0, DirectCast(customAttribute(0), DescriptionAttribute).Description, value.Replace("_"c, " "c))
      37. End Function
      38. End Module
      39. End Namespace


      Die Benutzung ist recht trivial:

      VB.NET-Quellcode

      1. Imports System.ComponentModel
      3. Public Class Form1
      4. Private Sub Form1_Load(sender As Object, e As EventArgs) Handles MyBase.Load
      5. Dim dgv As New DataGridView With {.Size = New Size(400, 200), .Location = New Point(20, 20), .Parent = Me, .AutoSizeColumnsMode = DataGridViewAutoSizeColumnsMode.Fill}
      6. dgv.DataSource = GetType(MyEnum).ToDataTable.DefaultView
      7. End Sub
      8. End Class
      10. Public Enum MyEnum As ULong
      11. Null_mit_anderem_Wert = 4711
      12. Eins
      13. Zwei
      14. <Description("Der 3. Eintrag")> Drei
      15. Vier
      16. End Enum

    Facebook
    Telefonspende