Class TreeGridColumnChooserSettings

Configures Tree Grid column chooser settings.

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

Constructors

TreeGridColumnChooserSettings()

Declaration
public TreeGridColumnChooserSettings()

Properties

AllowTextWrap

Gets or sets a value indicating whether text content in the TreeGrid column chooser will wrap to the next line when it exceeds the cell width.

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

A bool indicating whether text wrapping is enabled in the column chooser. The default value is false.
Remarks

When true, long text within the column chooser will automatically wrap to fit the available cell width, improving readability for columns with lengthy names.

This setting only affects the display within the column chooser dialog and does not impact text wrapping in the main TreeGrid. For TreeGrid-wide text wrapping, use TreeGridTextWrapSettings.

FooterTemplate

Gets or sets the custom footer content for the ColumnChooser.

Declaration
[Parameter]
public RenderFragment<object> FooterTemplate { get; set; }
Property Value
Type Description
RenderFragment<object>

A RenderFragment<TValue> representing the footer template content.
Remarks

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

Operator

Gets or sets the search operator for Column Chooser.

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

One of the Operator enumeration values that specifies the search operator. The default is Operator.StartsWith.

Template

Gets or sets the custom content for the ColumnChooser.

Declaration
[Parameter]
public RenderFragment<object> Template { get; set; }
Property Value
Type Description
RenderFragment<object>

A RenderFragment<TValue> representing the template for custom content.
Remarks

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

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

Implements