ObjectCollection<TObject> Class

Object list.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractSimpleDataContainer<AbstractObjectCollection>
    CMS.Base.AbstractDataContainer<AbstractObjectCollection>
      CMS.Base.AbstractHierarchicalObject<AbstractObjectCollection>
        CMS.DataEngine.AbstractObjectCollection
          CMS.DataEngine.ObjectCollection<TObject>
            CMS.DataEngine.InfoObjectCollection
            CMS.DocumentEngine.TreeNodeCollection

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

Syntax

public abstract class ObjectCollection<TObject> : AbstractObjectCollection, 
	IIndexable<TObject>, INameIndexable<TObject>, INameIndexable, IIndexable, 
	ICMSQueryable<TObject>, ICMSQueryable, IOrderedQueryable<TObject>, IQueryable<TObject>, 
	IOrderedQueryable, IQueryable, INamedEnumerable<TObject>, INamedEnumerable, IEnumerable<TObject>, 
	IEnumerable, IVirtualTypedCollection, ITypedCollection
where TObject : class

Type Parameters

TObject

The ObjectCollection<TObject> type exposes the following members.

Constructors

	Name	Description
Protected method	ObjectCollection<TObject>

Methods

	Name	Description
Public method	Add(IEnumerable<TObject>)	Adds new object to the collection.
Public method	Add(TObject[])	Adds new object to the collection.
Public method	Clear	Clears the current items in the collection.
Public method	Clone	Creates the clone of the collection.
Public method	CloneCollection	Creates the clone of this collection. (Overrides AbstractObjectCollection.CloneCollection().)
Public method	CombineWith	Combines current instance with other properties (modifies current instace!). List properties are merged from all the participating typeinfos, other properties are taken as first non-null value (non-null is determined by nullValues collection). (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	CompareTo	Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. (Inherited from AbstractObjectCollection.)
Public method	ContainsColumn	Returns true if specified column is available in current structure. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public method	CreateChild	Creates the child collection based on the given provider
Public method	CreateNewObject	Creates new object for this collection.
Protected method	CreateQueryProvider	Creates a LINQ query provider for this collection
Public method	Disconnect	Disconnects the collection from the database (Inherited from AbstractObjectCollection.)
Protected method	EnsureItems	Ensures the specified number of items in the item list.
Public method	GetCompleteWhereCondition	Gets the complete where condition for the collection (Inherited from AbstractObjectCollection.)
Protected method	GetData	Gets the data for the collection.
Public method	GetEmptyObject	Gets an empty object for this collection
Public method	GetEnumerator	Gets the enumerator for the collection.
Public method	GetEnumeratorInternal	Gets the enumerator for the collection.
Protected method	GetFullData	Gets the data set of the data behind this collection
Protected method	GetItem	Gets the item on the specified index.
Public method	GetNameWhereCondition	Gets the where condition for the given object name.
Protected method	GetObjectByNameInternal	Gets the object by its name, internal representation that gets data from database
Protected method	GetObjectEnumerator	Gets the object enumerator for the collection
Public method	GetObjectName(Object)	Returns the name of the given object
Public method	GetObjectName(TObject)	Registers new object in this collection.
Public method	GetProperty	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Protected method	GetPropertyType	Gets the type of the given property (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	GetValue	Gets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	HasSetter	Returns true if given property has a setter (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	MakeEmpty	Makes the collection empty. (Inherited from AbstractObjectCollection.)
Public method	Reconnect	Reconnects the collection to the database (Inherited from AbstractObjectCollection.)
Protected method	RegisterColumn(String, Func<TObject, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumn(String, Func<TObject, Object>, Func<TObject, Object, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumns	Registers the Columns of this object (Overrides AbstractSimpleDataContainer<TObject>.RegisterColumns().)
Protected method	RegisterProperties	Registers the properties of this object (Overrides AbstractHierarchicalObject<TObject>.RegisterProperties().)
Protected method	RegisterProperty(String, Func<TObject, Object>)	Registers the given property to the object (Inherited from AbstractHierarchicalObject<TObject>.)
Protected method	RegisterProperty(String, Object, Func<TObject, Object, Object>)	Registers the given parameterized property to the object. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	Remove(IEnumerable<TObject>)	Removes the specified object from the collection.
Public method	Remove(TObject[])	Removes the specified object from the collection.
Public method	SetProperty	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	SetValue	Sets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	TryGetProperty(String, Object)	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	TryGetProperty(String, Object, Boolean)	Returns value of property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	TryGetValue	Returns value of column. (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	UseData	Initializes the collection with the given source data
Protected method	ValidateItem	Validates whether the item can be member of the collection (collection can work with it). Returns true if item is valid.

Operators

	Name	Description
Public operator Static member	Implicit(ObjectCollection<TObject> to DataSet)	Implicit operator for conversion from ObjectCollection class to DataSet

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	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	GetNamedEnumerator<T>	Name enumerator over a collection (Defined by DataExtensions.)
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	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	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.)

Fields

	Name	Description
Protected field	mAllowPaging	If true, the paging of the data is allowed (data is loaded in batches).
Protected field	mColumnNames	Column names
Protected field	mCount	Total number of items. (Inherited from AbstractObjectCollection.)
Protected field	mCountDifference	Difference in count of the items from data source and current number of items
Protected field	mDeletedItems	Deleted items removed from the collection.
Protected field	mDisconnectedCount	Number of disconnected references for this collection (Inherited from AbstractObjectCollection.)
Protected field	mInstanceGuid	Instance GUID (Inherited from AbstractObjectCollection.)
Protected field	mItems	Items collection.
Protected field	mLoadBinaryData	Indicates whether to load binary data into the collections. (Inherited from AbstractObjectCollection.)
Protected field	mName	Collection name (Inherited from AbstractObjectCollection.)
Protected field	mNewItems	New items added to the collection.
Protected field	mObjectsByName	Objects by name.
Protected field	mPageSize	Page size for loading of the items.
Protected field	mSourceData	Source data for the collection

Properties

	Name	Description
Public property	AllowPaging	If true, the paging of the data is allowed (data is loaded in batches).
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property	Columns	Columns to get. (Inherited from AbstractObjectCollection.)
Public property	Count	Returns the number of items.
Public property	DynamicWhereCondition	Dynamic where condition. (Inherited from AbstractObjectCollection.)
Public property	ElementType	Returns the element type.
Public property	EnforceReadOnlyDataAccess	If true, the read only access to the data is enforced within the transaction. (Inherited from AbstractObjectCollection.)
Public property	Expression	Query expression
Public property	FirstItem	Returns the first item of the collection
Protected property	InternalCount	Internal count of the items
Public property	IsCachedObject	If true, the object is cached within the system for later use (Inherited from AbstractObjectCollection.)
Public property	IsDisconnected	Returns true if this collection is disconnected from the database (Inherited from AbstractObjectCollection.)
Public property	IsLastVersion	If true, the document is the last version (retrieved using DocumentHelper.GetDocument). (Inherited from AbstractObjectCollection.)
Public property	IsOffline	Returns true, if the collection is offline (not backed up by the database but by the source data)
Public property	Item[Int32]	Gets or sets the object on specific index.
Public property	Item[String]	Returns the object registered by the specific name.
Protected property	Items	Returns the items collection.
Public property	ItemsHaveNames	Returns true if the items in the collection have names
Public property	ItemType	Result type
Public property	LastItem	Returns the last item of the collection
Public property	LoadBinaryData	Gets or sets the value which indicates whether to load binary data into the collections. (Overrides AbstractObjectCollection.LoadBinaryData.)
Public property	Name	Collection name (Inherited from AbstractObjectCollection.)
Public property	NameColumn	Name column name
Protected property	ObjectsByName	Objects by name collection.
Public property	OrderBy	Order by expression. (Inherited from AbstractObjectCollection.)
Public property	ParentStorage	Parent storage (Inherited from AbstractObjectCollection.)
Public property	Properties	Properties available through the context. (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	PropertyList	Used property list (Inherited from AbstractHierarchicalObject<TObject>.)
Public property	Provider	Query provider
Protected property	RegisteredColumns	Registered Columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredColumnsObject	Registered Columns object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredProperties	Registered properties (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	RegisteredPropertiesObject	Registered properties object (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	RemovedObject	Defines the removed object within collection
Public property	SortNames	If true, the names in enumeration are sorted
Public property	TopN	Select top N objects. (Inherited from AbstractObjectCollection.)
Protected property	UseLocalColumns	If true, the object uses local columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	UseLocalProperties	If true, the object uses local properties (Inherited from AbstractHierarchicalObject<TObject>.)
Public property	WhereCondition	Where condition. (Inherited from AbstractObjectCollection.)