InfoObjectCollection<TInfo> Class

Generic strongly typed info object collection

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractSimpleDataContainer<AbstractObjectCollection>
    CMS.Base.AbstractDataContainer<AbstractObjectCollection>
      CMS.Base.AbstractHierarchicalObject<AbstractObjectCollection>
        CMS.DataEngine.AbstractObjectCollection
          CMS.DataEngine.ObjectCollection<BaseInfo>
            CMS.DataEngine.InfoObjectCollection
              CMS.DataEngine.InfoObjectCollection<TInfo>
                CMS.DataEngine.InfoObjectCollection.EmptyCollection<InfoType>
                CMS.DocumentEngine.AttachmentHistoryInfoCollection
                CMS.DocumentEngine.AttachmentInfoCollection
                CMS.Ecommerce.OrdersCollection

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

Syntax

public class InfoObjectCollection<TInfo> : InfoObjectCollection, 
	ICMSQueryable<TInfo>, ICMSQueryable, IOrderedQueryable<TInfo>, IQueryable<TInfo>, 
	IEnumerable<TInfo>, IOrderedQueryable, IQueryable, IEnumerable
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

Methods

	Name	Description
Public method	Add(IEnumerable<TObject>)	Adds new object to the collection. (Inherited from ObjectCollection<TObject>.)
Public method	Add(BaseInfo[])	Adds new object to the collection. (Inherited from InfoObjectCollection.)
Public method	AddCacheDependencies	Adds the given list of cache dependencies to the collection (Inherited from InfoObjectCollection.)
Public method	As<TargetType>	Makes a wrapper of the collection with specified type of the items. (Inherited from InfoObjectCollection.)
Protected method	CacheDependenciesChanged	Ensures the actions when the cache dependencies have changed (Inherited from InfoObjectCollection.)
Public method	Clear	Clears the current items in the collection. (Inherited from ObjectCollection<TObject>.)
Protected method	ClearCache	Clears the collection cache (Inherited from InfoObjectCollection.)
Public method	Clone	Creates the clone of the collection. (Overrides InfoObjectCollection.Clone().)
Public method	CloneCollection	Creates the clone of this collection. (Inherited from ObjectCollection<TObject>.)
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>.)
Protected method	CopyPropertiesTo	Copies the properties of this collection to the other collection (Inherited from InfoObjectCollection.)
Public method	CreateChild	Creates the child collection based on the given provider
Public method	CreateNewObject	Creates new instance of the encapsulated object. (Inherited from InfoObjectCollection.)
Protected method	CreateQueryProvider	Creates a LINQ query provider for this collection (Overrides ObjectCollection<TObject>.CreateQueryProvider().)
Public method	Disconnect	Disconnects the collection from the database (Inherited from AbstractObjectCollection.)
Public method	Dispose	Disposes the object (Inherited from InfoObjectCollection.)
Protected method	EnsureItems	Ensures the specified number of items in the item list. (Inherited from ObjectCollection<TObject>.)
Protected method	EnsureObjectValues	Ensures the proper values for the given object (Inherited from InfoObjectCollection.)
Protected method	GetCacheDependencyKeys	Gets the list of cache dependency keys on which this collection depends (Inherited from InfoObjectCollection.)
Public method	GetCompleteWhereCondition	Gets the complete where condition for the collection (Inherited from InfoObjectCollection.)
Protected method	GetData	Gets the data for the collection. (Inherited from InfoObjectCollection.)
Public method	GetEmptyObject	Gets an empty object for this collection (Inherited from ObjectCollection<TObject>.)
Public method	GetEnumerator	Gets the strongly typed enumerator for the collection
Public method	GetEnumeratorInternal	Gets the enumerator for the collection. (Inherited from ObjectCollection<TObject>.)
Public method	GetFieldsAsObjects(String)	Gets the collection of objects that are referenced by the given property (Inherited from InfoObjectCollection.)
Protected method	GetFieldsAsObjects(String, String)	Gets the collection of objects that are referenced by the given property (Inherited from InfoObjectCollection.)
Protected method	GetFullData	Gets the data set of the data behind this collection (Inherited from ObjectCollection<TObject>.)
Protected method	GetItem	Gets the item on the specified index. (Inherited from InfoObjectCollection.)
Public method	GetItemsAsFields	Returns the updatable collection of fields of collection items (Inherited from InfoObjectCollection.)
Public method	GetNameWhereCondition	Gets the where condition for the given object name. (Inherited from InfoObjectCollection.)
Protected method	GetObjectByNameInternal	Gets the object by its name, internal representation that gets data from database (Inherited from InfoObjectCollection.)
Protected method	GetObjectEnumerator	Gets the object enumerator for the collection (Inherited from ObjectCollection<TObject>.)
Public method	GetObjectName(Object)	Returns the name of the given object (Inherited from ObjectCollection<TObject>.)
Public method	GetObjectName(BaseInfo)	Gets the unique object name from the given object. (Inherited from InfoObjectCollection.)
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 (Inherited from InfoObjectCollection.)
Public method	GetSubsetWhere	Returns the clone of the collection with specified where condition applied (Inherited from InfoObjectCollection.)
Public method	GetSubsetWhereNotEmpty	Returns the clone of the collection with specified column not being empty (Inherited from InfoObjectCollection.)
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	ChangeParent	Changes the parent of the collection (Inherited from InfoObjectCollection.)
Protected method	Init	Initializes the collection to use specific object type (Inherited from InfoObjectCollection.)
Public method	Load	Clears the data in the collection and loads objects from the given list. (Inherited from InfoObjectCollection.)
Public method	MakeEmpty	Makes the collection empty. (Inherited from AbstractObjectCollection.)
Public method	Reconnect	Reconnects the collection to the database (Inherited from AbstractObjectCollection.)
Protected method	RegisterClearCacheCallback	Registers the callback to clear the collection cache (Inherited from InfoObjectCollection.)
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 InfoObjectCollection.)
Protected method	RegisterProperties()	Registers the properties of this object (Overrides InfoObjectCollection.RegisterProperties().)
Public method	RegisterProperties(List<String>)	Registers supported properties (Inherited from InfoObjectCollection.)
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. (Inherited from ObjectCollection<TObject>.)
Public method	Remove(TObject[])	Removes the specified object from the collection. (Inherited from ObjectCollection<TObject>.)
Protected method	RemoveClearCacheCallback	Removes the callback to clear the collection cache (Inherited from InfoObjectCollection.)
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. (Inherited from InfoObjectCollection.)
Public method	ToString	Provides a string representation of the collection (Inherited from InfoObjectCollection.)
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 (Inherited from ObjectCollection<TObject>.)
Protected method	ValidateItem	Validates whether the item can be member of the collection (collection can work with it). Returns true if item is valid. (Inherited from InfoObjectCollection.)

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<TInfo>	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	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<TInfo>	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<TInfo, 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). (Inherited from ObjectCollection<TObject>.)
Protected field	mColumnNames	Column names (Inherited from ObjectCollection<TObject>.)
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 (Inherited from ObjectCollection<TObject>.)
Protected field	mDeletedItems	Deleted items removed from the collection. (Inherited from ObjectCollection<TObject>.)
Protected field	mDisconnectedCount	Number of disconnected references for this collection (Inherited from AbstractObjectCollection.)
Protected field	mFieldsAsObjects	Related objects wrappers (Inherited from InfoObjectCollection.)
Protected field	mInstanceGuid	Instance GUID (Inherited from AbstractObjectCollection.)
Protected field	mItems	Items collection. (Inherited from ObjectCollection<TObject>.)
Protected field	mItemsAsFields	Fields wrappers (Inherited from InfoObjectCollection.)
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. (Inherited from ObjectCollection<TObject>.)
Protected field	mObject	Object instance of specified type. (Inherited from InfoObjectCollection.)
Protected field	mObjectsByName	Objects by name. (Inherited from ObjectCollection<TObject>.)
Protected field	mObjectType	Object type. (Inherited from InfoObjectCollection.)
Protected field	mOrderBy	Order by expression. (Inherited from InfoObjectCollection.)
Protected field	mPageSize	Page size for loading of the items. (Inherited from ObjectCollection<TObject>.)
Protected field	mParentObject	Parent object instance (Inherited from InfoObjectCollection.)
Protected field	mSourceData	Source data for the collection (Inherited from ObjectCollection<TObject>.)
Public field	ObjectInitializer	Provides a way how to initialize the object instance based on given data (Inherited from InfoObjectCollection.)

Properties

	Name	Description
Public property	AllowPaging	If true, the paging of the data is allowed (data is loaded in batches). (Inherited from ObjectCollection<TObject>.)
Public property	CodeNames	Collection of the object code names (Inherited from InfoObjectCollection.)
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. (Inherited from ObjectCollection<TObject>.)
Public property	DisplayNames	Collection of the object display names (Inherited from InfoObjectCollection.)
Public property	DynamicWhereCondition	Dynamic where condition. (Inherited from AbstractObjectCollection.)
Public property	ElementType	Returns the element type. (Inherited from ObjectCollection<TObject>.)
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 (Inherited from ObjectCollection<TObject>.)
Public property	FieldsAsObjects	Related objects wrappers (Inherited from InfoObjectCollection.)
Public property	FirstItem	Returns the first item of the collection (Inherited from ObjectCollection<TObject>.)
Public property	GUIDs	Collection of the object GUIDs (Inherited from InfoObjectCollection.)
Public property	CheckLicense	If true, the collection check license when getting data (Inherited from InfoObjectCollection.)
Public property	IDs	Collection of the object IDs (Inherited from InfoObjectCollection.)
Protected property	InternalCount	Internal count of the items (Inherited from InfoObjectCollection.)
Public property	IsCachedObject	If true, the object is cached within the system for later use (Inherited from InfoObjectCollection.)
Public property	IsDisconnected	Returns true if the collection is disconnected from the data source (Inherited from InfoObjectCollection.)
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) (Inherited from ObjectCollection<TObject>.)
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. (Inherited from ObjectCollection<TObject>.)
Public property	ItemsAsFields	Fields wrappers (Inherited from InfoObjectCollection.)
Public property	ItemsHaveNames	Returns true if the items in the collection have names (Inherited from ObjectCollection<TObject>.)
Public property	ItemType	Result type (Inherited from ObjectCollection<TObject>.)
Public property	LastItem	Returns the last item of the collection (Inherited from ObjectCollection<TObject>.)
Public property	LoadBinaryData	Gets or sets the value which indicates whether to load binary data into the collections. (Inherited from ObjectCollection<TObject>.)
Public property	Name	Collection name. Returns object type if name is not defined (Inherited from InfoObjectCollection.)
Public property	NameColumn	Name column name (Inherited from InfoObjectCollection.)
Public property	Object	Object instance of the specified type. (Inherited from InfoObjectCollection.)
Protected property	ObjectsByName	Objects by name collection. (Inherited from ObjectCollection<TObject>.)
Public property	ObjectType	Returns the object type of the objects stored within the collection. (Inherited from InfoObjectCollection.)
Public property	OrderBy	Order by expression. (Inherited from InfoObjectCollection.)
Public property	ParentObject	Parent object. (Inherited from InfoObjectCollection.)
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 (Inherited from ObjectCollection<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>.)
Protected property	RemovedObject	Defines the removed object within collection (Inherited from ObjectCollection<TObject>.)
Public property	SearchText	If set, the collection filters objects to only those containing the given text (Inherited from InfoObjectCollection.)
Public property	SiteID	Site ID to filter the collection to a particular site (Inherited from InfoObjectCollection.)
Public property	SortNames	If true, the names in enumeration are sorted (Inherited from ObjectCollection<TObject>.)
Public property	TopN	Select top N objects. (Inherited from AbstractObjectCollection.)
Public property	TypeInfo	Type info for the collection object. (Inherited from InfoObjectCollection.)
Public property	UseDefaultCacheDependencies	If true, the collection uses default cache dependencies to flush it's content (Inherited from InfoObjectCollection.)
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 (Inherited from InfoObjectCollection.)
Public property	WhereCondition	Where condition. (Inherited from AbstractObjectCollection.)