CollectionCore(T) Class

CollectionCoreT Class

Generic base class for the entity collection classes used by Selfservicing and adapter. This class is mainly written to be able to tap into Add/Remove/Insert etc. without problems: the shipped collection classes in .NET don't have the ability to override Add etc.

Inheritance Hierarchy

SystemObject
  SD.LLBLGen.Pro.ORMSupportClassesCollectionCoreT
    SD.LLBLGen.Pro.ORMSupportClassesEntityCollectionBaseTEntity
    SD.LLBLGen.Pro.ORMSupportClassesEntityCollectionBase2TEntity

Namespace: SD.LLBLGen.Pro.ORMSupportClasses
Assembly: SD.LLBLGen.Pro.ORMSupportClasses (in SD.LLBLGen.Pro.ORMSupportClasses.dll) Version: 5.0.0.0 (5.0.0)

Syntax

Copy

[SerializableAttribute]
public abstract class CollectionCore<T> : IList<T>, 
	ICollection<T>, IEnumerable<T>, IList, ICollection, ISerializable, 
	IComponent, IDisposable, IEntityCollectionCore, IActiveContextParticipant, IEnumerable
where T : class, IEntityCore

<SerializableAttribute>
Public MustInherit Class CollectionCore(Of T As {Class, IEntityCore})
	Implements IList(Of T), ICollection(Of T), 
	IEnumerable(Of T), IList, ICollection, ISerializable, IComponent, 
	IDisposable, IEntityCollectionCore, IActiveContextParticipant, IEnumerable

Type Parameters

T: The type this collection is of (the type of the contained objects.)

The CollectionCoreT type exposes the following members.

Constructors

	Name	Description
	CollectionCoreT	empty ctor.
	CollectionCoreT(SerializationInfo, StreamingContext)	Deserialization CTor

Top

Properties

	Name	Description
	ActiveContext	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.
	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.
	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.
	Count	Gets the number of elements contained in the ICollectionT.
	DeserializationInProgress	Gets or sets a value indicating whether [deserialization in progress].
	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.
	EntityFactoryToUseInternal	Gets or sets the actual entity factory to use
	EntityValidatorToUse	Obsolete. Obsolete. Collections don't store validator objects anymore. Present to make sure users can continue designing their forms in vs.net
	IsReadOnly	Gets a value indicating whether the ICollectionT is read-only.
	Item	Gets or sets the object at the specified index.
	Items	Items contained by this collection. Returns simply this instance.
	RemovedEntitiesTrackerInternal	Gets/sets the actual removed entities tracker collection.
	Site	Gets or sets the ISite associated with the IComponent.
	SuppressListChangedEventsInternal	Gets or sets a value indicating whether [surpress list changed events].
	ValidatorToUse	Obsolete. Obsolete. Collections don't store validator objects anymore. Present to make sure users can continue designing their forms in vs.net

Top

Methods

	Name	Description
	Add	Adds an item to the ICollectionT.
	AddContainedEntitiesToContext	Adds the contained entities to the active set context.
	AddNew	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.
	AddRange	Adds the range of objects passed in.
	Clear	Removes all items from the ICollectionT.
	Contains	Determines whether the ICollectionT contains a specific value.
	CopyTo	Copies the elements of the ICollectionT to an Array, starting at a particular Array index.
	Dispose	Disposes this instance.
	Dispose(Boolean)	Releases unmanaged and - optionally - managed resources
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FindMatches	Gets all indices of all the entities in the current order of this collection which match the passed in filter.
	GetEntityDescription	Gets the entity description for the entity passed in.
	GetEnumerator	Returns an enumerator that iterates through the collection.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetObjectData	ISerializable member.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf	Determines the index of a specific item in the IListT.
	InitCoreClass	Inits the core class.
	Insert	Inserts an item to the IListT at the specified index.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnDeserialized	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).
	OnEntityAdded	Called at the end of the Add or Insert routine which adds an entity to this collection. Will raise EntityAdded event.
	OnEntityAdding	Called at the start of the Add or Insert routine which adds an entity to this collection. Will raise EntityAdding event.
	OnEntityInListOnEntityContentsChanged	Event handler for the EntityContentsChanged event.
	OnEntityRemoved	Called at the end of a remove routine which removes an entity from this collection. Will raise EntityRemoved event.
	OnEntityRemoving	Called at the start of a remove routine which removes an entity from this collection. Will raise EntityRemoving event.
	OnGetObjectData	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).
	OnListChanged	Called when [list changed].
	PerformAddToActiveContext	Performs the add action to the active context for this collection
	PerformSetRelatedEntity	Performs the set related entity action on the passed in entity. This action is delegated to an inheritor.
	PerformUnsetRelatedEntity	Performs the unset related entity action on the passed in entity. This action is delegated to an inheritor.
	PlaceInRemovedEntitiesTracker	Places the item in the set RemovedEntitiesTracker.
	Remove	Removes the first occurrence of a specific object from the ICollectionT.
	RemoveAt	Removes the IListT item at the specified index.
	RemoveRange	Removes the elements in the range specified from this collection.
	SilentRemove	Removes the passed in entity from the collection without notifying the entity to remove that it has been removed from this collection.
	Sort(Int32, ListSortDirection)	Applies sorting like IBindingList.ApplySort, on the field with the index fieldIndex and with the direction specified.
	Sort(PropertyDescriptor, ListSortDirection, IComparerObject)	Sorts the collection.
	Sort(Int32, ListSortDirection, IComparerObject)	Sorts the collection.
	Sort(String, ListSortDirection, IComparerObject)	Sorts the collection.
	ToString	Returns a String that represents the current Object. (Overrides ObjectToString.)

Top

Events

	Name	Description
	Disposed	IComponent's Disposed event.
	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 used in complex databinding.

Top

Explicit Interface Implementations

	Name	Description
	IListAdd	Adds an item to the IList.
	IListClear	Removes all items from the ICollectionT.
	IListContains	Determines whether the IList contains a specific value.
	ICollectionCopyTo	Copies the elements of the ICollection to an Array, starting at a particular Array index.
	ICollectionCount	Gets the number of elements contained in the ICollectionT.
	IEnumerableGetEnumerator	Returns an enumerator that iterates through a collection.
	IListIndexOf	Determines the index of a specific item in the IList.
	IListInsert	Inserts an item to the IList at the specified index.
	IListIsFixedSize	Gets a value indicating whether the IList has a fixed size.
	IListIsReadOnly	Gets a value indicating whether the ICollectionT is read-only.
	ICollectionIsSynchronized	Gets a value indicating whether access to the ICollection is synchronized (thread safe).
	IListItem	Gets or sets the Object at the specified index.
	IListRemove	Removes the first occurrence of a specific object from the IList.
	IListRemoveAt	Removes the IListT item at the specified index.
	ICollectionSyncRoot	Gets an object that can be used to synchronize access to the ICollection.
	IEntityCollectionCoreAdd	Adds an IEntityCore object to the list.
	IEntityCollectionCoreClear	Clears the collection
	IEntityCollectionCoreContainingEntityMappedField	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.
	IEntityCollectionCoreContains	Returns true if the list contains the given entity
	IEntityCollectionCoreEntityFactoryToUse	The EntityFactory to use when creating entity objects during fetch action or other logic which requires the creation of new entities.
	IEntityCollectionCoreFindMatches	Gets all indices of all the entities in the current order of this collection which match the passed in filter.
	IEntityCollectionCoreIndexOf	Returns index in the list of given entity.
	IEntityCollectionCoreInsert	Inserts an IEntityCore on position Index
	IEntityCollectionCoreIsForMN	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.
	IEntityCollectionCoreIsRemovalTracker	Gets or sets a value indicating whether this instance is a removal tracker collection.
	IEntityCollectionCoreItem	Simple indexer.
	IEntityCollectionCoreRemove	Remove given IEntityCore instance from the list.
	IEntityCollectionCoreRemovedEntitiesTracker	Gets or sets the removal tracker for this entity collection

Top

Reference

SD.LLBLGen.Pro.ORMSupportClasses Namespace