IInfoObjectCollection Interface

Interface for info object collection

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

Syntax

public interface IInfoObjectCollection : IComparable, 
	INamedEnumerable, IEnumerable, IIndexable, INameIndexable, IVirtualTypedCollection, 
	ITypedCollection, ICMSQueryable, IMacroSecurityCheckPermissions

The IInfoObjectCollection 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).
Public property	CheckLicense	If true, the collection check license when getting data
Public property	CodeNames	Collection of the object code names
Public property	Columns	Columns to get.
Public property	Count	Number of total items in the collection (Inherited from ICMSQueryable.)
Public property	DisplayNames	Collection of the object display names
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	FieldsAsObjects	Related objects wrappers
Public property	GUIDs	Collection of the object GUIDs
Public property	IDs	Collection of the object IDs
Public property	IsLastVersion	If true, the document is the last version (retrieved using DocumentHelper.GetDocument).
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
Public property	ItemsHaveNames	Returns true if the items in the collection have names (Inherited from INamedEnumerable.)
Public property	ItemType	Result type (Inherited from ITypedCollection.)
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	NameColumn	Name column name
Public property	Object	Object instance of the specified type.
Public property	ObjectType	Returns the object type of the objects stored within the collection.
Public property	OrderByColumns	Columns list of SQL order by expression (e.g.: 'UserName, UserID DESC')
Public property	ParentObject	Parent object. Instance of object which contains this collection as it's inner field.
Public property	SiteID	Site ID to filter the collection to a particular site
Public property	SortNames	Specifies whether the names should be sorted or not (Inherited from INamedEnumerable.)
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
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	As<TType>	Makes a wrapper of the collection with specified type of the items.
Public method	ChangeParent	Changes the parent of the collection
Public method	ClearCache	Clears the collection cache
Public method	CloneCollection	Creates the clone of this collection.
Public method	Disconnect	Disconnects the collection from the database
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
Public method	GetItemsAsFields	Returns the updatable collection of fields of collection items
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	Load	Clears the data in the collection and loads objects from the given list.
Public method	SubmitChanges	Submits the changes in the collection to the database.

Extension Methods

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