Click or drag to resize
IInfoObjectCollection Interface
Interface for info object collection

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 12.0.0
public interface IInfoObjectCollection : IComparable, 
	INamedEnumerable, IEnumerable, IIndexable, INameIndexable, IVirtualTypedCollection, 
	ITypedCollection, ICMSQueryable, IMacroSecurityCheckPermissions

The IInfoObjectCollection type exposes the following members.

Public propertyAllowPaging
If true, the paging of the data is allowed (data is loaded in batches).
Public propertyCheckLicense
If true, the collection check license when getting data
Public propertyCodeNames
Collection of the object code names
Public propertyColumns
Columns to get.
Public propertyCount
Number of total items in the collection
(Inherited from ICMSQueryable.)
Public propertyDisplayNames
Collection of the object display names
Public propertyDynamicWhereCondition
Dynamic where condition.
Public propertyEnforceReadOnlyDataAccess
If true, the read only access to the data is enforced within the transaction.
Public propertyFieldsAsObjects
Related objects wrappers
Public propertyGUIDs
Collection of the object GUIDs
Public propertyIDs
Collection of the object IDs
Public propertyIsLastVersion
If true, the document is the last version (retrieved using DocumentHelper.GetDocument).
Public propertyIsOffline
Returns true if the given collection is offline (disconnected from the database)
(Inherited from ICMSQueryable.)
Public propertyItemInt32
Integer indexer, gets or sets the value on the specified index
(Inherited from IIndexable.)
Public propertyItemString
String indexer, gets or sets the value with the specified name
(Inherited from INameIndexable.)
Public propertyItemsAsFields
Fields wrappers
Public propertyItemsHaveNames
Returns true if the items in the collection have names
(Inherited from INamedEnumerable.)
Public propertyItemType
Result type
(Inherited from ITypedCollection.)
Public propertyLoadBinaryData
Gets or sets the value which indicates whether to load binary data into the collections.
Public propertyName
Collection name
Public propertyNameColumn
Name column name
Public propertyObject
Object instance of the specified type.
Public propertyObjectType
Returns the object type of the objects stored within the collection.
Public propertyOrderByColumns
Columns list of SQL order by expression (e.g.: 'UserName, UserID DESC')
Public propertyParentObject
Parent object. Instance of object which contains this collection as it's inner field.
Public propertySiteID
Site ID to filter the collection to a particular site
Public propertySortNames
Specifies whether the names should be sorted or not
(Inherited from INamedEnumerable.)
Public propertySourceData
Source data for the collection
Public propertyTopN
Select top N objects.
Public propertyTypeInfo
Type info for the collection object.
Public propertyUseDefaultCacheDependencies
If true, the collection uses default cache dependencies to flush it's content
Public propertyUseObjectTypeCondition
If true, the collection uses the type condition to get the data
Public propertyWhere
Where condition.
Public methodAdd(BaseInfo)
Adds new object to the collection.
Public methodAdd(IEnumerableBaseInfo)
Adds new object to the collection.
Public methodAsTType
Makes a wrapper of the collection with specified type of the items.
Public methodChangeParent
Changes the parent of the collection
Public methodClearCache
Clears the collection cache
Public methodCloneCollection
Creates the clone of this collection.
Public methodDisconnect
Disconnects the collection from the database
Public methodGetEmptyObject
Gets the virtual empty object representing the collection item
(Inherited from IVirtualTypedCollection.)
Public methodGetFieldsAsObjects
Gets the collection of objects that are referenced by the given property
Public methodGetItemsAsFields
Returns the updatable collection of fields of collection items
Public methodGetObjectName
Returns the name of the given object
(Inherited from INamedEnumerable.)
Public methodGetObjectToCheck
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 methodLoad
Clears the data in the collection and loads objects from the given list.
Public methodSubmitChanges
Submits the changes in the collection to the database.
Extension Methods
Public Extension MethodGetNamedEnumeratorT
Name enumerator over a collection
(Defined by DataExtensions.)
Public Extension MethodToJSON
Returns JSON representation of current instance of IEnumerable.
(Defined by DataExtensions.)
Public Extension MethodToXML
Returns XML representation of current instance of IEnumerable.
(Defined by DataExtensions.)
See Also