GridSerializer.EnableGrouping Method

Configures the grid to display grouping.

Namespace:  Microsoft.SharePoint.JSGrid
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Public Sub EnableGrouping ( _
    groupedColumns As FieldOrderCollection, _
    groupingGridRowStyleIds As IEnumerable(Of Object), _
    groupingGanttBarStyleIds As IEnumerable(Of Object), _
    fnPopulateGroupingRows As PopulateGroupingRows, _
    hierarchyOutlineTextColumnName As String, _
    enableHierarchicalGrouping As Boolean _
)
'Usage
Dim instance As GridSerializer
Dim groupedColumns As FieldOrderCollection
Dim groupingGridRowStyleIds As IEnumerable(Of Object)
Dim groupingGanttBarStyleIds As IEnumerable(Of Object)
Dim fnPopulateGroupingRows As PopulateGroupingRows
Dim hierarchyOutlineTextColumnName As String
Dim enableHierarchicalGrouping As Boolean

instance.EnableGrouping(groupedColumns, _
    groupingGridRowStyleIds, groupingGanttBarStyleIds, _
    fnPopulateGroupingRows, hierarchyOutlineTextColumnName, _
    enableHierarchicalGrouping)

public void EnableGrouping(
    FieldOrderCollection groupedColumns,
    IEnumerable<Object> groupingGridRowStyleIds,
    IEnumerable<Object> groupingGanttBarStyleIds,
    PopulateGroupingRows fnPopulateGroupingRows,
    string hierarchyOutlineTextColumnName,
    bool enableHierarchicalGrouping
)

Parameters

• groupedColumns
  Type: Microsoft.SharePoint.JSGrid.FieldOrderCollection

  The groupable columns.

• groupingGridRowStyleIds
  Type: System.Collections.Generic.IEnumerable<Object>

  Specifies the cell style to be used to format cells in each grouping row.

• groupingGanttBarStyleIds
  Type: System.Collections.Generic.IEnumerable<Object>

  Specifies the Gantt style to be used to format Gantt bar associated with each grouping row.

• fnPopulateGroupingRows
  Type: Microsoft.SharePoint.JSGrid.PopulateGroupingRows

  Provides a delegate that the grid calls for each generated grouping row to be serialized.

• hierarchyOutlineTextColumnName
  Type: System.String

  Specifies which grid column should display the controls used to expand and collapse hierarchy nodes.

• enableHierarchicalGrouping
  Type: System.Boolean

  Specifies that if a hierarchy table is provided for a grid field that is being grouped on, to group subordinate values under their parent values, as indicated by the hierarchy table.

See Also

Reference

GridSerializer Class

GridSerializer Members

Microsoft.SharePoint.JSGrid Namespace