Class GridColumnChooserSettings

Configures grid column chooser settings.

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

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
[Parameter]
public bool AllowTextWrap { get; set; }
Property Value
Type Description
bool

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
[Parameter]
public RenderFragment<object>? FooterTemplate { get; set; }
Property Value
Type
RenderFragment<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
[Parameter]
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
[Parameter]
public RenderFragment<object>? Template { get; set; }
Property Value
Type
RenderFragment<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()

Initializes and sets default values.

Declaration
protected override Task OnInitializedAsync()
Returns
Type
Task
Overrides

OnParametersSetAsync()

Updates property values when component parameters are set.

Declaration
protected override Task OnParametersSetAsync()
Returns
Type
Task
Overrides

Implements