InfoObjectCollection<TInfo> Class

Generic info object collection.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractSimpleDataContainer<InfoObjectCollection<TInfo>>
    CMS.Base.AbstractDataContainer<InfoObjectCollection<TInfo>>
      CMS.Base.AbstractHierarchicalObject<InfoObjectCollection<TInfo>>
        CMS.DataEngine.InfoObjectCollection<TInfo>
          More...

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

Syntax

public class InfoObjectCollection<TInfo> : AbstractHierarchicalObject<InfoObjectCollection<TInfo>>, 
	IInfoObjectCollection<TInfo>, IInfoObjectCollection, IComparable, INamedEnumerable, IEnumerable, 
	IIndexable, INameIndexable, IVirtualTypedCollection, ITypedCollection, ICMSQueryable, 
	IMacroSecurityCheckPermissions, ICMSQueryable<TInfo>, IOrderedQueryable<TInfo>, IQueryable<TInfo>, 
	IEnumerable<TInfo>, IQueryable, IOrderedQueryable, INamedEnumerable<TInfo>, 
	IIndexable<TInfo>, INameIndexable<TInfo>, IDisposable
where TInfo : BaseInfo

Type Parameters

TInfo

The InfoObjectCollection<TInfo> type exposes the following members.

Constructors

	Name	Description
Public method	InfoObjectCollection<TInfo>()	Constructor
Public method	InfoObjectCollection<TInfo>(DataSet)	Constructor. Creates a static collection populated from DataSet
Protected method	InfoObjectCollection<TInfo>(String)	Constructor

Fields

	Name	Description
Public field	ObjectInitializer	Provides a way how to initialize the object instance based on given data

Properties

	Name	Description
Public property	AllowPaging	If true, the paging of the data is allowed (data is loaded in batches).
Protected property	AutomaticNameColumn	If true, the automatic name column is used within this collection
Public property	CheckLicense	If true, the collection check license when getting data
Public property	CodeNames	Collection of the object code names
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property	Columns	Columns to get.
Public property	Count	Returns the number of items.
Protected property	DeletedItems	Returns the items collection.
Public property	DisplayNames	Collection of the object display names
Public property	DynamicWhereCondition	Dynamic where condition.
Public property	ElementType	Returns the element type.
Public property	EnforceReadOnlyDataAccess	If true, the read only access to the data is enforced within the transaction.
Public property	Expression	Query expression
Public property	FieldsAsObjects	Related objects wrappers
Public property	FirstItem	Returns the first item of the collection
Public property	GUIDs	Collection of the object GUIDs
Public property	IDs	Collection of the object IDs
Protected property	InternalCount	Internal count of the items
Public property	IsCachedObject	If true, the object is cached within the system for later use
Public property	IsDisconnected	Returns true if the collection is disconnected from the data source
Public property	IsLastVersion	If true, the document is the last version (retrieved using DocumentHelper.GetDocument).
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	ItemsAsFields	Fields wrappers
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.
Public property	Name	Collection name. Returns object type if name is not defined
Public property	NameColumn	Name column name
Protected property	NewItems	Returns the items collection.
Public property	Object	Object instance of the specified type.
Protected property	ObjectsByName	Objects by name collection.
Public property	ObjectType	Returns the object type of the objects stored within the collection.
Public property	OrderByColumns	Order by expression.
Public property	PageSize	Page size for loading of the items.
Public property	ParentObject	Parent object. Instance of object which contains this collection as it's inner field.
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>.)
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	SiteID	Site ID to filter the collection to a particular site
Public property	SortNames	If true, the names in enumeration are sorted
Public property	SourceData	Source data for the collection
Public property	TopN	Select top N objects.
Public property	TypeInfo	Type info for the collection object.
Public property	UseDefaultCacheDependencies	If true, the collection uses default cache dependencies to flush it's content
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	UseObjectTypeCondition	If true, the collection uses the type condition to get the data
Public property	Where	Where condition.

Methods

	Name	Description
Public method	Add(BaseInfo[])	Adds new object to the collection.
Public method	Add(IEnumerable<BaseInfo>)	Adds new object to the collection.
Public method	AddCacheDependencies	Adds the given list of cache dependencies to the collection
Public method	As<TType>	Makes a wrapper of the collection with specified type of the items.
Protected method	CacheDependenciesChanged	Ensures the actions when the cache dependencies have changed
Public method	ChangeParent	Changes the parent of the collection
Public method	Clear	Clears the current items in the collection.
Public method	ClearCache	Clears the collection cache
Protected method Static member	ClearCacheCallback	Clears the collection cache
Public method	Clone	Creates the clone of the collection.
Public method	CloneCollection	Creates the clone of this 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>.)
Protected method	CopyPropertiesTo	Copies the properties of this collection to the other collection
Public method	CreateChild	Creates the child collection based on the given provider
Public method	CreateNewObject	Creates new instance of the encapsulated object.
Protected method	CreateQueryProvider	Creates a LINQ query provider for this collection
Public method	Disconnect	Disconnects the collection from the database
Public method	Dispose	Disposes the object
Protected method	EnsureItems	Ensures the specified number of items in the item list.
Protected method	EnsureObjectValues	Ensures the proper values for the given object
Protected method	GetCacheDependencyKeys	Gets the list of cache dependency keys on which this collection depends
Public method	GetCompleteWhereCondition	Gets the complete where condition for the collection
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.
Public method	GetFieldsAsObjects(String)	Gets the collection of objects that are referenced by the given property
Protected method	GetFieldsAsObjects(String, String)	Gets the collection of objects that are referenced by the given property
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	GetItemsAsFields	Returns the updatable collection of fields of collection items
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
Public method	GetObjectName(Object)	Gets the unique object name from the given object.
Public method	GetObjectName(TInfo)	Gets the unique object name from the given object.
Public method	GetObjectToCheck	Gets an object for which to perform the permissions check.
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	GetSubsetOrderBy	Returns the clone of the collection with specified order by applied
Public method	GetSubsetWhere	Returns the clone of the collection with specified where condition applied
Public method	GetSubsetWhereNotEmpty	Returns the clone of the collection with specified column not being empty
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>.)
Protected method	Init	Initializes the collection to use specific object type
Public method	Load	Clears the data in the collection and loads objects from the given list.
Public method	MakeEmpty	Makes the collection empty.
Public method	Reconnect	Reconnects the collection to the database
Protected method	RegisterClearCacheCallback	Registers the callback to clear the collection cache
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().)
Public method	RegisterProperties(List<String>)	Registers supported properties
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<TInfo>)	Removes the specified object from the collection.
Public method	Remove(TInfo[])	Removes the specified object from the collection.
Protected method	RemoveClearCacheCallback	Removes the callback to clear the collection cache
Public method	SetProperty	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	SetValue	Sets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	SubmitChanges	Submits the changes in the collection to the database.
Public method	ToString	Provides a string representation of the collection (Overrides Object.ToString().)
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(InfoObjectCollection<TInfo> to DataSet)	Implicit operator for conversion from ObjectCollection class to DataSet

Extension Methods

	Name	Description
Public Extension Method	Batch<TInfo>	Returns input in batches of batchSize size. (Defined by BaseExtensions.)
Public Extension Method	GetNamedEnumerator<T>	Name enumerator over a collection (Defined by DataExtensions.)
Public Extension Method	ToJSON	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.)