AbstractObjectCollection Class

Base class for the object collection.

Inheritance Hierarchy

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

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

Syntax

public abstract class AbstractObjectCollection : AbstractHierarchicalObject<AbstractObjectCollection>, 
	IComparable

The AbstractObjectCollection type exposes the following members.

Constructors

	Name	Description
Protected method	AbstractObjectCollection	Constructor

Methods

	Name	Description
Public method	CloneCollection	Creates the clone of the collection.
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.
Public method	ContainsColumn	Returns true if specified column is available in current structure. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public method	Disconnect	Disconnects the collection from the database
Public method	GetCompleteWhereCondition	Gets the complete where condition for the 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.
Public method	Reconnect	Reconnects the collection to the database
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 (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterProperties	Registers the properties of this object (Inherited from AbstractHierarchicalObject<TObject>.)
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	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>.)

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	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Fields

	Name	Description
Protected field	mCount	Total number of items.
Protected field	mDisconnectedCount	Number of disconnected references for this collection
Protected field	mInstanceGuid	Instance GUID
Protected field	mLoadBinaryData	Indicates whether to load binary data into the collections.
Protected field	mName	Collection name

Properties

	Name	Description
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property	Columns	Columns to get.
Public property	DynamicWhereCondition	Dynamic where condition.
Public property	EnforceReadOnlyDataAccess	If true, the read only access to the data is enforced within the transaction.
Public property	IsCachedObject	If true, the object is cached within the system for later use
Public property	IsDisconnected	Returns true if this collection is disconnected from the database
Public property	IsLastVersion	If true, the document is the last version (retrieved using DocumentHelper.GetDocument).
Public property	Item	Gets the value of particular property (Inherited from AbstractHierarchicalObject<TObject>.)
Public property	LoadBinaryData	Gets or sets the value which indicates whether to load binary data into the collections.
Public property	Name	Collection name
Public property	OrderBy	Order by expression.
Public property	ParentStorage	Parent storage
Public property	Properties	Properties available through the context. (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	PropertyList	Used property list (Inherited from AbstractHierarchicalObject<TObject>.)
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>.)
Public property	TopN	Select top N objects.
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.