Interface IPassThroughGroupingResult
Represents an interface for pass through grouping support in the grouping engine. If you assign a data source which implements this interface as data source for the grouping engine, the engine will interact with the data source through this interface and query groups details and nested tables on demand only.
Inherited Members
Namespace: Syncfusion.Grouping
Assembly: Syncfusion.Grouping.Base.dll
Syntax
public interface IPassThroughGroupingResult : IEnumerable, ITypedListProperties
GroupByColumns
Gets the fields the query is grouped by. A query can be grouped by multiple levels.
Declaration
string[] GroupByColumns { get; }Property Value
| Type |
|---|
| System.String[] |
Methods
GetGroupByKey(String, Object)
Returns the category of a new group that will be associated with the given item.
Declaration
object GetGroupByKey(string column, object item)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | column | A name that matches one of the strings return by GroupByColumns |
| System.Object | item | The item the group is associated with. |
Returns
| Type | Description |
|---|---|
| System.Object | The group category for the given item. |
GetItemCount(Group, Object)
Returns the child count for a given group. This is the count that is displayed in the caption.
Declaration
int GetItemCount(Group group, object item)Parameters
| Type | Name | Description |
|---|---|---|
| Group | group | The group in the grouping engine. |
| System.Object | item | The item the group is associated with. |
Returns
| Type | Description |
|---|---|
| System.Int32 | The child count for a given group. |
GetItems(Group, Object)
Gets the items for a given group. The items can either be nested groups or records.
Declaration
IEnumerable GetItems(Group group, object item)Parameters
| Type | Name | Description |
|---|---|---|
| Group | group | The group in the grouping engine. |
| System.Object | item | The item the group is associated with. |
Returns
| Type | Description |
|---|---|
| System.Collections.IEnumerable | The items for a given group. |
GetListItemType()
Gets the data type of the items in the data source. This information is used for instantiating and adding new items to the data source.
Declaration
Type GetListItemType()Returns
| Type | Description |
|---|---|
| System.Type | The data type of the items in the data-source. |
GetNestedItems(RelationDescriptor, ChildTable, Object[], out Object)
Returns the nested items for a parent record when it is expanded. In the implementation for this method you should execute a query on the related table and match the records to the criteria specified using the keys argument and the RelationDescriptor information specified with the rd argument.
Declaration
IEnumerable GetNestedItems(RelationDescriptor rd, ChildTable childTable, object[] keys, out object totals)Parameters
| Type | Name | Description |
|---|---|---|
| RelationDescriptor | rd | The RelationDescriptor that describes the relation |
| ChildTable | childTable | The child table where the new items will be added after this method returns. |
| System.Object[] | keys | The identifier for the nested records |
| System.Object | totals | The number of child elements in the nested table or an object with summaries. |
Returns
| Type | Description |
|---|---|
| System.Collections.IEnumerable | The results of the query for the nested records. |
GetSampleItems()
Returns the first few items of this result. The GridGroupingControl will loop through this items to determine the optimum width of columns.
Declaration
IEnumerable GetSampleItems()Returns
| Type | Description |
|---|---|
| System.Collections.IEnumerable | First few items. |
GetTotals()
Returns totals for the whole table. It can be an integer that represents the count that is displayed in the caption for the TopLevelGroup. You can also return a object which contains summaries for the whole table.
Declaration
object GetTotals()Returns
| Type | Description |
|---|---|
| System.Object | Returns Totals. |