Class GridFilterSettingsBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
GridFilterSettingsBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class GridFilterSettingsBuilder : ControlBuilder
Constructors
GridFilterSettingsBuilder()
Declaration
public GridFilterSettingsBuilder()
GridFilterSettingsBuilder(GridFilterSettings)
Declaration
public GridFilterSettingsBuilder(GridFilterSettings model)
Parameters
Methods
Columns(Object)
Specifies the columns to be filtered at initial rendering of the Grid. You can also get the columns that were currently filtered.
Declaration
public GridFilterSettingsBuilder Columns(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
EnableCaseSensitivity(Boolean)
If enableCaseSensitivity is set to true then searches grid records with exact match based on the filter
operator. It will have no effect on number, boolean and Date fields.
Declaration
public GridFilterSettingsBuilder EnableCaseSensitivity(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
If enableInfiniteScrolling set to true, then the data will be loaded in Checkbox filter Popup content, when the scrollbar reaches the end.
This helps to load large dataset in Checkbox filter Popup content.
{% codeBlock src='grid/enableInfiniteScrolling/index.md' %}{% endcodeBlock %}
Declaration
public GridFilterSettingsBuilder EnableInfiniteScrolling(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
IgnoreAccent(Boolean)
If ignoreAccent set to true, then filter ignores the diacritic characters or accents while filtering.
Declaration
public GridFilterSettingsBuilder IgnoreAccent(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Defines the time delay (in milliseconds) in filtering records when the Immediate mode of filter bar is set.
Declaration
public GridFilterSettingsBuilder ImmediateModeDelay(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
ItemsCount(Double)
If enableInfiniteScrolling set to true, For on demand request, Gets data from the parent data source based on given number of records count.
Declaration
public GridFilterSettingsBuilder ItemsCount(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
LoadingIndicator(IndicatorType)
Defines the loading indicator. The available loading indicator are:
Spinner
Shimmer
Declaration
public GridFilterSettingsBuilder LoadingIndicator(IndicatorType value)
Parameters
Returns
Mode(FilterBarMode)
Defines the filter bar modes. The available options are,
OnEnter: Initiates filter operation after Enter key is pressed.
Immediate: Initiates filter operation after a certain time interval. By default, time interval is 1500 ms.
Declaration
public GridFilterSettingsBuilder Mode(FilterBarMode value)
Parameters
Returns
Operators(Object)
The operators is used to override the default operators in filter menu. This should be defined by type wise
(string, number, date and boolean). Based on the column type, this customize operator list will render in filter menu.
Declaration
public GridFilterSettingsBuilder Operators(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
ShowFilterBarOperator(Boolean)
If 'showFilterBarOperator' is set to true, then it renders the dropdownlist component to select the operator
in filterbar input
Declaration
public GridFilterSettingsBuilder ShowFilterBarOperator(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
ShowFilterBarStatus(Boolean)
Shows or hides the filtered status message on the pager.
Declaration
public GridFilterSettingsBuilder ShowFilterBarStatus(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Type(FilterType)
Defines options for filtering type. The available options are
Menu - Specifies the filter type as menu.
CheckBox - Specifies the filter type as checkbox.
FilterBar - Specifies the filter type as filterbar.
Excel - Specifies the filter type as checkbox.
Declaration
public GridFilterSettingsBuilder Type(FilterType value)
Parameters
Returns
