Class TreeGridFilterSettings

Configures Tree Grid filter settings.

Inheritance
object
ComponentBase
OwningComponentBase
SfOwningComponentBase
SfBaseComponent
SfDataBoundComponent
TreeGridFilterSettings
Implements
Inherited Members
Namespace: Syncfusion.Blazor.TreeGrid
Assembly: Syncfusion.Blazor.dll
Syntax
public class TreeGridFilterSettings : SfDataBoundComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable

Constructors

TreeGridFilterSettings()

Declaration
public TreeGridFilterSettings()

Properties

Columns

Gets or sets the columns to be filtered at the initial rendering of the TreeGrid. You can also get the columns that are currently filtered.

Declaration
[Parameter]
public List<TreeGridFilterColumn> Columns { get; set; }
Property Value
Type Description
List<TreeGridFilterColumn>

A List<T> representing the filtered columns.

HierarchyMode

Gets or sets the filter types. The available options are:

  • Parent: Shows the filtered record with the parent record.
  • Child: Shows the filtered record with the child record.
  • Both: Shows the filtered record with both parent and child records.
  • None: Shows only the filtered record.
Declaration
[Parameter]
public FilterHierarchyMode HierarchyMode { get; set; }
Property Value
Type Description
FilterHierarchyMode

One of the FilterHierarchyMode enumeration values. The default is Parent.

IgnoreAccent

Gets or sets a value indicating whether the filter ignores diacritic characters or accents.

Declaration
[Parameter]
public bool IgnoreAccent { get; set; }
Property Value
Type Description
bool

true if the filter ignores accents; otherwise, false.

ImmediateModeDelay

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

Declaration
[Parameter]
public int ImmediateModeDelay { get; set; }
Property Value
Type Description
int

An int representing the delay in milliseconds. The default is 1500.

Mode

Gets or sets 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, the time interval is 1500 ms.
Declaration
[Parameter]
public FilterBarMode Mode { get; set; }
Property Value
Type Description
FilterBarMode

One of the FilterBarMode enumeration values. The default is OnEnter.

Operators

Gets or sets the operators used to override the default operators in the filter menu.

Declaration
[Parameter]
public object Operators { get; set; }
Property Value
Type Description
object

One of the Operator enumeration values.

ShowFilterBarStatus

Gets or sets a value indicating whether the filtered status message is shown on the pager.

Declaration
[Parameter]
public bool ShowFilterBarStatus { get; set; }
Property Value
Type Description
bool

true if the filtered status message is shown; otherwise, false. The default is true.

Type

Gets or sets the options for filtering type. The available options are:

  • Menu: Specifies the filter type as menu.
  • FilterBar: Specifies the filter type as filterbar.
Declaration
[Parameter]
public FilterType Type { get; set; }
Property Value
Type Description
FilterType

One of the FilterType enumeration values. The default is FilterBar.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type Name Description
RenderTreeBuilder __builder
Overrides

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
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
Task

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

Implements