ASP.NET MVC - EJ2

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class GridGroupSettingsBuilder - ASP.NETMVC-EJ2 API Reference | Syncfusion

    Show / Hide Table of Contents

    Class GridGroupSettingsBuilder

    Inheritance
    System.Object
    ControlBuilder
    GridGroupSettingsBuilder
    Inherited Members
    ControlBuilder.Output
    ControlBuilder.Context
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: Syncfusion.EJ2.Grids
    Assembly: Syncfusion.EJ2.dll
    Syntax
    public class GridGroupSettingsBuilder : ControlBuilder

    Constructors

    GridGroupSettingsBuilder()

    Declaration
    public GridGroupSettingsBuilder()

    GridGroupSettingsBuilder(GridGroupSettings)

    Declaration
    public GridGroupSettingsBuilder(GridGroupSettings model)
    Parameters
    Type Name Description
    GridGroupSettings model

    Methods

    CaptionTemplate(String)

    The Caption Template allows user to display the string or HTML element in group caption.

    It accepts either the template string or the HTML element ID.

    Declaration
    public GridGroupSettingsBuilder CaptionTemplate(string value)
    Parameters
    Type Name Description
    System.String value
    Returns
    Type Description
    GridGroupSettingsBuilder

    Columns(String[])

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

    Declaration
    public GridGroupSettingsBuilder Columns(string[] value)
    Parameters
    Type Name Description
    System.String[] value
    Returns
    Type Description
    GridGroupSettingsBuilder

    DisablePageWiseAggregates(Boolean)

    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 GridGroupSettingsBuilder DisablePageWiseAggregates(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    GridGroupSettingsBuilder

    EnableLazyLoading(Boolean)

    If enableLazyLoading set to true, then the Grid will render the group caption child rows only when it will expand.

    Declaration
    public GridGroupSettingsBuilder EnableLazyLoading(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    GridGroupSettingsBuilder

    ShowDropArea(Boolean)

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

    Declaration
    public GridGroupSettingsBuilder ShowDropArea(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    GridGroupSettingsBuilder

    ShowGroupedColumn(Boolean)

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

    Declaration
    public GridGroupSettingsBuilder ShowGroupedColumn(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    GridGroupSettingsBuilder

    ShowToggleButton(Boolean)

    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 GridGroupSettingsBuilder ShowToggleButton(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    GridGroupSettingsBuilder

    ShowUngroupButton(Boolean)

    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 GridGroupSettingsBuilder ShowUngroupButton(bool value)
    Parameters
    Type Name Description
    System.Boolean value
    Returns
    Type Description
    GridGroupSettingsBuilder
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved