Class TreeGridFilterSettings
Inheritance
Namespace: Syncfusion.EJ2.TreeGrid
Assembly: Syncfusion.EJ2.dll
Syntax
public class TreeGridFilterSettings : EJTagHelper
Constructors
TreeGridFilterSettings()
Declaration
public TreeGridFilterSettings()
Properties
Columns
Specifies the initial filter configuration for TreeGrid columns or retrieves the current filter state.
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> |
HierarchyMode
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 FilterHierarchyMode HierarchyMode { get; set; }
Property Value
Type | Description |
---|---|
FilterHierarchyMode | The default value is FilterHierarchyMode.Parent |
IgnoreAccent
If set to true
, filtering ignores accent characters, making diacritic characters identical to their unaccented versions.
Declaration
public bool IgnoreAccent { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
ImmediateModeDelay
Determines the delay in milliseconds before filtering is triggered in Immediate
mode.
Declaration
public double ImmediateModeDelay { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 1500 |
Mode
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 FilterBarMode Mode { get; set; }
Property Value
Type | Description |
---|---|
FilterBarMode | The default value is Syncfusion.EJ2.Grids.FilterBarMode.OnEnter |
Operators
Allows customization of the default operators offered in the filter menu by defining custom operators for string, number, date, and boolean types.
Declaration
public object Operators { get; set; }
Property Value
Type | Description |
---|---|
System.Object | The default value is null |
ShowFilterBarStatus
Shows or hides the status message related to filtering actions on the pager.
Declaration
public bool ShowFilterBarStatus { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
Type
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 FilterType Type { get; set; }
Property Value
Type | Description |
---|---|
FilterType | The default value is FilterType.FilterBar |