Click or drag to resize
InfoObjectCollection Class
Collection of GeneralizedInfos.
Inheritance Hierarchy
SystemObject
  CMS.BaseAbstractSimpleDataContainerAbstractObjectCollection
    CMS.BaseAbstractDataContainerAbstractObjectCollection
      CMS.BaseAbstractHierarchicalObjectAbstractObjectCollection
        CMS.DataEngineAbstractObjectCollection
          CMS.DataEngineObjectCollectionBaseInfo
            CMS.DataEngineInfoObjectCollection
              CMS.DataEngineBindingCollection
              CMS.DataEngineFilteredInfoObjectCollection
              CMS.DataEngineFullNameInfoObjectCollection
              CMS.DataEngineInfoObjectCollectionTInfo

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 8.2.23
Syntax
C#
public class InfoObjectCollection : ObjectCollection<BaseInfo>, 
	IObjectTypeDriven, IDisposable

The InfoObjectCollection type exposes the following members.

Constructors
  NameDescription
Public methodInfoObjectCollection
Constructor
Top
Methods
  NameDescription
Public methodAdd(IEnumerableTObject)
Adds new object to the collection.
(Inherited from ObjectCollectionTObject.)
Public methodAdd(BaseInfo)
Adds new object to the collection.
(Overrides ObjectCollectionTObjectAdd(TObject).)
Public methodAddCacheDependencies
Adds the given list of cache dependencies to the collection
Public methodAsTargetType
Makes a wrapper of the collection with specified type of the items.
Protected methodCacheDependenciesChanged
Ensures the actions when the cache dependencies have changed
Public methodClear
Clears the current items in the collection.
(Inherited from ObjectCollectionTObject.)
Protected methodClearCache
Clears the collection cache
Protected methodStatic memberClearCacheCallback
Clears the collection cache
Public methodClone
Creates the clone of the collection.
(Overrides ObjectCollectionTObjectClone.)
Public methodCloneCollection
Creates the clone of this collection.
(Inherited from ObjectCollectionTObject.)
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.)
Protected methodCopyPropertiesTo
Copies the properties of this collection to the other collection
Public methodCreateChild
Creates the child collection based on the given provider
(Inherited from ObjectCollectionTObject.)
Public methodCreateNewObject
Creates new instance of the encapsulated object.
(Overrides ObjectCollectionTObjectCreateNewObject(DataRow).)
Protected methodCreateQueryProvider
Creates a LINQ query provider for this collection
(Inherited from ObjectCollectionTObject.)
Public methodDisconnect
Disconnects the collection from the database
(Inherited from AbstractObjectCollection.)
Public methodDispose
Disposes the object
Protected methodEnsureItems
Ensures the specified number of items in the item list.
(Inherited from ObjectCollectionTObject.)
Protected methodEnsureObjectValues
Ensures the proper values for the given object
Protected methodGetCacheDependencyKeys
Gets the list of cache dependency keys on which this collection depends
Public methodGetCompleteWhereCondition
Gets the complete where condition for the collection
(Overrides AbstractObjectCollectionGetCompleteWhereCondition.)
Protected methodGetData
Gets the data for the collection.
(Overrides ObjectCollectionTObjectGetData(String, Int32, Int32, Int32).)
Public methodGetEmptyObject
Gets an empty object for this collection
(Inherited from ObjectCollectionTObject.)
Public methodGetEnumerator
Gets the enumerator for the collection.
(Inherited from ObjectCollectionTObject.)
Public methodGetEnumeratorInternal
Gets the enumerator for the collection.
(Inherited from ObjectCollectionTObject.)
Public methodGetFieldsAsObjects(String)
Gets the collection of objects that are referenced by the given property
Protected methodGetFieldsAsObjects(String, String)
Gets the collection of objects that are referenced by the given property
Protected methodGetFullData
Gets the data set of the data behind this collection
(Inherited from ObjectCollectionTObject.)
Protected methodGetItem
Gets the item on the specified index.
(Overrides ObjectCollectionTObjectGetItem(Int32).)
Public methodGetItemsAsFields
Returns the updatable collection of fields of collection items
Public methodGetNameWhereCondition
Gets the where condition for the given object name.
(Overrides ObjectCollectionTObjectGetNameWhereCondition(String).)
Protected methodGetObjectByNameInternal
Gets the object by its name, internal representation that gets data from database
(Overrides ObjectCollectionTObjectGetObjectByNameInternal(String).)
Protected methodGetObjectEnumerator
Gets the object enumerator for the collection
(Inherited from ObjectCollectionTObject.)
Public methodGetObjectName(Object)
Returns the name of the given object
(Inherited from ObjectCollectionTObject.)
Public methodGetObjectName(BaseInfo)
Gets the unique object name from the given object.
(Overrides ObjectCollectionTObjectGetObjectName(TObject).)
Public methodGetProperty
Gets the context property.
(Inherited from AbstractHierarchicalObjectTObject.)
Protected methodGetPropertyType
Gets the type of the given property
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodGetSubsetOrderBy
Returns the clone of the collection with specified order by applied
Public methodGetSubsetWhere
Returns the clone of the collection with specified where condition applied
Public methodGetSubsetWhereNotEmpty
Returns the clone of the collection with specified column not being empty
Public methodGetValue
Gets the object value.
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodHasSetter
Returns true if given property has a setter
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodChangeParent
Changes the parent of the collection
Protected methodInit
Initializes the collection to use specific object type
Public methodLoad
Clears the data in the collection and loads objects from the given list.
Public methodMakeEmpty
Makes the collection empty.
(Inherited from AbstractObjectCollection.)
Public methodStatic memberNew
Constructor
Public methodReconnect
Reconnects the collection to the database
(Inherited from AbstractObjectCollection.)
Protected methodRegisterClearCacheCallback
Registers the callback to clear the collection cache
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 ObjectCollectionTObjectRegisterColumns.)
Protected methodRegisterProperties
Registers the properties of this object
(Overrides ObjectCollectionTObjectRegisterProperties.)
Public methodRegisterProperties(ListString)
Registers supported properties
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.
(Inherited from ObjectCollectionTObject.)
Public methodRemove(TObject)
Removes the specified object from the collection.
(Inherited from ObjectCollectionTObject.)
Protected methodRemoveClearCacheCallback
Removes the callback to clear the collection cache
Public methodSetProperty
Gets the context property.
(Inherited from AbstractHierarchicalObjectTObject.)
Public methodSetValue
Sets the object value.
(Inherited from AbstractSimpleDataContainerTObject.)
Public methodSubmitChanges
Submits the changes in the collection to the database.
Public methodToString
Provides a string representation of the collection
(Overrides ObjectToString.)
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
(Inherited from ObjectCollectionTObject.)
Protected methodValidateItem
Validates whether the item can be member of the collection (collection can work with it). Returns true if item is valid.
(Overrides ObjectCollectionTObjectValidateItem(TObject, Boolean).)
Top
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 MethodGetAPIString
Gets the string by the specified resource key
(Defined by CoreExtensions.)
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 MethodToInteger
Returns the integer representation of an object or default value if not.
(Defined by CoreExtensions.)
Public Extension MethodToString
Returns the string representation of an object or default value if not.
(Defined by CoreExtensions.)
Top
Fields
  NameDescription
Protected fieldmAllowPaging
If true, the paging of the data is allowed (data is loaded in batches).
(Inherited from ObjectCollectionTObject.)
Protected fieldStatic membermAutomaticNameColumn
If true, the automatic name column is used within this collection
Protected fieldmColumnNames
Column names
(Inherited from ObjectCollectionTObject.)
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
(Inherited from ObjectCollectionTObject.)
Protected fieldmDeletedItems
Deleted items removed from the collection.
(Inherited from ObjectCollectionTObject.)
Protected fieldmDisconnectedCount
Number of disconnected references for this collection
(Inherited from AbstractObjectCollection.)
Protected fieldmFieldsAsObjects
Related objects wrappers
Protected fieldmInstanceGuid
Instance GUID
(Inherited from AbstractObjectCollection.)
Protected fieldmItems
Items collection.
(Inherited from ObjectCollectionTObject.)
Protected fieldmItemsAsFields
Fields wrappers
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.
(Inherited from ObjectCollectionTObject.)
Protected fieldmObject
Object instance of specified type.
Protected fieldmObjectsByName
Objects by name.
(Inherited from ObjectCollectionTObject.)
Protected fieldmObjectType
Object type.
Protected fieldmOrderBy
Order by expression.
Protected fieldmPageSize
Page size for loading of the items.
(Inherited from ObjectCollectionTObject.)
Protected fieldmParentObject
Parent object instance
Protected fieldmSourceData
Source data for the collection
(Inherited from ObjectCollectionTObject.)
Public fieldObjectInitializer
Provides a way how to initialize the object instance based on given data
Top
Properties
  NameDescription
Public propertyAllowPaging
If true, the paging of the data is allowed (data is loaded in batches).
(Inherited from ObjectCollectionTObject.)
Public propertyCodeNames
Collection of the object code names
Public propertyColumnNames
Available column names.
(Inherited from AbstractDataContainerParentObjectType.)
Public propertyColumns
Columns to get.
(Inherited from AbstractObjectCollection.)
Public propertyCount
Returns the number of items.
(Inherited from ObjectCollectionTObject.)
Public propertyDisplayNames
Collection of the object display names
Public propertyDynamicWhereCondition
Dynamic where condition.
(Inherited from AbstractObjectCollection.)
Public propertyElementType
Returns the element type.
(Inherited from ObjectCollectionTObject.)
Public propertyEnforceReadOnlyDataAccess
If true, the read only access to the data is enforced within the transaction.
(Inherited from AbstractObjectCollection.)
Public propertyExpression
Query expression
(Inherited from ObjectCollectionTObject.)
Public propertyFieldsAsObjects
Related objects wrappers
Public propertyFirstItem
Returns the first item of the collection
(Inherited from ObjectCollectionTObject.)
Public propertyGUIDs
Collection of the object GUIDs
Public propertyCheckLicense
If true, the collection check license when getting data
Public propertyIDs
Collection of the object IDs
Protected propertyInternalCount
Internal count of the items
(Overrides ObjectCollectionTObjectInternalCount.)
Public propertyIsCachedObject
If true, the object is cached within the system for later use
(Overrides AbstractObjectCollectionIsCachedObject.)
Public propertyIsDisconnected
Returns true if the collection is disconnected from the data source
(Overrides AbstractObjectCollectionIsDisconnected.)
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)
(Inherited from ObjectCollectionTObject.)
Public propertyItemInt32
Gets or sets the object on specific index.
(Inherited from ObjectCollectionTObject.)
Public propertyItemString
Returns the object registered by the specific name.
(Inherited from ObjectCollectionTObject.)
Protected propertyItems
Returns the items collection.
(Inherited from ObjectCollectionTObject.)
Public propertyItemsAsFields
Fields wrappers
Public propertyItemsHaveNames
Returns true if the items in the collection have names
(Inherited from ObjectCollectionTObject.)
Public propertyItemType
Result type
(Inherited from ObjectCollectionTObject.)
Public propertyLastItem
Returns the last item of the collection
(Inherited from ObjectCollectionTObject.)
Public propertyLoadBinaryData
Gets or sets the value which indicates whether to load binary data into the collections.
(Inherited from ObjectCollectionTObject.)
Public propertyName
Collection name. Returns object type if name is not defined
(Overrides AbstractObjectCollectionName.)
Public propertyNameColumn
Name column name
(Overrides ObjectCollectionTObjectNameColumn.)
Public propertyObject
Object instance of the specified type.
Protected propertyObjectsByName
Objects by name collection.
(Inherited from ObjectCollectionTObject.)
Public propertyObjectType
Returns the object type of the objects stored within the collection.
Public propertyOrderBy
Order by expression.
(Overrides AbstractObjectCollectionOrderBy.)
Public propertyParentObject
Parent object.
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
(Inherited from ObjectCollectionTObject.)
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
(Inherited from ObjectCollectionTObject.)
Public propertySearchText
If set, the collection filters objects to only those containing the given text
Public propertySiteID
Site ID to filter the collection to a particular site
Public propertySortNames
If true, the names in enumeration are sorted
(Inherited from ObjectCollectionTObject.)
Public propertyTopN
Select top N objects.
(Inherited from AbstractObjectCollection.)
Public propertyTypeInfo
Type info for the collection object.
Public propertyUseDefaultCacheDependencies
If true, the collection uses default cache dependencies to flush it's content
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 propertyUseObjectTypeCondition
If true, the collection uses the type condition to get the data
Public propertyWhereCondition
Where condition.
(Inherited from AbstractObjectCollection.)
Top
See Also