ObjectDataSet<TObject> Class

Base object 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.ObjectDataSet<TObject>
        CMS.DataEngine.InfoDataSet<TInfo>
        CMS.DocumentEngine.TreeNodeDataSet

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

Syntax

public abstract class ObjectDataSet<TObject> : DataSet, 
	IReadOnlyFlag, IEnumerable<TObject>, IEnumerable
where TObject : class

Type Parameters

TObject

The ObjectDataSet<TObject> type exposes the following members.

Constructors

	Name	Description
Public method	ObjectDataSet<TObject>()	Constructor
Public method	ObjectDataSet<TObject>(DataSet)	Constructor, creates new DataSet using data from the given DataSet

Methods

	Name	Description
Public method	GetEnumerator	Returns the strongly typed enumerator for this collection
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	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	Batch<TObject>	Returns input in batches of batchSize size. (Defined by BaseExtensions.)
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	ToDictionaryById	Converts the DataSet to a dictionary indexed by object ID (Defined by DataExtensions.)
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	ToHashSet<TObject>	Converts the list of objects to a hash set of distinct values (Defined by DataExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
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	ToList<TObject, TTo>	Converts the given collection to a list of values (Defined by BaseExtensions.)
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.)
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 charactes and tries it again. (Defined by HelpersExtensions.)

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