Group Class

Represents the class that provides a group which defines a set of records that belong to a category. A group has multiple sections such as CaptionSection, SummarySection, GroupsDetailsSection, and RecordsDetailsSection.
Object Model
Group ClassCaptionSection ClassSortColumnDescriptorCollection ClassSortColumnDescriptor ClassDetailsSection ClassEngine ClassTable ClassFilteredRecordsInDetailsCollection ClassRecord ClassFlattenedFilteredRecordsInGroupCollection ClassRecord ClassFlattenedRecordsInGroupCollection ClassRecord ClassGroupsInDetailsCollection ClassGroup ClassGroupTypedListRecordsCollection ClassRecord ClassChildTable ClassElement ClassElement ClassGroup ClassRecord ClassSection ClassTable ClassTableDescriptor ClassRecordsInDetailsCollection ClassRecord ClassSectionInGroupCollection ClassSection ClassISummarySection Interface
Public Class Group 
   Inherits Element
   Implements Syncfusion.Collections.BinaryTree.IDisposedEvent, Syncfusion.Collections.BinaryTree.IIsDisposedProperty, Syncfusion.Collections.BinaryTree.ITreeTableCounterSource, Syncfusion.Collections.BinaryTree.ITreeTableSummaryArraySource 
Dim instance As Group
public class Group : Element, Syncfusion.Collections.BinaryTree.IDisposedEvent, Syncfusion.Collections.BinaryTree.IIsDisposedProperty, Syncfusion.Collections.BinaryTree.ITreeTableCounterSource, Syncfusion.Collections.BinaryTree.ITreeTableSummaryArraySource  
Groups are created when the records of a table are categorized or when a new record is inserted. Normally, the categories are based on the TableDescriptor.GroupedColumns but programmers can also provide their own categorization routines by implementing a SortColumnDescriptor.Comparer for a SortColumnDescriptor. Before groups are categorized, the records are sorted in the order as specified by TableDescriptor.GroupedColumns. After the records are sorted, the Table object loops through all records to determine the categories records belong to.

Another collection in the TableDescriptor that defines categorization is the TableDescriptor.RelationChildColumns collection. RelationChildColumns will be added when there is a parent-child relation between two tables. The child table of such a relation must be sorted by the columns that are used to identify a record. These columns match the foreign key columns of the parent table. For every new category key with regards to RelationChildColumns a ChildTable is created. The ChildTable class is derived from the Group.

A group can either be a final node with records or it can be a node with nested groups. If a group has records, its Groups collection will be empty and the Records collection will contain all records. If a group has nested groups, its Groups collection will have the nested groups and the Records collection will be empty.

A group can be expanded and collapsed with its IsExpanded property. Expansion of groups will show or hide nested elements of the group within the Table.DisplayElements collection.

A table has at least one group. The Table.TopLevelGroup is a ChildTable which is derived from Group.

The Element.GroupLevel property will return the group level how deep the group is nested.

Inheritance Hierarchy



Syncfusion.Grouping.Base: 18.2460.0.44

See Also