IEntityCollectionCore Interface |
Interface used as the base for all entity collections. (adapter and selfservicing).
Namespace: SD.LLBLGen.Pro.ORMSupportClasses
Assembly: SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.11.0.0 (5.11.23.1114)
SyntaxThe IEntityCollectionCore type exposes the following members.
Properties| 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.
|
| AllowNew |
Default: true. If set to false, no new entities will be added through databinding.
|
| AllowRemove |
Default: false. If set to true, entities can be removed through databinding.
|
| 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.
|
| Count |
The amount of IEntity2 elements in this entity collection
|
| EntityFactoryToUse |
The EntityFactory to use when creating entity objects during fetch action 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.
|
| IsReadOnly |
Get / set the readonly flag for this collection.
|
| IsRemovalTracker |
Gets or sets a value indicating whether this instance is a removal tracker collection.
|
| Item |
Simple indexer.
|
| RemovedEntitiesTracker |
Gets or sets the removed entities tracker for this entity collection
|
Methods| Name | Description | |
|---|---|---|
 | Add |
Adds an IEntityCore object to the list.
|
| Clear |
Clears the collection
|
| Clear(Boolean) |
Clears the collection
|
| Contains |
Returns true if the list contains the given entity
|
| FindMatches |
Gets all indices of all the entities in the current order of this collection which match the passed in filter.
|
| GetEnumerator | Returns an enumerator that iterates through a collection. (Inherited from IEnumerable.) |
| IndexOf |
Returns index in the list of given entity.
|
| Insert |
Inserts an IEntityCore on position Index
|
| Remove |
Remove given IEntityCore instance from the list.
|
| Sort(Int32, ListSortDirection) |
Applies sorting like IBindingList.ApplySort, on the field with the index fieldIndex and with the direction specified.
|
| Sort(Int32, ListSortDirection, IComparerObject) |
Sorts the collection.
|
| Sort(String, ListSortDirection, IComparerObject) |
Sorts the collection.
|
Events| Name | Description | |
|---|---|---|
 | EntityAdded |
Event which is raised at the End of the Add or Insert(index) routine.
|
| EntityAdding |
Event which is raised at the start of the Add or Insert(index) routine. To cancel the addition action, set cancel to true.
|
| EntityRemoved |
Event which is raised at the End of the Remove or RemoveAt(index) routine.
|
| EntityRemoving |
Event which is raised at the start of the Remove or RemoveAt(index) routine. To cancel the remove action, set cancel to true.
|
| ListChanged |
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.
|
See Also