InfoDataSet<TInfo> Class

CMS DataSet class. Enhancement to DataSet to provide strongly typed collection side-by-side with the data.

Inheritance Hierarchy

System.Object
  System.ComponentModel.MarshalByValueComponent
    System.Data.DataSet
      CMS.DataEngine.InfoDataSet<TInfo>

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 11.0.0

Syntax

public class InfoDataSet<TInfo> : DataSet, 
	IReadOnlyFlag, IEnumerable<TInfo>, IEnumerable, IInfoDataSet
where TInfo : BaseInfo

Type Parameters

TInfo

The InfoDataSet<TInfo> type exposes the following members.

Constructors

	Name	Description
Public method	InfoDataSet<TInfo>()	Constructor
Public method	InfoDataSet<TInfo>(DataSet)	Constructor, creates new DataSet using data from the given DataSet. Removes data from the original data set.
Public method	InfoDataSet<TInfo>(TInfo[])	Constructor

Fields

	Name	Description
Protected field	mItems	Items in the DataSet

Properties

	Name	Description
Public property	IsReadOnly	If true, the dataset is cached (not allowed to modify, must be cloned)
Public property	Items	Items in the DataSet

Methods

	Name	Description
Protected method	AddItems	Adds the items to the data set
Public method	Clone	Clones the DataSet
Protected method	CreateEmptyDataSet	Creates the empty DataSet based on the current type
Public method	GetEnumerator	Gets the strongly typed enumerator for the collection
Public method	GetNewObject	Gets new instance of the object hosted in this DataSet
Protected method	GetObjectEnumerator	Gets the object enumerator for the collection
Protected method	NewCollection	Creates new collection of the objects

Extension Methods

	Name	Description
Public Extension Method	As<InfoType>	Converts the DataSet to a strongly typed one (Defined by DataExtensions.)
Public Extension Method	AsModifyable	Ensures that the given DataSet is not cached, copies the data if it is (Defined by DataExtensions.)
Public Extension Method	Batch<TInfo>	Returns input in batches of batchSize size. (Defined by BaseExtensions.)
Public Extension Method	ToContactList	Converts ContactInfoDataSet into list. (Defined by ContactDataSetExtensions.)
Public Extension Method	ToDictionaryById	Converts the DataSet to a dictionary indexed by object ID (Defined by DataExtensions.)
Public Extension Method	ToHashSet<TInfo>	Converts the list of objects to a hash set of distinct values (Defined by DataExtensions.)
Public Extension Method	ToJSON(Boolean)	Overloaded. Exports DataSet to JSON string. (Defined by DataExtensions.)
Public Extension Method	ToJSON(String, Boolean)	Overloaded. Returns JSON representation of current instance of IEnumerable. (Defined by DataExtensions.)
Public Extension Method	ToXML	Returns XML representation of current instance of IEnumerable. (Defined by DataExtensions.)
Public Extension Method	TryReadXml	Tries to read xml and load the data from it to the DataSet via standard .NET method. If the load fails, it removes all the forbidden whitespace characters and tries it again. (Defined by HelpersExtensions.)