Class TreeGridFilterSettings

Configures Tree Grid filter settings.

Inheritance
System.Object
SfBaseComponent
SfDataBoundComponent
TreeGridFilterSettings
Inherited Members
Namespace: Syncfusion.Blazor.TreeGrid
Assembly: Syncfusion.Blazor.dll
Syntax
public class TreeGridFilterSettings : SfDataBoundComponent

Constructors

TreeGridFilterSettings()

Declaration
public TreeGridFilterSettings()

Properties

Columns

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

Declaration
public List<TreeGridFilterColumn> Columns { get; set; }
Property Value
Type Description
System.Collections.Generic.List<TreeGridFilterColumn>

HierarchyMode

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.

Declaration
public FilterHierarchyMode HierarchyMode { get; set; }
Property Value
Type Description
FilterHierarchyMode

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

ImmediateModeDelay

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

Declaration
public int ImmediateModeDelay { get; set; }
Property Value
Type Description
System.Int32

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

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

ShowFilterBarStatus

Shows or hides the filtered status message on the pager.

Declaration
public bool ShowFilterBarStatus { get; set; }
Property Value
Type Description
System.Boolean

Type

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

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder __builder

OnInitializedAsync()

Method invoked when the component is ready to start, having received its initial parameters from its parent in the render tree. Override this method if you will perform an asynchronous operation and want the component to refresh when that operation is completed.

Declaration
protected override Task OnInitializedAsync()
Returns
Type Description
System.Threading.Tasks.Task

A System.Threading.Tasks.Task representing any asynchronous operation.
Overrides

OnParametersSetAsync()

Method invoked when the component has received parameters from its parent in the render tree, and the incoming values have been assigned to properties.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type Description
System.Threading.Tasks.Task

A System.Threading.Tasks.Task representing any asynchronous operation.
Overrides