IEntityCollection Properties |
The IEntityCollection type exposes the following members.
Name | Description | |
---|---|---|
ActiveContext |
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.
(Inherited from IActiveContextParticipant.) | |
AllowEdit |
Default: true. If set to false, entities inside this collection won't be editable in a complex databinding scenario.
(Inherited from IEntityCollectionCore.) | |
AllowNew |
Default: true. If set to false, no new entities will be added through databinding.
(Inherited from IEntityCollectionCore.) | |
AllowRemove |
Default: false. If set to true, entities can be removed through databinding.
(Inherited from IEntityCollectionCore.) | |
Capacity |
Gets / sets the initial capacity of the entity collection.
| |
ConcurrencyPredicateFactoryToUse |
Gets / sets the IConcurrencyPredicateFactory instance to use when creating entity objects during a GetMulti() call or when AddNew is called.
| |
ContainingEntityMappedField |
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.
(Inherited from IEntityCollectionCore.) | |
ContainsDirtyContents |
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.
| |
Count |
The amount of IEntity2 elements in this entity collection
(Inherited from IEntityCollectionCore.) | |
DefaultView |
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.
| |
DirtyEntities |
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.
| |
DoNotPerformAddIfPresent |
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.
| |
EntityFactoryToUse |
The EntityFactory to use when creating entity objects during a GetMulti() call or other logic which requires the creation of new entities.
| |
IsForMN |
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.
(Inherited from IEntityCollectionCore.) | |
IsReadOnly |
Get / set the readonly flag for this collection.
(Inherited from IEntityCollectionCore.) | |
IsRemovalTracker |
Gets or sets a value indicating whether this instance is a removal tracker collection.
(Inherited from IEntityCollectionCore.) | |
Item |
Gets or sets the IEntity at the specified index.
| |
MaxNumberOfItemsToReturn |
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.
| |
RemovedEntitiesTracker |
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.
| |
SortClauses |
The order by specifications for the sorting of the resultset. When not specified, no sorting is applied.
| |
SuppressClearInGetMulti |
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.
|