Class TreeGridSearchSettings

Configures Tree Grid search settings.

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

Constructors

TreeGridSearchSettings()

Declaration
public TreeGridSearchSettings()

Properties

Fields

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

Declaration
public string[] Fields { get; set; }
Property Value
Type Description
System.String[]

An array of column names to be searched.

HierarchyMode

Defines the filter types. The available options are, Parent: Searches only the parent records with the specified Key. Child: Searches only the child records with the specified Key.

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

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

IgnoreAccent

If IgnoreAccent is 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

true if accents are ignored; otherwise, false.
Remarks

Ignore Accent is supported by remote data alone. IgnoreAccent key will be sent to server and the operation should be handled at user level.

IgnoreCase

If IgnoreCase is set to true, then search ignores the diacritic characters or accents while filtering.

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

true if case is ignored; otherwise, false. The default is true.

Key

A key word for searching the TreeGrid content.

Declaration
public string Key { get; set; }
Property Value
Type Description
System.String

The search keyword.

Operator

Defines the operator to search records.

Declaration
public Operator Operator { get; set; }
Property Value
Type Description
Operator

One of the Operator enumeration values.

Methods

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