Blazor

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridFilterSettings

    Show / Hide Table of Contents

    Class GridFilterSettings

    Configures grid filtering.

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

    Constructors

    GridFilterSettings()

    Declaration
    public GridFilterSettings()

    Properties

    Columns

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

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

    Use GridFilterColumn component to define filter criteria.

    EnableCaseSensitivity

    If EnableCaseSensitivity is set to true then searches grid records with exact match based on the filter operator. It will have no effect on number, boolean and Date fields.

    Declaration
    public bool EnableCaseSensitivity { 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.

    • OnEnterInitiate filter operation after Enter key is pressed.
    • ImmediateInitiate filter operation after certain time interval. By default time interval is 1500ms.
    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.

    • FilterBarDefault. Specifies the filter type as filter bar.
    • MenuSpecifies the filter type as menu.
    • CheckBoxSpecifies the filter type as check box.
    • ExcelSpecifies the filter type as excel.
    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()

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

    OnParametersSetAsync()

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

    UpdateChildProperties(String, List<GridFilterColumn>)

    Declaration
    public void UpdateChildProperties(string key, List<GridFilterColumn> value)
    Parameters
    Type Name Description
    System.String key
    System.Collections.Generic.List<GridFilterColumn> value
    Back to top Generated by DocFX
    Copyright © 2001 - 2023 Syncfusion Inc. All Rights Reserved