menu

Blazor

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class TreeGridFilterSettings - Blazor API Reference | Syncfusion

    Show / Hide Table of Contents

    Class TreeGridFilterSettings

    Configures Tree Grid filter settings.

    Inheritance
    System.Object
    SfBaseComponent
    SfDataBoundComponent
    TreeGridFilterSettings
    Inherited Members
    SfBaseComponent.Dispose()
    SfBaseComponent.Dispose(Boolean)
    SfBaseComponent.OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)
    SfDataBoundComponent.DataManager
    SfDataBoundComponent.MainParent
    SfDataBoundComponent.OnAfterRenderAsync(Boolean)
    SfDataBoundComponent.SetDataManager<T>(Object)
    Namespace: Syncfusion.Blazor.TreeGrid
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class TreeGridFilterSettings : SfDataBoundComponent

    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
    public List<TreeGridFilterColumn> Columns { get; set; }
    Property Value
    Type Description
    System.Collections.Generic.List<TreeGridFilterColumn>

    A System.Collections.Generic.List<> representing the filtered columns.

    HierarchyMode

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

    Declaration
    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
    public bool IgnoreAccent { get; set; }
    Property Value
    Type Description
    System.Boolean

    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
    public int ImmediateModeDelay { get; set; }
    Property Value
    Type Description
    System.Int32

    An System.Int32 representing the delay in milliseconds. The default is 1500.

    Mode

    Gets or sets the filter bar modes. The available options are:

    Declaration
    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
    public object Operators { get; set; }
    Property Value
    Type Description
    System.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
    public bool ShowFilterBarStatus { get; set; }
    Property Value
    Type Description
    System.Boolean

    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:

    Declaration
    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
    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
    SfDataBoundComponent.OnInitializedAsync()

    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
    SfDataBoundComponent.OnParametersSetAsync()
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved