Class TreeGridFilterSettingsBuilder
Inheritance
Namespace: Syncfusion.EJ2.TreeGrid
Assembly: Syncfusion.EJ2.dll
Syntax
public class TreeGridFilterSettingsBuilder : ControlBuilderConstructors
TreeGridFilterSettingsBuilder()
Declaration
public TreeGridFilterSettingsBuilder()TreeGridFilterSettingsBuilder(TreeGridFilterSettings)
Declaration
public TreeGridFilterSettingsBuilder(TreeGridFilterSettings model)Parameters
| Type | Name | Description |
|---|---|---|
| TreeGridFilterSettings | model |
Methods
Columns(Object)
Specifies the columns to be filtered at initial rendering of the TreeGrid. You can also get the columns that were currently filtered.
Declaration
public TreeGridFilterSettingsBuilder Columns(object value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | value |
Returns
HierarchyMode(FilterHierarchyMode)
Defines the filter hierarchy modes. The available options are,
{% codeBlock src='treegrid/hierarchyMode/index.md' %}{% endcodeBlock %}
Declaration
public TreeGridFilterSettingsBuilder HierarchyMode(FilterHierarchyMode value)Parameters
| Type | Name | Description |
|---|---|---|
| FilterHierarchyMode | value |
Returns
IgnoreAccent(Boolean)
If ignoreAccent set to true, then filter ignores the diacritic characters or accents while filtering.
Declaration
public TreeGridFilterSettingsBuilder IgnoreAccent(bool value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Boolean | value |
Returns
ImmediateModeDelay(Double)
Defines the time delay (in milliseconds) in filtering records when the Immediate mode of filter bar is set.
Declaration
public TreeGridFilterSettingsBuilder ImmediateModeDelay(double value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Double | value |
Returns
Mode(FilterBarMode)
Defines the filter bar modes. The available options are,
Declaration
public TreeGridFilterSettingsBuilder Mode(FilterBarMode value)Parameters
| Type | Name | Description |
|---|---|---|
| FilterBarMode | value |
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 TreeGridFilterSettingsBuilder Operators(object value)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | value |
Returns
ShowFilterBarStatus(Boolean)
Shows or hides the filtered status message on the pager.
Declaration
public TreeGridFilterSettingsBuilder 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.
FilterBar - Specifies the filter type as filterbar.
Declaration
public TreeGridFilterSettingsBuilder Type(FilterType value)Parameters
| Type | Name | Description |
|---|---|---|
| FilterType | value |