Class GridGroupSettings

Configures grid grouping.

Inheritance
System.Object
SfBaseComponent
SfDataBoundComponent
GridGroupSettings
Inherited Members
Namespace: Syncfusion.Blazor.Grids
Assembly: Syncfusion.Blazor.dll
Syntax
public class GridGroupSettings : SfDataBoundComponent

Constructors

GridGroupSettings()

Declaration
public GridGroupSettings()

Properties

AllowReordering

If AllowReordering is set to true, Grid allows the grouped elements to be reordered.

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

CaptionTemplate

The Caption Template allows user to display custom group caption.

Declaration
public RenderFragment<object> CaptionTemplate { get; set; }
Property Value
Type Description
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 CaptionTemplateContext of the grid.

Columns

Specifies the column names to group at initial rendering of the Grid. You can also get the currently grouped columns.

Declaration
public string[] Columns { get; set; }
Property Value
Type Description
System.String[]

DisablePageWiseAggregates

If DisablePageWiseAggregates set to true, then the group aggregate value will be calculated from the whole data instead of paged data and two requests will be made for each page when Grid bound with remote service.

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

EnableLazyLoading

The Lazy load grouping, allows the Grid to render only the initial level caption rows in collapsed state while grouping. The child rows of each caption will render only when we expand the captions.

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

ShowDropArea

If ShowDropArea is set to true, the group drop area element will be visible at the top of the Grid.

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

ShowGroupedColumn

If ShowGroupedColumn is set to false, it hides the grouped column after grouping.

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

ShowToggleButton

If ShowToggleButton set to true, then the toggle button will be showed in the column headers which can be used to group or ungroup columns by clicking them.

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

ShowUngroupButton

If ShowUngroupButton set to false, then ungroup button is hidden in dropped element. It can be used to ungroup the grouped column when click on ungroup button.

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

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

OnParametersSetAsync()

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