IEntityCollection Interface

Gets / sets the active context this object is in. Setting this property is not adding the object to the context, it will make contained entities be added to the passed in context. If the object is already in a context, setting this property has no effect. Setting this property is done by framework code, use the Context's Add/Get methods to work with contexts and entities.

Default: true. If set to false, entities inside this collection won't be editable in a complex databinding scenario.

Default: true. If set to false, no new entities will be added through databinding.

Default: false. If set to true, entities can be removed through databinding.

Gets / sets the initial capacity of the entity collection.

Gets / sets the IConcurrencyPredicateFactory instance to use when creating entity objects during a GetMulti() call or when AddNew is called.

Gets the name of the field mapped onto the relation in the opposite entity which is represented by this collection, if this collection is contained by an entity. E.g. it will return "Customer" if the relation Customer - Order has the field 'Customer' mapped onto it in Order and this collection is the Orders collection in Customer. If this collection isn't contained in any entity, an empty string is returned.

Returns true if this collection contains dirty objects. If this collection contains dirty objects, an already filled collection should not be refreshed until a save is performed. This property is calculated in real time and can be time consuming when the collection contains a lot of objects. Use this property only in cases when the value of this property is used to do a refetch or not.

The amount of IEntity2 elements in this entity collection

Gets the default view for this entitycollection. The returned value is the same instance every time this property is read. It's a new entity view without a filter or a sorter.

Returns a readonly collection of entities which are flagged as dirty. This collection is determined on the fly, you can use this collection to remove dirty entities from this entity collection.

When set to true, an entity passed to Add() or Insert() will be tested if it's already present. If so, the index is returned and the object is not added again. If set to false (default: true) this check is not performed. Setting this property to true can slow down fetch logic. DataAccessAdapter's fetch logic sets this property to false during a multi-entity fetch.

The EntityFactory to use when creating entity objects during a GetMulti() call or other logic which requires the creation of new entities.

Gets or sets a value indicating whether this instance is for a M:N relationship. If set to true, it will also set IsReadOnly to true.

Get / set the readonly flag for this collection.

Gets or sets a value indicating whether this instance is a removal tracker collection.

Gets or sets the IEntity at the specified index.

The maximum number of items to return with this retrieval query. If the used Dynamic Query Engine supports it, 'TOP' is used to limit the amount of rows to return. When set to 0, no limitations are specified.

Gets or sets the entity collection which should be used as removed entities tracker. If this property is set to an IEntityCollection2 instance, all entities which are removed from this collection are marked for deletion and placed in this removed entities tracker collection. This collection can then later on be used to delete these entities from the database in one go.

The order by specifications for the sorting of the resultset. When not specified, no sorting is applied.

Surpresses the removal of all contents of the collection in a GetMulti*() call. Used by code in related entities to prevent the removal of objects when collection properties are accessed.

Adds an IEntity object to the list.

Adds an IEntityCore object to the list.

Adds the range of objects passed in. Objects have to be IEntity implementing objects

Clears the collection

Clears the collection

Returns true if the list contains the given IEntity Object

Returns true if the list contains the given entity

copy the complete list of IEntity objects to an array of IEntity objects.

Creates a hierarchical projection of all the data in this collection and for each type in the complete graph found starting with each entity in this collection. Per entity type found, an entry is stored inside the destination dictionary. It will simply project every data element.

Creates a hierarchical projection of all the data in this collection and for each type in the complete graph found starting with each entity in this collection. Per entity type found, a new datatable is created inside destination or if one with the name of the entity is already present, that one is used. It will simply project every data element.

Creates a hierarchical projection of all the data in this collection and for each type in the complete graph found starting with each entity in this collection, using the collectionProjections data passed in. Per entity type found, an entry is stored inside the destination dictionary.

Creates a hierarchical projection of all the data in this collection and for each type in the complete graph found starting with each entity in this collection, using the collectionProjections data passed in. Per entity type found, a new datatable is created inside destination or if one with the name of the entity is already present, that one is used.

Creates a new EntityView object of the right type on this collection with no filter nor sorter applied.

Creates a new EntityView object of the right type on this collection with the passed in filter applied

Creates a new EntityView object of the right type on this collection with the passed in filter and sorter applied to it.

Creates a new EntityView object of the right type on this collection with the passed in filter and sorter applied to it and the dataChangeAction set to the passed in value.

Deletes all Entities in the IEntityCollection from the persistent storage. If this IEntityCollection is added to a transaction, the delete processes will be done in that transaction, if the entity isn't already added to another transaction. If the entity is already in another transaction, it will use that transaction. If no transaction is present, the deletes are done in a new Transaction (which is created in an inherited method.) Deleted entities are marked deleted and are removed from the collection.

Deletes from the persistent storage all entities of the type this collection is for which match with the specified filter, formulated in the predicate or predicate expression definition.

Deletes from the persistent storage all entities of the type this collection is for which match with the specified filter, formulated in the predicate or predicate expression definition.

Async variant of DeleteMulti. Deletes all Entities in the IEntityCollection from the persistent storage. If this IEntityCollection is added to a transaction, the delete processes will be done in that transaction, if the entity isn't already added to another transaction. If the entity is already in another transaction, it will use that transaction. If no transaction is present, the deletes are done in a/ new Transaction. Deleted entities are marked deleted and are removed from the collection.

Async variant of DeleteMulti. Deletes all Entities in the IEntityCollection from the persistent storage. If this IEntityCollection is added to a transaction, the delete processes will be done in that transaction, if the entity isn't already added to another transaction. If the entity is already in another transaction, it will use that transaction. If no transaction is present, the deletes are done in a/ new Transaction. Deleted entities are marked deleted and are removed from the collection.

Async variant of DeleteMulti(IPredicate). Deletes from the persistent storage all entities of the type this collection is for which match with the specified filter, formulated in the predicate or predicate expression definition.

Async variant of DeleteMulti(IPredicate, IRelationCollection). Deletes from the persistent storage all entities of the type this collection is for which match with the specified filter, formulated in the predicate or predicate expression definition.

Async variant of DeleteMulti(IPredicate). Deletes from the persistent storage all entities of the type this collection is for which match with the specified filter, formulated in the predicate or predicate expression definition.

Async variant of DeleteMulti(IPredicate, IRelationCollection). Deletes from the persistent storage all entities of the type this collection is for which match with the specified filter, formulated in the predicate or predicate expression definition.

Loads the data for the excluded fields specified in the list of excluded fields into all the entities in this collection.

Async variant of FetchExcludedFields(ExcludeIncludeFieldsList). Loads the data for the excluded fields specified in the list of excluded fields into all the entities in this collection.

Gets all indices of all the entities in the current order of this collection which match the passed in filter.

Gets the amount of Entity objects in the database.

Gets the amount of Entity objects in the database, when taking into account the filter specified.

Gets the amount of Entity objects in the database, when taking into account the filter specified and the relations specified.

Returns an enumerator that iterates through a collection.

Retrieves in this Collection object all Entity objects which match with the specified filter, formulated in the predicate or predicate expression definition.

Retrieves in this Collection object all Entity objects which match with the specified filter, formulated in the predicate or predicate expression definition, using the passed in relations to construct the total query.

Retrieves in this Collection object all Entity objects which match with the specified filter, formulated in the predicate or predicate expression definition.

Retrieves in this Collection object all Entity objects which match with the specified filter, formulated in the predicate or predicate expression definition.

Retrieves in this Collection object all Entity objects which match with the specified filter, formulated in the predicate or predicate expression definition, using the passed in relations to construct the total query.

Retrieves in this Collection object all Entity objects which match with the specified filter, formulated in the predicate or predicate expression definition.

Retrieves in this Collection object all Entity objects which match with the specified filter, formulated in the predicate or predicate expression definition.

Retrieves in this Collection object all Entity objects which match with the specified filter, formulated in the predicate or predicate expression definition.

Retrieves in this Collection object all Entity objects which match with the specified filter, formulated in the predicate or predicate expression definition, using the passed in relations to construct the total query.

Retrieves in this Collection object all Entity objects which match with the specified filter, formulated in the predicate or predicate expression definition, using the passed in relations to construct the total query.

Retrieves in this Collection object all Entity objects which match with the specified filter, formulated in the predicate or predicate expression definition, using the passed in relations to construct the total query.

Retrieves in this Collection object all Entity objects which match with the specified filter, formulated in the predicate or predicate expression definition, using the passed in relations to construct the total query.

Returns index in the list of given IEntity object.

Returns index in the list of given entity.

Inserts an IEntity on position Index

Inserts an IEntityCore on position Index

Inserts all rows matching the select query into the target of the entity type this collection is for. Which fields are inserted is defined by the select query. Sequenced fields are taken care of if they're not specified in the select query. This method will result in an INSERT INTO entityTarget (field1, field2...) SELECT ... statement.

Async variant of InsertMulti(DynamicQuery) Inserts all rows matching the select query into the target of the entity type this collection is for. Which fields are inserted is defined by the select query. Sequenced fields are taken care of if they're not specified in the select query. This method will result in an INSERT INTO entityTarget (field1, field2...) SELECT ... statement.

Async variant of InsertMulti(DynamicQuery) Inserts all rows matching the select query into the target of the entity type this collection is for. Which fields are inserted is defined by the select query. Sequenced fields are taken care of if they're not specified in the select query. This method will result in an INSERT INTO entityTarget (field1, field2...) SELECT ... statement.

Retrieves in this Collection object all Entity objects which match with the specified filter, formulated in the predicate or predicate expression definition, using the passed in relations to construct the total query.

Async variant of PerformGetMulti(QueryParameters). Retrieves in this Collection object all Entity objects which match with the specified filter, formulated in the predicate or predicate expression definition, using the passed in relations to construct the total query.

Will fill the entity collection and its containing members (recursively) with the data stored in the XmlNode passed in. The XmlNode has to be filled with Xml in the format written by IEntityCollection.WriteXml() and the Xml has to be compatible with the structure of this entity collection.

Will fill the entity collection and its containing members (recursively) with the data stored in the XmlNode passed in. The XmlNode has to be filled with Xml in the format written by IEntityCollection.WriteXml() and the Xml has to be compatible with the structure of this entity collection.

Remove given IEntity from the list.

Remove given IEntityCore instance from the list.

Saves all new/dirty Entities in the IEntityCollection in the persistent storage. If this IEntityCollection is added to a transaction, the save processes will be done in that transaction, if the entity isn't already added to another transaction. If the entity is already in another transaction, it will use that transaction. If no transaction is present, the saves are done in a new Transaction (which is created in an inherited method.). Will not recursively save entities inside the collection.

Saves all new/dirty Entities in the IEntityCollection in the persistent storage. If this IEntityCollection is added to a transaction, the save processes will be done in that transaction, if the entity isn't already added to another transaction. If the entity is already in another transaction, it will use that transaction. If no transaction is present, the saves are done in a new Transaction (which is created in an inherited method.)

Async variant of SaveMulti. Saves all new/dirty Entities in the IEntityCollection in the persistent storage. If this IEntityCollection is added to a transaction, the save processes will be done in that transaction, if the entity isn't already added to another transaction. If the entity is already in another transaction, it will use that transaction. If no transaction is present, the saves are done in a new Transaction (which is created in an inherited method.). Will not recursively save entities inside the collection.

Async variant of SaveMulti(Boolean). Saves all new/dirty Entities in the IEntityCollection in the persistent storage. If this IEntityCollection is added to a transaction, the save processes will be done in that transaction, if the entity isn't already added to another transaction. If the entity is already in another transaction, it will use that transaction. If no transaction is present, the saves are done in a new Transaction (which is created in an inherited method.)

Async variant of SaveMulti. Saves all new/dirty Entities in the IEntityCollection in the persistent storage. If this IEntityCollection is added to a transaction, the save processes will be done in that transaction, if the entity isn't already added to another transaction. If the entity is already in another transaction, it will use that transaction. If no transaction is present, the saves are done in a new Transaction (which is created in an inherited method.)

Async variant of SaveMulti(Boolean). Saves all new/dirty Entities in the IEntityCollection in the persistent storage. If this IEntityCollection is added to a transaction, the save processes will be done in that transaction, if the entity isn't already added to another transaction. If the entity is already in another transaction, it will use that transaction. If no transaction is present, the saves are done in a new Transaction (which is created in an inherited method.)

Sets the entity information of the entity object containing this collection. Call this method only from entity classes which contain IEntityCollection members, like 'Customer' which contains 'Orders' entity collection.

Applies sorting like IBindingList.ApplySort, on the field with the index fieldIndex and with the direction specified.

Sorts the collection.

Sorts the collection.

Updates in the persistent storage all entities of the type this collection is for which have data in common with the specified entity. Which fields are updated in those matching entities depends on which fields are changed in entityWithNewValues. The new values of these fields are read from entityWithNewValues.

Updates in the persistent storage all entities of the type this collection is for which have data in common with the specified entity. Which fields are updated in those matching entities depends on which fields are changed in entityWithNewValues. The new values of these fields are read from entityWithNewValues.

Async variant of UpdateMulti(IEntity, IPredicate). Updates in the persistent storage all entities of the type this collection is for which have data in common with the specified entity. Which fields are updated in those matching entities depends on which fields are changed in entityWithNewValues. The new values of these fields are read from entityWithNewValues.

Async variant of UpdateMulti(IEntity, IPredicate, IRelationCollection). Updates in the persistent storage all entities of the type this collection is for which have data in common with the specified entity. Which fields are updated in those matching entities depends on which fields are changed in entityWithNewValues. The new values of these fields are read from entityWithNewValues.

Async variant of UpdateMulti(IEntity, IPredicate). Updates in the persistent storage all entities of the type this collection is for which have data in common with the specified entity. Which fields are updated in those matching entities depends on which fields are changed in entityWithNewValues. The new values of these fields are read from entityWithNewValues.

Async variant of UpdateMulti(IEntity, IPredicate, IRelationCollection). Updates in the persistent storage all entities of the type this collection is for which have data in common with the specified entity. Which fields are updated in those matching entities depends on which fields are changed in entityWithNewValues. The new values of these fields are read from entityWithNewValues.

Converts this entity collection to XML, recursively. Uses "EntityCollection" for the rootnode name

Converts this entity collection to XML.

Converts this entity collection to XML. Uses "EntityCollection" for the rootnode name

Converts this entity collection to XML, recursively. Uses "EntityCollection" for the rootnode name

Converts this entity collection to XML.

Converts this entity collection to XML.

Converts this entity collection to XML. Uses "EntityCollection" for the rootnode name

Converts this entity collection to XML.

Event which is raised at the End of the Add or Insert(index) routine.

Event which is raised at the start of the Add or Insert(index) routine. To cancel the addition action, set cancel to true.

Event which is raised at the End of the Remove or RemoveAt(index) routine.

Event which is raised at the start of the Remove or RemoveAt(index) routine. To cancel the remove action, set cancel to true.

Event which is raised when the collection changed: an item changed, an item was removed, added, or the collection was cleared. If possible, use one of the Entity* events of this collection.

Fetches the query specified into the collection specified.

Async variant of GetMultiTEntity(IEntityCollection, EntityQueryTEntity). Fetches the query specified into the collection specified.

Async variant of GetMultiTEntity(IEntityCollection, EntityQueryTEntity). Fetches the query specified into the collection specified.