Class GridFilterSettings

Inheritance

System.Object

Syncfusion.EJ2.EJTagHelper

GridFilterSettings

Namespace: Syncfusion.EJ2.Grids

Assembly: Syncfusion.EJ2.dll

Syntax

public class GridFilterSettings : EJTagHelper

Constructors

GridFilterSettings()

Declaration

public GridFilterSettings()

Properties

Columns

Specifies the columns to be filtered at initial rendering of the Grid. You can also get the columns that were currently filtered.

Declaration

public object Columns { get; set; }

Property Value

Type	Description
System.Object	The default value is null

ContentTemplate

To get or set value for ContentTemplate.

Declaration

public MvcTemplate<object> ContentTemplate { get; set; }

Property Value

Type
Syncfusion.EJ2.MvcTemplate<System.Object>

EnableCaseSensitivity

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 bool EnableCaseSensitivity { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

EnableInfiniteScrolling

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.

Declaration

public bool EnableInfiniteScrolling { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

IgnoreAccent

If ignoreAccent set to true, then filter ignores the diacritic characters or accents while filtering.

Declaration

public bool IgnoreAccent { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

ImmediateModeDelay

Defines the time delay (in milliseconds) in filtering records when the Immediate mode of filter bar is set.

Declaration

public double ImmediateModeDelay { get; set; }

Property Value

Type	Description
System.Double	The default value is 1500

ItemsCount

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 double ItemsCount { get; set; }

Property Value

Type	Description
System.Double	The default value is 100

LoadingIndicator

Defines the loading indicator. The available loading indicator are: Spinner Shimmer

Declaration

public IndicatorType LoadingIndicator { get; set; }

Property Value

Type	Description
IndicatorType	The default value is IndicatorType.Shimmer

Mode

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 FilterBarMode Mode { get; set; }

Property Value

Type	Description
FilterBarMode	The default value is FilterBarMode.OnEnter

Operators

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 object Operators { get; set; }

Property Value

Type	Description
System.Object	The default value is null

ShowFilterBarOperator

If 'showFilterBarOperator' is set to true, then it renders the dropdownlist component to select the operator in filterbar input

Declaration

public bool ShowFilterBarOperator { get; set; }

Property Value

Type	Description
System.Boolean	The default value is false

ShowFilterBarStatus

Shows or hides the filtered status message on the pager.

Declaration

public bool ShowFilterBarStatus { get; set; }

Property Value

Type	Description
System.Boolean	The default value is true

Type

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 FilterType Type { get; set; }

Property Value

Type	Description
FilterType	The default value is FilterType.FilterBar