EntityCollectionBase2TEntity Class |
Namespace: SD.LLBLGen.Pro.ORMSupportClasses
[SerializableAttribute] public abstract class EntityCollectionBase2<TEntity> : CollectionCore<TEntity>, IXmlSerializable, IListSource, IEntityCollection2, IEntityCollectionCore, IActiveContextParticipant, IEnumerable, IOwnedDataSerializable where TEntity : EntityBase2, IEntity2
The EntityCollectionBase2TEntity type exposes the following members.
Name | Description | |
---|---|---|
EntityCollectionBase2TEntity |
CTor
| |
EntityCollectionBase2TEntity(IEnumerableTEntity) |
CTor
| |
EntityCollectionBase2TEntity(IEntityFactory2) |
CTor
| |
EntityCollectionBase2TEntity(SerializationInfo, StreamingContext) |
Private CTor for deserialization
|
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.
(Inherited from CollectionCoreT.) | |
AllowEdit |
Default: true. If set to false, entities inside this collection won't be editable in a complex databinding scenario.
(Inherited from CollectionCoreT.) | |
AllowNew |
Default: true. If set to false, no new entities will be added through databinding.
(Inherited from CollectionCoreT.) | |
AllowRemove |
Default: false. If set to true, entities can be removed through databinding.
(Inherited from CollectionCoreT.) | |
Capacity |
Gets / sets the initial capacity of the entity collection.
(Inherited from CollectionCoreT.) | |
ConcurrencyPredicateFactoryToUse |
Gets / sets the IConcurrencyPredicateFactory instance to use when creating entity objects during a GetMulti() call or when AddNew is called.
(Inherited from CollectionCoreT.) | |
ContainingEntity |
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.
| |
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 CollectionCoreT.) | |
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.
| |
ContainsListCollection |
Gets a value indicating whether the collection is a collection of IList objects.
| |
Count |
Gets the number of elements contained in the ICollectionT.
(Inherited from CollectionCoreT.) | |
DefaultView |
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.
| |
DeserializationInProgress |
Gets or sets a value indicating whether [deserialization in progress].
(Inherited from CollectionCoreT.) | |
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.
(Inherited from CollectionCoreT.) | |
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) this check is not performed. Setting this property to true can slow down fetch logic.
(Inherited from CollectionCoreT.) | |
EntityFactoryToUse |
The EntityFactory2 to use when creating entity objects when bound to a grid and AddNew is enabled.
| |
EntityFactoryToUseInternal |
Gets or sets the entity factory to use
(Overrides CollectionCoreTEntityFactoryToUseInternal.) | |
EntityValidatorToUse | Obsolete.
Obsolete. Collections don't store validator objects anymore. Present to make sure users can continue designing their forms in vs.net
(Inherited from CollectionCoreT.) | |
IsReadOnly |
Gets a value indicating whether the ICollectionT is read-only.
(Inherited from CollectionCoreT.) | |
Item |
Gets or sets the object at the specified index.
(Inherited from CollectionCoreT.) | |
Items |
Items contained by this collection. Returns simply this instance.
(Inherited from CollectionCoreT.) | |
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.
| |
RemovedEntitiesTrackerInternal |
Gets or sets the removal tracker internal.
(Overrides CollectionCoreTRemovedEntitiesTrackerInternal.) | |
Site |
Gets or sets the ISite associated with the IComponent.
(Inherited from CollectionCoreT.) | |
SuppressListChangedEventsInternal |
Gets or sets a value indicating whether [surpress list changed events].
(Inherited from CollectionCoreT.) | |
ValidatorToUse | Obsolete.
Obsolete. Collections don't store validator objects anymore. Present to make sure users can continue designing their forms in vs.net
(Inherited from CollectionCoreT.) |
Name | Description | |
---|---|---|
Add |
Adds an item to the ICollectionT.
(Inherited from CollectionCoreT.) | |
AddContainedEntitiesToContext |
Adds the contained entities to the active set context.
(Inherited from CollectionCoreT.) | |
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.
(Overrides CollectionCoreTAddNew.) | |
AddRange |
Adds the range of objects passed in.
(Inherited from CollectionCoreT.) | |
Clear |
Removes all items from the ICollectionT.
(Inherited from CollectionCoreT.) | |
Contains |
Determines whether the ICollectionT contains a specific value.
(Inherited from CollectionCoreT.) | |
CopyTo | (Inherited from CollectionCoreT.) | |
CreateDefaultEntityView |
Creates the default entity view instance. By default it creates a new EntityView2(Of TEntity) instance, passing in this collection.
| |
CreateHierarchicalProjection(DictionaryType, IEntityCollection2) |
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.
| |
CreateHierarchicalProjection(DataSet) |
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.
| |
CreateHierarchicalProjection(ListIViewProjectionData, DictionaryType, IEntityCollection2) |
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.
| |
CreateHierarchicalProjection(ListIViewProjectionData, DataSet) |
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.
| |
CreateView |
Creates a new EntityView2 object of the right type on this collection with no filter nor sorter applied.
| |
CreateView(IPredicate) |
Creates a new EntityView2 object of the right type on this collection with the passed in filter applied
| |
CreateView(IPredicate, ISortExpression) |
Creates a new EntityView2 object of the right type on this collection with the passed in filter and sorter applied to it.
| |
CreateView(IPredicate, ISortExpression, PostCollectionChangeAction) |
Creates a new EntityView2 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.
| |
DeserializeOwnedData |
Method which restores owned data - i.e. considered private to this entity
and not shared with any external object
| |
Dispose |
Disposes this instance.
(Inherited from CollectionCoreT.) | |
Dispose(Boolean) |
Releases unmanaged and - optionally - managed resources
(Inherited from CollectionCoreT.) | |
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.
(Inherited from CollectionCoreT.) | |
GetEntityDescription |
Gets the entity description for the entity passed in.
(Overrides CollectionCoreTGetEntityDescription(T, Boolean).) | |
GetEnumerator |
Returns an enumerator that iterates through the collection.
(Inherited from CollectionCoreT.) | |
GetHashCode | Serves as the default hash function. (Inherited from Object.) | |
GetList | ||
GetObjectData |
ISerializable member.
(Overrides CollectionCoreTGetObjectData(SerializationInfo, StreamingContext).) | |
GetSchema |
Produce the schema, always return null, as the XmlSerializer object otherwise can't handle our code.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
IndexOf |
Determines the index of a specific item in the IListT.
(Inherited from CollectionCoreT.) | |
InitCoreClass |
Inits the core class.
(Inherited from CollectionCoreT.) | |
Insert |
Inserts an item to the IListT at the specified index.
(Inherited from CollectionCoreT.) | |
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).
(Inherited from CollectionCoreT.) | |
OnEntityAdded |
Called at the end of the Add or Insert routine which adds an entity to this collection. Will raise EntityAdded event.
(Inherited from CollectionCoreT.) | |
OnEntityAdding |
Called at the start of the Add or Insert routine which adds an entity to this collection. Will raise EntityAdding event.
(Inherited from CollectionCoreT.) | |
OnEntityInListOnEntityContentsChanged |
Event handler for the EntityContentsChanged event.
(Inherited from CollectionCoreT.) | |
OnEntityRemoved |
Called at the end of a remove routine which removes an entity from this collection. Will raise EntityRemoved event.
(Inherited from CollectionCoreT.) | |
OnEntityRemoving |
Called at the start of a remove routine which removes an entity from this collection. Will raise EntityRemoving event.
(Inherited from CollectionCoreT.) | |
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).
(Inherited from CollectionCoreT.) | |
OnListChanged |
Called when [list changed].
(Inherited from CollectionCoreT.) | |
PerformAddToActiveContext |
Performs the add action to the active context for this collection
(Inherited from CollectionCoreT.) | |
PerformSetRelatedEntity |
Performs the set related entity action on the passed in entity. This action is delegated to an inheritor.
(Overrides CollectionCoreTPerformSetRelatedEntity(T).) | |
PerformUnsetRelatedEntity |
Performs the unset related entity action on the passed in entity. This action is delegated to an inheritor.
(Overrides CollectionCoreTPerformUnsetRelatedEntity(T).) | |
PlaceInRemovedEntitiesTracker |
Places the item in the set RemovedEntitiesTracker.
(Overrides CollectionCoreTPlaceInRemovedEntitiesTracker(T).) | |
ReadXml(String) |
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.
| |
ReadXml(XmlNode) |
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.
| |
ReadXml(XmlReader) |
Constructs an object graph with this object as the root from the xml contained by the passed in XmlReader object.
| |
ReadXml(XmlReader, XmlFormatAspect) |
Constructs an object graph with this object as the root from the xml contained by the passed in XmlReader object.
| |
Remove |
Removes the first occurrence of a specific object from the ICollectionT.
(Inherited from CollectionCoreT.) | |
RemoveAt |
Removes the IListT item at the specified index.
(Inherited from CollectionCoreT.) | |
RemoveRange |
Removes the elements in the range specified from this collection.
(Inherited from CollectionCoreT.) | |
SerializeOwnedData |
Method which restores owned data - i.e. considered private to this collection
and not shared with any external object
| |
SetContainingEntityInfo |
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.
| |
SilentRemove |
Removes the passed in entity from the collection without notifying the entity to remove that it has been removed from this collection.
(Inherited from CollectionCoreT.) | |
Sort(Int32, ListSortDirection) |
Applies sorting like IBindingList.ApplySort, on the field with the index fieldIndex and with the direction specified.
(Inherited from CollectionCoreT.) | |
Sort(PropertyDescriptor, ListSortDirection, IComparerObject) |
Sorts the collection.
(Inherited from CollectionCoreT.) | |
Sort(String, ListSortDirection, IComparerObject) |
Sorts the collection.
(Inherited from CollectionCoreT.) | |
Sort(Int32, ListSortDirection, IComparerObject) |
Sorts the collection.
(Overrides CollectionCoreTSort(Int32, ListSortDirection, IComparerObject).) | |
ToString | (Inherited from CollectionCoreT.) | |
WriteXml(String) |
Converts this entity collection to XML, recursively. Uses "EntityCollection" for the rootnode name
| |
WriteXml(XmlWriter) |
Constructs the XML output from the object graph which has this object as the root.
| |
WriteXml(String, String) |
Converts this entity collection to XML.
| |
WriteXml(XmlDocument, XmlNode) |
Converts this entity collection to XML. Uses "EntityCollection" for the rootnode name
| |
WriteXml(XmlWriter, XmlFormatAspect) |
Converts this entity collection to XML
| |
WriteXml(XmlFormatAspect, String) |
Converts this entity collection to XML, recursively. Uses "EntityCollection" for the rootnode name
| |
WriteXml(String, XmlDocument, XmlNode) |
Converts this entity collection to XML.
| |
WriteXml(XmlWriter, XmlFormatAspect, String) |
Converts this entity collection to XML
| |
WriteXml(XmlFormatAspect, String, String) |
Converts this entity collection to XML.
| |
WriteXml(XmlFormatAspect, XmlDocument, XmlNode) |
Converts this entity collection to XML. Uses "EntityCollection" for the rootnode name
| |
WriteXml(XmlFormatAspect, String, XmlDocument, XmlNode) |
Converts this entity collection to XML.
|
Name | Description | |
---|---|---|
Disposed |
IComponent's Disposed event.
(Inherited from CollectionCoreT.) | |
EntityAdded |
Event which is raised at the End of the Add or Insert(index) routine.
(Inherited from CollectionCoreT.) | |
EntityAdding |
Event which is raised at the start of the Add or Insert(index) routine. To cancel the addition action, set cancel to true.
(Inherited from CollectionCoreT.) | |
EntityRemoved |
Event which is raised at the End of the Remove or RemoveAt(index) routine.
(Inherited from CollectionCoreT.) | |
EntityRemoving |
Event which is raised at the start of the Remove or RemoveAt(index) routine. To cancel the remove action, set cancel to true.
(Inherited from CollectionCoreT.) | |
ListChanged |
Event which is used in complex databinding.
(Inherited from CollectionCoreT.) |
Name | Description | |
---|---|---|
IListAdd |
Adds an item to the IList.
(Inherited from CollectionCoreT.) | |
IListClear |
Removes all items from the ICollectionT.
(Inherited from CollectionCoreT.) | |
IListContains |
Determines whether the IList contains a specific value.
(Inherited from CollectionCoreT.) | |
ICollectionCopyTo | (Inherited from CollectionCoreT.) | |
ICollectionCount |
Gets the number of elements contained in the ICollectionT.
(Inherited from CollectionCoreT.) | |
IEnumerableGetEnumerator |
Returns an enumerator that iterates through a collection.
(Inherited from CollectionCoreT.) | |
IListIndexOf |
Determines the index of a specific item in the IList.
(Inherited from CollectionCoreT.) | |
IListInsert |
Inserts an item to the IList at the specified index.
(Inherited from CollectionCoreT.) | |
IListIsFixedSize |
Gets a value indicating whether the IList has a fixed size.
(Inherited from CollectionCoreT.) | |
IListIsReadOnly |
Gets a value indicating whether the ICollectionT is read-only.
(Inherited from CollectionCoreT.) | |
ICollectionIsSynchronized |
Gets a value indicating whether access to the ICollection is synchronized (thread safe).
(Inherited from CollectionCoreT.) | |
IListItem |
Gets or sets the Object at the specified index.
(Inherited from CollectionCoreT.) | |
IXmlSerializableReadXml |
Constructs an object graph with this object as the root from the xml contained by the passed in XmlReader object.
| |
IListRemove |
Removes the first occurrence of a specific object from the IList.
(Inherited from CollectionCoreT.) | |
IListRemoveAt |
Removes the IListT item at the specified index.
(Inherited from CollectionCoreT.) | |
ICollectionSyncRoot |
Gets an object that can be used to synchronize access to the ICollection.
(Inherited from CollectionCoreT.) | |
IEntityCollection2Add |
Adds an IEntity2 object to the list.
| |
IEntityCollection2AddRange |
Adds the range of objects passed in. Objects have to be IEntity2 implementing objects
| |
IEntityCollection2Capacity |
Gets / sets the initial capacity of the entity collection.
| |
IEntityCollection2Contains |
Returns true if the list contains the given IEntity2 Object
| |
IEntityCollection2CopyTo |
copy the complete list of IEntity2 objects to an array of IEntity objects.
| |
IEntityCollection2CreateHierarchicalProjection(ListIViewProjectionData, DictionaryType, IEntityCollection2) |
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.
| |
IEntityCollection2CreateHierarchicalProjection(ListIViewProjectionData, DataSet) |
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.
| |
IEntityCollection2CreateView |
Creates a new EntityView2 object of the right type on this collection with no filter nor sorter applied.
| |
IEntityCollection2CreateView(IPredicate) |
Creates a new EntityView2 object of the right type on this collection with the passed in filter applied
| |
IEntityCollection2CreateView(IPredicate, ISortExpression) |
Creates a new EntityView2 object of the right type on this collection with the passed in filter and sorter applied to it.
| |
IEntityCollection2CreateView(IPredicate, ISortExpression, PostCollectionChangeAction) |
Creates a new EntityView2 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.
| |
IEntityCollection2DefaultView |
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.
| |
IEntityCollection2DirtyEntities |
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.
| |
IEntityCollection2IndexOf |
Returns index in the list of given IEntity2 object.
| |
IEntityCollection2Insert |
Inserts an IEntity2 on position Index
| |
IEntityCollection2Item |
Gets or sets the IEntity2 at the specified index.
| |
IEntityCollection2Remove |
Remove given IEntity2 instance from the list.
| |
IEntityCollectionCoreAdd |
Adds an IEntityCore object to the list.
(Inherited from CollectionCoreT.) | |
IEntityCollectionCoreClear |
Clears the collection
(Inherited from CollectionCoreT.) | |
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.
(Inherited from CollectionCoreT.) | |
IEntityCollectionCoreContains |
Returns true if the list contains the given entity
(Inherited from CollectionCoreT.) | |
IEntityCollectionCoreEntityFactoryToUse |
The EntityFactory to use when creating entity objects during fetch action or other logic which requires the creation of new entities.
(Inherited from CollectionCoreT.) | |
IEntityCollectionCoreFindMatches |
Gets all indices of all the entities in the current order of this collection which match the passed in filter.
(Inherited from CollectionCoreT.) | |
IEntityCollectionCoreIndexOf |
Returns index in the list of given entity.
(Inherited from CollectionCoreT.) | |
IEntityCollectionCoreInsert |
Inserts an IEntityCore on position Index
(Inherited from CollectionCoreT.) | |
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.
(Inherited from CollectionCoreT.) | |
IEntityCollectionCoreIsRemovalTracker |
Gets or sets a value indicating whether this instance is a removal tracker collection.
(Inherited from CollectionCoreT.) | |
IEntityCollectionCoreItem |
Simple indexer.
(Inherited from CollectionCoreT.) | |
IEntityCollectionCoreRemove |
Remove given IEntityCore instance from the list.
(Inherited from CollectionCoreT.) | |
IEntityCollectionCoreRemovedEntitiesTracker |
Gets or sets the removal tracker for this entity collection
(Inherited from CollectionCoreT.) | |
IOwnedDataSerializableDeserializeOwnedData |
Lets the implementing class retrieve internal data directly from a SerializationReader.
| |
IOwnedDataSerializableSerializeOwnedData |
Lets the implementing class store internal data directly into a SerializationWriter.
|