Click or drag to resize
ObjectCollectionTObject Class
Object list.
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractSimpleDataContainerAbstractObjectCollection
    CMS.BaseAbstractDataContainerAbstractObjectCollection
      CMS.BaseAbstractHierarchicalObjectAbstractObjectCollection
        CMS.DataEngineAbstractObjectCollection
          CMS.DataEngineObjectCollectionTObject
            CMS.DataEngineInfoObjectCollection
            CMS.DocumentEngineTreeNodeCollection

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 8.2.23
Syntax
C#
public abstract class ObjectCollection<TObject> : AbstractObjectCollection, 
	IIndexable<TObject>, INameIndexable<TObject>, INameIndexable, IIndexable, 
	ICMSQueryable<TObject>, ICMSQueryable, IOrderedQueryable<TObject>, IQueryable<TObject>, 
	IOrderedQueryable, IQueryable, INamedEnumerable<TObject>, INamedEnumerable, IEnumerable<TObject>, 
	IEnumerable, IVirtualTypedCollection, ITypedCollection
where TObject : class

Type Parameters

TObject

The ObjectCollectionTObject type exposes the following members.

Constructors
Methods
  NameDescription
Public methodAdd(IEnumerableTObject)
Adds new object to the collection.
Public methodAdd(TObject)
Adds new object to the collection.
Public methodClear
Clears the current items in the collection.
Public methodClone
Creates the clone of the collection.
Public methodCloneCollection
Creates the clone of this collection.
(Overrides AbstractObjectCollectionCloneCollection.)
Public methodCombineWith
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 AbstractHierarchicalObjectTObject.)
Public methodCompareTo
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 methodContainsColumn
Returns true if specified column is available in current structure.
(Inherited from AbstractDataContainerParentObjectType.)
Public methodCreateChild
Creates the child collection based on the given provider
Public methodCreateNewObject
Creates new object for this collection.
Protected methodCreateQueryProvider
Creates a LINQ query provider for this collection
Public methodDisconnect
Disconnects the collection from the database
(Inherited from AbstractObjectCollection.)
Protected methodEnsureItems
Ensures the specified number of items in the item list.
Public methodGetCompleteWhereCondition
Gets the complete where condition for the collection
(Inherited from AbstractObjectCollection.)
Protected methodGetData
Gets the data for the collection.
Public methodGetEmptyObject
Gets an empty object for this collection
Public methodGetEnumerator
Gets the enumerator for the collection.
Public methodGetEnumeratorInternal
Gets the enumerator for the collection.
Protected methodGetFullData
Gets the data set of the data behind this collection
Protected methodGetItem
Gets the item on the specified index.
Public methodGetNameWhereCondition
Gets the where condition for the given object name.
Protected methodGetObjectByNameInternal
Gets the object by its name, internal representation that gets data from database
Protected methodGetObjectEnumerator
Gets the object enumerator for the collection
Public methodGetObjectName(Object)
Returns the name of the given object
Public methodGetObjectName(TObject)
Registers new object in this collection.
Public methodGetProperty
Gets the context property.
(Inherited from AbstractHierarchicalObjectTObject.)
Protected methodGetPropertyType
Gets the type of the given property
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodGetValue
Gets the object value.
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodHasSetter
Returns true if given property has a setter
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodMakeEmpty
Makes the collection empty.
(Inherited from AbstractObjectCollection.)
Public methodReconnect
Reconnects the collection to the database
(Inherited from AbstractObjectCollection.)
Protected methodRegisterColumn(String, FuncTObject, Object)
Registers the given Column to the object
(Inherited from AbstractSimpleDataContainerTObject.)
Protected methodRegisterColumn(String, FuncTObject, Object, FuncTObject, Object, Object)
Registers the given Column to the object
(Inherited from AbstractSimpleDataContainerTObject.)
Protected methodRegisterColumns
Registers the Columns of this object
(Overrides AbstractSimpleDataContainerTObjectRegisterColumns.)
Protected methodRegisterProperties
Registers the properties of this object
(Overrides AbstractHierarchicalObjectTObjectRegisterProperties.)
Protected methodRegisterProperty(String, FuncTObject, Object)
Registers the given property to the object
(Inherited from AbstractHierarchicalObjectTObject.)
Protected methodRegisterProperty(String, Object, FuncTObject, Object, Object)
Registers the given parameterized property to the object.
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodRemove(IEnumerableTObject)
Removes the specified object from the collection.
Public methodRemove(TObject)
Removes the specified object from the collection.
Public methodSetProperty
Gets the context property.
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodSetValue
Sets the object value.
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodTryGetProperty(String, Object)
Gets the context property.
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodTryGetProperty(String, Object, Boolean)
Returns value of property.
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodTryGetValue
Returns value of column.
(Inherited from AbstractSimpleDataContainerTObject.)
Protected methodUseData
Initializes the collection with the given source data
Protected methodValidateItem
Validates whether the item can be member of the collection (collection can work with it). Returns true if item is valid.
Top
Operators
Extension Methods
  NameDescription
Public Extension MethodAsValue
Converts object to a query value which can be used as a query parameter
(Defined by QueryExtensions.)
Public Extension MethodBatchTObject
Returns input in batches of batchSize size.
(Defined by BaseExtensions.)
Public Extension MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodGetNamedEnumeratorT
Name enumerator over a collection
(Defined by DataExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
Public Extension MethodToBoolean
Returns the boolean representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDateTime
Returns the DateTime representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToDouble
Returns the double representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToGuid
Returns the Guid representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToHashSetTObject
Converts the list of objects to a hash set of distinct values
(Defined by DataExtensions.)
Public Extension MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToJSON
Returns JSON representation of current instance of IEnumerable.
(Defined by DataExtensions.)
Public Extension MethodToListTObject, TTo
Converts the given collection to a list of values
(Defined by BaseExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToXML
Returns XML representation of current instance of IEnumerable.
(Defined by DataExtensions.)
Top
Fields
  NameDescription
Protected fieldmAllowPaging
If true, the paging of the data is allowed (data is loaded in batches).
Protected fieldmColumnNames
Column names
Protected fieldmCount
Total number of items.
(Inherited from AbstractObjectCollection.)
Protected fieldmCountDifference
Difference in count of the items from data source and current number of items
Protected fieldmDeletedItems
Deleted items removed from the collection.
Protected fieldmDisconnectedCount
Number of disconnected references for this collection
(Inherited from AbstractObjectCollection.)
Protected fieldmInstanceGuid
Instance GUID
(Inherited from AbstractObjectCollection.)
Protected fieldmItems
Items collection.
Protected fieldmLoadBinaryData
Indicates whether to load binary data into the collections.
(Inherited from AbstractObjectCollection.)
Protected fieldmName
Collection name
(Inherited from AbstractObjectCollection.)
Protected fieldmNewItems
New items added to the collection.
Protected fieldmObjectsByName
Objects by name.
Protected fieldmPageSize
Page size for loading of the items.
Protected fieldmSourceData
Source data for the collection
Top
Properties
  NameDescription
Public propertyAllowPaging
If true, the paging of the data is allowed (data is loaded in batches).
Public propertyColumnNames
Available column names.
(Inherited from AbstractDataContainerParentObjectType.)
Public propertyColumns
Columns to get.
(Inherited from AbstractObjectCollection.)
Public propertyCount
Returns the number of items.
Public propertyDynamicWhereCondition
Dynamic where condition.
(Inherited from AbstractObjectCollection.)
Public propertyElementType
Returns the element type.
Public propertyEnforceReadOnlyDataAccess
If true, the read only access to the data is enforced within the transaction.
(Inherited from AbstractObjectCollection.)
Public propertyExpression
Query expression
Public propertyFirstItem
Returns the first item of the collection
Protected propertyInternalCount
Internal count of the items
Public propertyIsCachedObject
If true, the object is cached within the system for later use
(Inherited from AbstractObjectCollection.)
Public propertyIsDisconnected
Returns true if this collection is disconnected from the database
(Inherited from AbstractObjectCollection.)
Public propertyIsLastVersion
If true, the document is the last version (retrieved using DocumentHelper.GetDocument).
(Inherited from AbstractObjectCollection.)
Public propertyIsOffline
Returns true, if the collection is offline (not backed up by the database but by the source data)
Public propertyItemInt32
Gets or sets the object on specific index.
Public propertyItemString
Returns the object registered by the specific name.
Protected propertyItems
Returns the items collection.
Public propertyItemsHaveNames
Returns true if the items in the collection have names
Public propertyItemType
Result type
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.
(Overrides AbstractObjectCollectionLoadBinaryData.)
Public propertyName
Collection name
(Inherited from AbstractObjectCollection.)
Public propertyNameColumn
Name column name
Protected propertyObjectsByName
Objects by name collection.
Public propertyOrderBy
Order by expression.
(Inherited from AbstractObjectCollection.)
Public propertyParentStorage
Parent storage
(Inherited from AbstractObjectCollection.)
Public propertyProperties
Properties available through the context.
(Inherited from AbstractHierarchicalObjectTObject.)
Protected propertyPropertyList
Used property list
(Inherited from AbstractHierarchicalObjectTObject.)
Public propertyProvider
Query provider
Protected propertyRegisteredColumns
Registered Columns
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyRegisteredColumnsObject
Registered Columns object
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyRegisteredProperties
Registered properties
(Inherited from AbstractHierarchicalObjectTObject.)
Protected propertyRegisteredPropertiesObject
Registered properties object
(Inherited from AbstractHierarchicalObjectTObject.)
Protected propertyRemovedObject
Defines the removed object within collection
Public propertySortNames
If true, the names in enumeration are sorted
Public propertyTopN
Select top N objects.
(Inherited from AbstractObjectCollection.)
Protected propertyUseLocalColumns
If true, the object uses local columns
(Inherited from AbstractSimpleDataContainerTObject.)
Protected propertyUseLocalProperties
If true, the object uses local properties
(Inherited from AbstractHierarchicalObjectTObject.)
Public propertyWhereCondition
Where condition.
(Inherited from AbstractObjectCollection.)
Top
See Also