Enum filters (#1073)

* Updating the Enum filter values to Display attribute for name

* Updated the example to use the Display attribute

* Fixed the param related error

* Example updates

---------

Co-authored-by: Raj Kumar Sri Ramulu <[email protected]>
Co-authored-by: Vikram Reddy <[email protected]>

Author: 3 people

BlazorBootstrap.Demo.RCL/Components/Pages/Grid/03-filters/Grid_Demo_05_Enum_Filters.razor

@@ -1,4 +1,6 @@
-<Grid  TItem="User"
+@using System.ComponentModel.DataAnnotations
+
+<Grid  TItem="User"
        Class="table table-hover table-bordered table-striped"
        DataProvider="UsersDataProvider"
        AllowFiltering="true"
@@ -15,7 +17,7 @@
             @context.DOB
         </GridColumn>
         <GridColumn TItem="User" HeaderText="Status" PropertyName="Status" FilterTextboxWidth="170">
-            @context.Status
+            @(typeof(UserStatus).GetDisplayName(context.Status.ToString()))
         </GridColumn>
     </GridColumns>
 
@@ -60,6 +62,7 @@
     public enum UserStatus
     {
         Registered,
+        [Display(Name = "Pending Verification")]
         VerificationPending,
         Verified
     }

BlazorBootstrap.Demo.RCL/Components/Pages/Grid/03-filters/Grid_Demo_06_Guid_Filters.razor

@@ -1,4 +1,6 @@
-<Grid  TItem="User"
+@using System.ComponentModel.DataAnnotations
+
+<Grid  TItem="User"
        Class="table table-hover table-bordered table-striped"
        DataProvider="UsersDataProvider"
        AllowFiltering="true"
@@ -18,7 +20,7 @@
             @context.DOB
         </GridColumn>
         <GridColumn TItem="User" HeaderText="Status" PropertyName="Status" FilterTextboxWidth="170">
-            @context.Status
+            @(typeof(UserStatus).GetDisplayName(context.Status.ToString()))
         </GridColumn>
     </GridColumns>
 
@@ -64,6 +66,7 @@
     public enum UserStatus
     {
         Registered,
+        [Display(Name = "Pending Verification")]
         VerificationPending,
         Verified
     }

blazorbootstrap/Components/Grid/GridColumnFilter.razor

@@ -62,15 +62,16 @@
                 }
                 else
                 {
-                    <span class="px-2">@filterValue</span>
+                    <span class="px-2">@(PropertyType!.GetDisplayName(filterValue))</span>
                 }
             </DropdownToggleButton>
             <DropdownMenu Class="bb-dropdown-menu-enum" Style="max-height: var(--bb-grid-filter-dropdown-max-height); overflow-x: hidden; overflow-y: auto;">
                 @if (PropertyType is not null)
                 {
                     @foreach (var item in Enum.GetValues(PropertyType!))
                     {
-                        <DropdownItem @onclick="@(async () => await OnEnumFilterValueChangedAsync(item))">@item</DropdownItem>
+                        var name = PropertyType!.GetDisplayName(Enum.GetName(PropertyType!, item));
+                        <DropdownItem @onclick="@(async () => await OnEnumFilterValueChangedAsync(item))">@name</DropdownItem>
                     }
                 }
             </DropdownMenu>

blazorbootstrap/Extensions/TypeExtensions.cs

@@ -1,4 +1,7 @@
 namespace BlazorBootstrap;
+using System.ComponentModel.DataAnnotations;
+using System.Reflection;
+
 
 /// <summary>
 /// Various extension methods for <see cref="Type" />.
@@ -82,5 +85,16 @@ public static string GetPropertyTypeName(this Type type, string propertyName)
         return type.GetProperty(propertyName)?.PropertyType;
     }
 
+    public static string? GetDisplayName(this Type type, string? name)
+    {
+        if (name != null)
+        {
+            var attr = type!.GetMember(name).FirstOrDefault()?.GetCustomAttribute<DisplayAttribute>();
+            name = attr?.Name ?? name;
+        }
+
+        return name;
+    }
+
     #endregion
 }