Click or drag to resize

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.6.0.0 (5.6.19.0117)
Syntax
public interface IEntityCollectionCore : IActiveContextParticipant, 
	IEnumerable

The IEntityCollectionCore type exposes the following members.

Properties
  NameDescription
Public propertyActiveContext
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.)
Public propertyAllowEdit
Default: true. If set to false, entities inside this collection won't be editable in a complex databinding scenario.
Public propertyAllowNew
Default: true. If set to false, no new entities will be added through databinding.
Public propertyAllowRemove
Default: false. If set to true, entities can be removed through databinding.
Public propertyContainingEntityMappedField
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.
Public propertyCount
The amount of IEntity2 elements in this entity collection
Public propertyEntityFactoryToUse
The EntityFactory to use when creating entity objects during fetch action or other logic which requires the creation of new entities.
Public propertyIsForMN
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.
Public propertyIsReadOnly
Get / set the readonly flag for this collection.
Public propertyIsRemovalTracker
Gets or sets a value indicating whether this instance is a removal tracker collection.
Public propertyItem
Simple indexer.
Public propertyRemovedEntitiesTracker
Gets or sets the removed entities tracker for this entity collection
Top
Methods
  NameDescription
Public methodAdd
Adds an IEntityCore object to the list.
Public methodClear
Clears the collection
Public methodClear(Boolean)
Clears the collection
Public methodContains
Returns true if the list contains the given entity
Public methodFindMatches
Gets all indices of all the entities in the current order of this collection which match the passed in filter.
Public methodGetEnumerator
Returns an enumerator that iterates through a collection.
(Inherited from IEnumerable.)
Public methodIndexOf
Returns index in the list of given entity.
Public methodInsert
Inserts an IEntityCore on position Index
Public methodRemove
Remove given IEntityCore instance from the list.
Public methodSort(Int32, ListSortDirection)
Applies sorting like IBindingList.ApplySort, on the field with the index fieldIndex and with the direction specified.
Public methodSort(Int32, ListSortDirection, IComparerObject)
Sorts the collection.
Public methodSort(String, ListSortDirection, IComparerObject)
Sorts the collection.
Top
Events
  NameDescription
Public eventEntityAdded
Event which is raised at the End of the Add or Insert(index) routine.
Public eventEntityAdding
Event which is raised at the start of the Add or Insert(index) routine. To cancel the addition action, set cancel to true.
Public eventEntityRemoved
Event which is raised at the End of the Remove or RemoveAt(index) routine.
Public eventEntityRemoving
Event which is raised at the start of the Remove or RemoveAt(index) routine. To cancel the remove action, set cancel to true.
Public eventListChanged
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.
Top
See Also