menu

Blazor

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

    Show / Hide Table of Contents

    Class GridColumnChooserSettings

    Configures grid column chooser settings.

    Inheritance
    System.Object
    SfBaseComponent
    SfDataBoundComponent
    GridColumnChooserSettings
    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.Grids
    Assembly: Syncfusion.Blazor.dll
    Syntax
    public class GridColumnChooserSettings : SfDataBoundComponent

    Constructors

    GridColumnChooserSettings()

    Declaration
    public GridColumnChooserSettings()

    Properties

    AllowTextWrap

    Gets or sets a value that determines whether the header text in the column chooser dialog wraps to the next line when it exceeds the width of the dialog.

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

    true to enable text wrapping; otherwise, false. The default value is false.

    Remarks

    Text wrapping is not applicable when using the ColumnChooserTemplateContext.

    FooterTemplate

    Defines the custom footer content for the column chooser.This can be used to introduce own UI inside the column chooser dialog footer content.

    Declaration
    public RenderFragment<object> FooterTemplate { get; set; }
    Property Value
    Type
    Microsoft.AspNetCore.Components.RenderFragment<System.Object>
    Remarks

    The parameters passed to the templates can be accessed using implicit parameter named context. The context is of type ColumnChooserFooterTemplateContext of the grid.

    Operator

    Defines the search operator for Column Chooser. By default search operator is Operator.

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

    Template

    Defines the custom content for the column chooser dialog. This can be used to introduce own UI inside the column chooser dialog content. The checkboxes can be rendered using GridColumnChooserItem component.

    Declaration
    public RenderFragment<object> Template { get; set; }
    Property Value
    Type
    Microsoft.AspNetCore.Components.RenderFragment<System.Object>
    Remarks

    The parameters passed to the templates can be accessed using implicit parameter named context. The context is of type ColumnChooserTemplateContext of the grid.

    Methods

    OnInitializedAsync()

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

    OnParametersSetAsync()

    Declaration
    protected override Task OnParametersSetAsync()
    Returns
    Type
    System.Threading.Tasks.Task
    Overrides
    SfDataBoundComponent.OnParametersSetAsync()
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved