EntityCollectionBaseTEntity Class

CTor

Private CTor for deserialization

Gets / sets the active context this entity collection is in. Setting this property is not adding the entity collection to the context, it will make contained entities be added to the passed in context. If the entity collection 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 entity collections.

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 entity which contains this collection (e.g. Customer, if this collection is the Customer's Orders collection), or null if this collection isn't part of any entity.

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.

Gets a value indicating whether the collection is a collection of IList objects.

Gets the number of elements contained in the ICollectionT.

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

Gets or sets a value indicating whether [deserialization in progress].

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) this check is not performed. Setting this property to true can slow down fetch logic.

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 the entity factory to use

Obsolete. Collections don't store validator objects anymore. Present to make sure users can continue designing their forms in vs.net

Gets a value indicating whether the ICollectionT is read-only.

Gets or sets the object at the specified index.

Items contained by this collection. Returns simply this instance.

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.

Flag to check if the ITransactionalElement implementing object is participating in a transaction or not.

Gets or sets the entity collection which should be used as removed entities tracker. If this property is set to an IEntityCollection 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.

Gets or sets the removal tracker internal.

Gets or sets the ISite associated with the IComponent.

The order by specifications for the sorting of the resultset when fetching it from the persistent storage. 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.

Gets or sets a value indicating whether [surpress list changed events].

The ITransaction this ITransactionalElement implementing object is participating in. Only valid if ParticipatesInTransaction is true. If set to null, the ITransactionalElement is no longer participating in a transaction.

Obsolete. Collections don't store validator objects anymore. Present to make sure users can continue designing their forms in vs.net

Adds an item to the ICollectionT.

Adds the contained entities to the active set context.

Will add a new entity to the list, will set its parent collection property so CancelEdit will remove it from the list again, and will set its flag that it is added by databinding.

Adds the range of objects passed in.

Removes all items from the ICollectionT.

Removes all items from the ICollectionT.

Clears this instance if the SuppressClearInGetMulti flag is false

Determines whether the ICollectionT contains a specific value.

Copies the elements of the ICollectionT to an Array, starting at a particular Array index.

Creats a new DAO instance so code which is in the base class can still use the proper DAO object.

Creates the default entity view instance. By default it creates a new EntityView(Of TEntity) instance, passing in this collection.

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 view and for each type in the complete graph found starting with each entity in this view, using the viewProjections 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 transaction object

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. 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.

Disposes this instance.

Releases unmanaged and - optionally - managed resources

Determines whether the specified object is equal to the current object.

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.

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.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage 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.

Gets the entity description for the entity passed in.

Returns an enumerator that iterates through the collection.

Serves as the default hash function.

Returns an IList that can be bound to a data source from an object that does not implement an IList itself.

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.

ISerializable member.

Produce the schema, always return null, as the XmlSerializer object otherwise can't handle our code.

Gets the Type of the current instance.

Determines the index of a specific item in the IListT.

Inits the core class.

Inserts an item to the IListT at the specified 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.

Creates a shallow copy of the current Object.

Called at the end of the deserialization constructor. Method is used when this object is deserialized. Override this method to tap into the deserialization sequence. (binary/soap formatter specific).

Called at the end of the Add or Insert routine which adds an entity to this collection. Will raise EntityAdded event.

Called at the start of the Add or Insert routine which adds an entity to this collection. Will raise EntityAdding event.

Event handler for the EntityContentsChanged event.

Called at the end of a remove routine which removes an entity from this collection. Will raise EntityRemoved event.

Called at the start of a remove routine which removes an entity from this collection. Will raise EntityRemoving event.

Called at the end of GetObjectData. Method is used when this object is serialized. Override this method to tap into the serialization sequence. (binary/soap formatter specific).

Called when [list changed].

Performs the add action to the active context for this collection

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.

Performs the set related entity action on the passed in entity. This action is delegated to an inheritor.

Performs the unset related entity action on the passed in entity. This action is delegated to an inheritor.

Places the item in the set RemovedEntitiesTracker.

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 IEntityCollection2.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 IEntityCollection2.WriteXml() and the Xml has to be compatible with the structure of this entity collection.

Constructs an object graph with this object as the root from the xml contained by the passed in XmlReader object.

Removes the first occurrence of a specific object from the ICollectionT.

Removes the IListT item at the specified index.

Removes the elements in the range specified from this 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.). 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 EntityCollection members, like 'Customer' which contains 'Orders' entity collection.

Removes the passed in entity from the collection without notifying the entity to remove that it has been removed from this collection.

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

Sorts the collection.

Sorts the collection.

Sorts the collection.

Returns a String that represents the current Object.

When the ITransaction in which this IEntity participates is commited, this IEntity can succesfully finish actions performed by this IEntity. This method is called by ITransaction, you should not call it by yourself. When this IEntity doesn't participate in a transaction it finishes the actions itself, calling this method is not needed.

When the ITransaction in which this IEntity participates is rolled back, this IEntity has to roll back its internal variables. This method is called by ITransaction, you should not call it by yourself.

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

Constructs the XML output from the object graph which has this object as the root.

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.

IComponent's Disposed event.

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 used in complex databinding.

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.

Adds an item to the IList.

Removes all items from the ICollectionT.

Determines whether the IList contains a specific value.

Copies the elements of the ICollection to an Array, starting at a particular Array index.

Gets the number of elements contained in the ICollectionT.

Returns an enumerator that iterates through a collection.

Determines the index of a specific item in the IList.

Inserts an item to the IList at the specified index.

Gets a value indicating whether the IList has a fixed size.

Gets a value indicating whether the ICollectionT is read-only.

Gets a value indicating whether access to the ICollection is synchronized (thread safe).

Gets or sets the Object at the specified index.

Removes the first occurrence of a specific object from the IList.

Removes the IListT item at the specified index.

Gets an object that can be used to synchronize access to the ICollection.

Adds an IEntity object to the list.

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

Gets / sets the initial capacity of the entity collection.

Returns true if the list contains the given IEntity Object

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, 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.

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.

Gets the default view for this entitycollection. The returned value is a new 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.

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.

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.

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.

Inserts an IEntity on position Index

Gets or sets the IEntity at the specified index.

Remove given IEntity from the list.

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.

Adds an IEntityCore object to the list.

Clears the collection

Clears the collection

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 the list contains the given entity

The EntityFactory to use when creating entity objects during fetch action or other logic which requires the creation of new entities.

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

Returns index in the list of given entity.

Inserts an IEntityCore on position Index

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.

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

Simple indexer.

Remove given IEntityCore instance from the list.

Gets or sets the removal tracker for this entity collection