CompositeEntityCollection
Non-destructively composites multiple EntityCollection instances into a single collection. If a Entity with the same ID exists in multiple collections, it is non-destructively merged into a single new entity instance. If an entity has the same property in multiple collections, the property of the Entity in the last collection of the list it belongs to is used. CompositeEntityCollection can be used almost anywhere that a EntityCollection is used.
Parameters
The initial list of EntityCollection instances to merge.
The data source (or composite entity collection) which created this collection.
See also
Constructors
Properties
Gets the event that is fired when entities are added or removed from the collection. The generated event is a EntityCollection.collectionChangedEventCallback.
Gets the array of Entity instances in the collection. This array should not be modified directly.
Functions
Adds a collection to the composite.
Computes the maximum availability of the entities in the collection. If the collection contains a mix of infinitely available data and non-infinite data, It will return the interval pertaining to the non-infinite data only. If all data is infinite, an infinite interval will be returned.
Checks to see if the composite contains a given collection.
Gets a collection by index from the composite.
Gets the number of collections in this composite.
Determines the index of a given collection in the composite.
Lowers a collection down one position in the composite.
Lowers a collection to the bottom of the composite.
Raises a collection up one position in the composite.
Raises a collection to the top of the composite.
Removes all collections from this composite.
Removes a collection from this composite, if present.
Resumes raising EntityCollection.collectionChanged events immediately when an item is added or removed. Any modifications made while while events were suspended will be triggered as a single event when this function is called. This function also ensures the collection is recomposited if events are also resumed. This function is reference counted and can safely be called multiple times as long as there are corresponding calls to EntityCollection.resumeEvents.
Prevents EntityCollection.collectionChanged events from being raised until a corresponding call is made to EntityCollection.resumeEvents, at which point a single event will be raised that covers all suspended operations. This allows for many items to be added and removed efficiently. While events are suspended, recompositing of the collections will also be suspended, as this can be a costly operation. This function can be safely called multiple times as long as there are corresponding calls to EntityCollection.resumeEvents.