Class TreeGridFilterSettingsBuilder
Inheritance
System.Object
TreeGridFilterSettingsBuilder
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Assembly: Syncfusion.EJ2.dll
Syntax
public class TreeGridFilterSettingsBuilder : ControlBuilder
Constructors
TreeGridFilterSettingsBuilder()
Declaration
public TreeGridFilterSettingsBuilder()
TreeGridFilterSettingsBuilder(TreeGridFilterSettings)
Declaration
public TreeGridFilterSettingsBuilder(TreeGridFilterSettings model)
Parameters
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 types. The available options are,
Parent: Shows the filtered record with parent record.
Child: Shows the filtered record with child record.
Both : shows the filtered record with both parent and child record.
None : Shows only filtered record.
{% codeBlock src='treegrid/hierarchyMode/index.md' %}{% endcodeBlock %}
Declaration
public TreeGridFilterSettingsBuilder HierarchyMode(FilterHierarchyMode value)
Parameters
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
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,
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 TreeGridFilterSettingsBuilder 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 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
Returns