Overview
Simple Enum Filter
The SimpleEnumFilter<T>
filter allows (as the name suggests) for your table to be filtered by enum properties. This filter can only be applied to properties that have an Enum
as their type. The filter allows for individual or multiple enum values to act as the filter as well as the ability to only permit certain enum values in the event you need to lock down certain options.
The table below demonstrates how the enum filter can be used to either filter by individual values, multiple values or a restricted selection of multiple values.
Id |
No Filter |
Filter (Multiple) |
Filter (Multiple, Restricted) |
Filter (Single) |
---|---|---|---|---|
No records! | ||||
Displaying Page: 1 of 0 (0 total records)
|
Parameters
The following parameters can be set for each SimpleEnumFilter<T>
.
Parameter | Type | Required | Description | Default Value |
---|---|---|---|---|
TEnum |
type parameter | ✅ | This is a mandatory type parameter and must be same enum as the target property | null |
PermittedValues |
List<TEnum> |
❌ | If set, then only the values provided can be selected by this filter. If this is not set then all possible enum values can be used in the filter | All enum values |
DefaultValues |
List<TEnum> |
❌ | If set, then this filter will be active when the table loads with the provided values applied. | null |
AllowMultiple |
bool |
❌ | Allows for multiple emum values to be selected | false |