IInfoObjectCollection<TInfo> Interface

Interface for generic info object collection

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

Syntax

public interface IInfoObjectCollection<out TInfo> : IInfoObjectCollection, 
	IComparable, INamedEnumerable, IEnumerable, IIndexable, INameIndexable, 
	IVirtualTypedCollection, ICMSQueryable, IMacroSecurityCheckPermissions, ICMSQueryable<TInfo>, IOrderedQueryable<TInfo>, 
	IQueryable<TInfo>, IEnumerable<TInfo>, IQueryable, IOrderedQueryable, 
	INamedEnumerable<TInfo>, IIndexable<TInfo>, INameIndexable<TInfo>
where TInfo : BaseInfo

Type Parameters

TInfo

The IInfoObjectCollection<TInfo> type exposes the following members.

Properties

	Name	Description
Public property	AllowPaging	If true, the paging of the data is allowed (data is loaded in batches). (Inherited from IInfoObjectCollection.)
Public property	CheckLicense	If true, the collection check license when getting data (Inherited from IInfoObjectCollection.)
Public property	CodeNames	Collection of the object code names (Inherited from IInfoObjectCollection.)
Public property	Columns	Columns to get. (Inherited from IInfoObjectCollection.)
Public property	Count	Number of total items in the collection (Inherited from ICMSQueryable.)
Public property	DisplayNames	Collection of the object display names (Inherited from IInfoObjectCollection.)
Public property	DynamicWhereCondition	Dynamic where condition. (Inherited from IInfoObjectCollection.)
Public property	EnforceReadOnlyDataAccess	If true, the read only access to the data is enforced within the transaction. (Inherited from IInfoObjectCollection.)
Public property	FieldsAsObjects	Related objects wrappers (Inherited from IInfoObjectCollection.)
Public property	FirstItem	Returns the first item of the collection
Public property	GUIDs	Collection of the object GUIDs (Inherited from IInfoObjectCollection.)
Public property	IDs	Collection of the object IDs (Inherited from IInfoObjectCollection.)
Public property	IsLastVersion	If true, the document is the last version (retrieved using DocumentHelper.GetDocument). (Inherited from IInfoObjectCollection.)
Public property	IsOffline	Returns true if the given collection is offline (disconnected from the database) (Inherited from ICMSQueryable.)
Public property	Item[Int32]	Integer indexer, gets or sets the value on the specified index (Inherited from IIndexable.)
Public property	Item[String]	String indexer, gets or sets the value with the specified name (Inherited from INameIndexable.)
Public property	ItemsAsFields	Fields wrappers (Inherited from IInfoObjectCollection.)
Public property	ItemsHaveNames	Returns true if the items in the collection have names (Inherited from INamedEnumerable.)
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. (Inherited from IInfoObjectCollection.)
Public property	Name	Collection name (Inherited from IInfoObjectCollection.)
Public property	NameColumn	Name column name (Inherited from IInfoObjectCollection.)
Public property	Object	Object instance of the specified type. (Inherited from IInfoObjectCollection.)
Public property	ObjectType	Returns the object type of the objects stored within the collection. (Inherited from IInfoObjectCollection.)
Public property	OrderByColumns	Columns list of SQL order by expression (e.g.: 'UserName, UserID DESC') (Inherited from IInfoObjectCollection.)
Public property	ParentObject	Parent object. Instance of object which contains this collection as it's inner field. (Inherited from IInfoObjectCollection.)
Public property	SiteID	Site ID to filter the collection to a particular site (Inherited from IInfoObjectCollection.)
Public property	SortNames	Specifies whether the names should be sorted or not (Inherited from INamedEnumerable.)
Public property	SourceData	Source data for the collection (Inherited from IInfoObjectCollection.)
Public property	TopN	Select top N objects. (Inherited from IInfoObjectCollection.)
Public property	TypeInfo	Type info for the collection object. (Inherited from IInfoObjectCollection.)
Public property	UseDefaultCacheDependencies	If true, the collection uses default cache dependencies to flush it's content (Inherited from IInfoObjectCollection.)
Public property	UseObjectTypeCondition	If true, the collection uses the type condition to get the data (Inherited from IInfoObjectCollection.)
Public property	Where	Where condition. (Inherited from IInfoObjectCollection.)

Methods

	Name	Description
Public method	Add(BaseInfo[])	Adds new object to the collection. (Inherited from IInfoObjectCollection.)
Public method	Add(IEnumerable<BaseInfo>)	Adds new object to the collection. (Inherited from IInfoObjectCollection.)
Public method	As<TType>	Makes a wrapper of the collection with specified type of the items. (Inherited from IInfoObjectCollection.)
Public method	ChangeParent	Changes the parent of the collection (Inherited from IInfoObjectCollection.)
Public method	ClearCache	Clears the collection cache (Inherited from IInfoObjectCollection.)
Public method	CloneCollection	Creates the clone of this collection. (Inherited from IInfoObjectCollection.)
Public method	CreateChild	Creates the child collection based on the given provider (Inherited from ICMSQueryable<TObject>.)
Public method	Disconnect	Disconnects the collection from the database (Inherited from IInfoObjectCollection.)
Public method	GetEmptyObject	Gets the virtual empty object representing the collection item (Inherited from IVirtualTypedCollection.)
Public method	GetFieldsAsObjects	Gets the collection of objects that are referenced by the given property (Inherited from IInfoObjectCollection.)
Public method	GetItemsAsFields	Returns the updatable collection of fields of collection items (Inherited from IInfoObjectCollection.)
Public method	GetObjectName	Returns the name of the given object (Inherited from INamedEnumerable.)
Public method	GetObjectToCheck	Gets an object for which to perform the permissions check. This can be the class' instance itself or an object it encapsulates. (Inherited from IMacroSecurityCheckPermissions.)
Public method	GetSubsetWhere	Obsolete. Returns the clone of the collection with specified where condition applied
Public method	GetSubsetWhereNotEmpty	Obsolete. Returns the clone of the collection with specified column not being empty
Public method	Load	Clears the data in the collection and loads objects from the given list. (Inherited from IInfoObjectCollection.)
Public method	SubmitChanges	Submits the changes in the collection to the database. (Inherited from IInfoObjectCollection.)

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.)