Class TreeGridSearchSettings

Configures Tree Grid search settings.

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

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
[Parameter]
public string[] Fields { get; set; }
Property Value
Type Description
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
[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 whether the filter ignores diacritic characters or accents while filtering the data.

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

A bool indicating whether accents are ignored while filtering. The default value is false (accented characters are considered).
Remarks

Ignore Accent is supported by remote data only.

The IgnoreAccent key will be sent to the server, and the operation should be handled at the user level.

IgnoreCase

Gets or sets whether the search ignores case sensitivity while filtering.

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

A bool indicating whether case is ignored while searching. The default value is true (case is ignored); otherwise, false, case is considered.
Remarks

When set to true

, the search will treat uppercase and lowercase letters as equivalent.

This property affects the search operation on the Tree Grid columns.

Key

A key word for searching the TreeGrid content.

Declaration
[Parameter]
public string Key { get; set; }
Property Value
Type Description
string

The search keyword.

Operator

Defines the operator to search records.

Declaration
[Parameter]
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
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