Click or drag to resize
IInfoObjectCollectionTInfo Interface
Interface for generic info object collection

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 13.0.131
Syntax
C#
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 IInfoObjectCollectionTInfo type exposes the following members.

Properties
  NameDescription
Public propertyAllowPaging
If true, the paging of the data is allowed (data is loaded in batches).
(Inherited from IInfoObjectCollection.)
Public propertyCheckLicense
If true, the collection check license when getting data
(Inherited from IInfoObjectCollection.)
Public propertyCodeNames
Collection of the object code names
(Inherited from IInfoObjectCollection.)
Public propertyColumns
Columns to get.
(Inherited from IInfoObjectCollection.)
Public propertyCount
Number of total items in the collection
(Inherited from ICMSQueryable.)
Public propertyDisplayNames
Collection of the object display names
(Inherited from IInfoObjectCollection.)
Public propertyDynamicWhereCondition
Dynamic where condition.
(Inherited from IInfoObjectCollection.)
Public propertyEnforceReadOnlyDataAccess
If true, the read only access to the data is enforced within the transaction.
(Inherited from IInfoObjectCollection.)
Public propertyFieldsAsObjects
Related objects wrappers
(Inherited from IInfoObjectCollection.)
Public propertyFirstItem
Returns the first item of the collection
Public propertyGUIDs
Collection of the object GUIDs
(Inherited from IInfoObjectCollection.)
Public propertyIDs
Collection of the object IDs
(Inherited from IInfoObjectCollection.)
Public propertyIsLastVersion
If true, the document is the last version (retrieved using DocumentHelper.GetDocument).
(Inherited from IInfoObjectCollection.)
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
(Inherited from IInfoObjectCollection.)
Public propertyItemsHaveNames
Returns true if the items in the collection have names
(Inherited from INamedEnumerable.)
Public propertyLastItem
Returns the last item of the collection
Public propertyLoadBinaryData
Gets or sets the value which indicates whether to load binary data into the collections.
(Inherited from IInfoObjectCollection.)
Public propertyName
Collection name
(Inherited from IInfoObjectCollection.)
Public propertyNameColumn
Name column name
(Inherited from IInfoObjectCollection.)
Public propertyObject
Object instance of the specified type.
(Inherited from IInfoObjectCollection.)
Public propertyObjectType
Returns the object type of the objects stored within the collection.
(Inherited from IInfoObjectCollection.)
Public propertyOrderByColumns
Columns list of SQL order by expression (e.g.: 'UserName, UserID DESC')
(Inherited from IInfoObjectCollection.)
Public propertyParentObject
Parent object. Instance of object which contains this collection as it's inner field.
(Inherited from IInfoObjectCollection.)
Public propertySiteID
Site ID to filter the collection to a particular site
(Inherited from IInfoObjectCollection.)
Public propertySortNames
Specifies whether the names should be sorted or not
(Inherited from INamedEnumerable.)
Public propertySourceData
Source data for the collection
(Inherited from IInfoObjectCollection.)
Public propertyTopN
Select top N objects.
(Inherited from IInfoObjectCollection.)
Public propertyTypeInfo
Type info for the collection object.
(Inherited from IInfoObjectCollection.)
Public propertyUseDefaultCacheDependencies
If true, the collection uses default cache dependencies to flush it's content
(Inherited from IInfoObjectCollection.)
Public propertyUseObjectTypeCondition
If true, the collection uses the type condition to get the data
(Inherited from IInfoObjectCollection.)
Public propertyWhere
Where condition.
(Inherited from IInfoObjectCollection.)
Top
Methods
  NameDescription
Public methodAdd(BaseInfo)
Adds new object to the collection.
(Inherited from IInfoObjectCollection.)
Public methodAdd(IEnumerableBaseInfo)
Adds new object to the collection.
(Inherited from IInfoObjectCollection.)
Public methodAsTType
Makes a wrapper of the collection with specified type of the items.
(Inherited from IInfoObjectCollection.)
Public methodChangeParent
Changes the parent of the collection
(Inherited from IInfoObjectCollection.)
Public methodClearCache
Clears the collection cache
(Inherited from IInfoObjectCollection.)
Public methodCloneCollection
Creates the clone of this collection.
(Inherited from IInfoObjectCollection.)
Public methodCreateChild
Creates the child collection based on the given provider
(Inherited from ICMSQueryableTObject.)
Public methodDisconnect
Disconnects the collection from the database
(Inherited from IInfoObjectCollection.)
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
(Inherited from IInfoObjectCollection.)
Public methodGetItemsAsFields
Returns the updatable collection of fields of collection items
(Inherited from IInfoObjectCollection.)
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 methodGetSubsetWhere Obsolete.
Returns the clone of the collection with specified where condition applied
Public methodGetSubsetWhereNotEmpty Obsolete.
Returns the clone of the collection with specified column not being empty
Public methodLoad
Clears the data in the collection and loads objects from the given list.
(Inherited from IInfoObjectCollection.)
Public methodSubmitChanges
Submits the changes in the collection to the database.
(Inherited from IInfoObjectCollection.)
Top
Extension Methods
  NameDescription
Public Extension MethodBatchTInfo
Returns input in batches of batchSize size.
(Defined by BaseExtensions.)
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.)
Top
See Also