Class TreeGridFilterSettingsBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
TreeGridFilterSettingsBuilder
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 initial filter configuration for TreeGrid columns or retrieves the current filter state.
Declaration
public TreeGridFilterSettingsBuilder Columns(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
HierarchyMode(FilterHierarchyMode)
Specifies how the hierarchy should be maintained during filtering:
Parent: Displays the filtered records along with their parent records.
Child: Displays the filtered records along with their child records.
Both: Displays the filtered records with both parent and child records.
None: Only displays the filtered records.
Declaration
public TreeGridFilterSettingsBuilder HierarchyMode(FilterHierarchyMode value)
Parameters
Returns
IgnoreAccent(Boolean)
If set to true, filtering ignores accent characters, making diacritic characters identical to their unaccented versions.
Declaration
public TreeGridFilterSettingsBuilder IgnoreAccent(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Determines the delay in milliseconds before filtering is triggered in Immediate mode.
Declaration
public TreeGridFilterSettingsBuilder ImmediateModeDelay(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
Mode(FilterBarMode)
Determines the mode of the filter bar operation. Options include:
OnEnter: Filtering is triggered upon pressing the Enter key.
Immediate: Filtering occurs after a short delay automatically.
Declaration
public TreeGridFilterSettingsBuilder Mode(FilterBarMode value)
Parameters
Returns
Operators(Object)
Allows customization of the default operators offered in the filter menu by defining custom operators for string, number, date, and boolean types.
Declaration
public TreeGridFilterSettingsBuilder Operators(object value)
Parameters
| Type |
Name |
Description |
| System.Object |
value |
|
Returns
ShowFilterBarStatus(Boolean)
Shows or hides the status message related to filtering actions on the pager.
Declaration
public TreeGridFilterSettingsBuilder ShowFilterBarStatus(bool value)
Parameters
| Type |
Name |
Description |
| System.Boolean |
value |
|
Returns
Type(FilterType)
Sets the filtering interface type. Options include:
Menu: Provides a menu for filtering options.
FilterBar: Allows direct input filtering in a bar at the top of each column.
Excel : Specifies the filter type as excel.
CheckBox : Specifies the filter type as check box.
Declaration
public TreeGridFilterSettingsBuilder Type(FilterType value)
Parameters
Returns
