GroupedDataSource Class

Class providing DataSource grouping - one pass DataSource grouping.

Inheritance Hierarchy

System.Object
  CMS.Base.GroupedDataSource

Namespace: CMS.Base
Assembly: CMS.Base (in CMS.Base.dll) Version: 8.2.23

Syntax

public class GroupedDataSource : IGroupedData, 
	IEnumerable

The GroupedDataSource type exposes the following members.

Constructors

	Name	Description
Public method	GroupedDataSource(Object, String)	Constructor, initializes the GroupedDataSource.
Public method	GroupedDataSource(Object, String, String)	Constructor, initializes the GroupedDataSource.

Methods

	Name	Description
Protected method	AddDataRow	Adds the item to the group table.
Protected method	EnsureList	Ensures the list with specified key value.
Public method	GetEnumerator	Returns grouped datasource enumerator.
Public method	GetGroup	Returns the array list of items from specified group, type of the item depends on the DataSource DataSet, DataView, DataTable -> DataRow
Public method	GetGroupArray	Returns the item group as an array.
Public method	GetGroupDataTable	Returns the item group as an DataTable.
Public method	GetGroupView	Returns the array list of items from specified group, type of the item depends on the DataSource DataSet, DataView, DataTable -> DataRowView
Public method	GetItems	Gets the children based on the given key
Protected method	LoadGroups	Loads the data groups.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToJSON	Returns JSON representation of current instance of IEnumerable. (Defined by DataExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToXML	Returns XML representation of current instance of IEnumerable. (Defined by DataExtensions.)

Fields

	Name	Description
Protected field	firstLevel	Top level of the collection.
Protected field	mColumnName	Column name for grouping.
Protected field	mDataSource	Data source.
Protected field	mGroups	Resulting groups.
Protected field	mLevelColumnName	Column name for level value.
Protected field	mTopItem	Top item object.

Properties

	Name	Description
Public property	ColumnName	Column name for grouping.
Public property	DataSource	Data source.
Public property	LevelColumnName	Column name for level value.
Public property	TopItem	Gets the first available item.