Skip to main content
.NET Framework 4.5.2+

CollectionSourceBase Members

An abstract class that serves as the base class for Collection Source classes.

Fields

Name Description
EmptyCollectionCriteria static Returns a CriteriaOperator that represents a criterion that can never be satisfied. If you add this Criteria Operator to a Collection Source’s CollectionSourceBase.Criteria dictionary, the Collection Source’s CollectionSourceBase.Collection will contain no objects at all.

Properties

Name Description
AllowAdd Returns the value that indicates whether it is possible to add objects to the Collection Source’s CollectionSourceBase.Collection or not.
AllowRemove Returns the value that indicates whether it is possible to remove objects from the Collection Source’s CollectionSourceBase.Collection or not.
CanApplyCriteria Returns the value that indicates whether the Collection Source’s CollectionSourceBase.Collection can be filtered.
CanApplySorting Specifies whether or not sorting options are applied from the application model.
Collection Provides access to the Collection Source’s (see CollectionSourceBase) collection of objects.
Criteria Provides access to the Collection Source’s CriteriaOperator dictionary that define the way in which the Collection Source’s CollectionSourceBase.Collection is filtered.
DataAccessMode Gets the mode used to access the CollectionSourceBase‘s collection.
DeleteObjectOnRemove Gets or sets whether persistent objects are deleted from the data store when they are removed from the CollectionSourceBase.Collection.
DisplayableProperties Provides access to the semicolon-delimited list of the CollectionSourceBase.Collection‘s Property Descriptors and/or expressions.
IsCollectionReloading
IsCollectionResetting Gets a value indicating whether or not the CollectionSourceBase.Collection is currently being reinitialized.
IsCriteriaApplying
IsCriteriaLocked For internal use.
IsLoaded Indicates whether the Collection Source’s collection has been instantiated.
IsServerMode For internal use. Use the CollectionSourceBase.DataAccessMode property instead.
List Returns a list of objects contained in the Collection Source’s Collection.
Mode Indicates the Collection Source’s mode of operation.
ObjectSpace Provides access to the Object Space used by the Collection Source to interact with the database.
ObjectTypeInfo Provides metadata information on the type of the objects contained in the Collection Source’s CollectionSourceBase.Collection.
Sorting Specifies the CollectionSourceBase.Collection‘s sort settings.
TopReturnedObjects Specifies the number of objects that can be retrieved by the Collection Source’s CollectionSourceBase.Collection from the database.

Methods

Name Description
Add(Object) Adds the specified object to the Collection Source’s CollectionSourceBase.Collection.
BeginUpdateCriteria() Begins update of the Collection Source’s collection criteria. The criteria will not be applied to the collection until the update is complete.
Dispose() Releases all the resources allocated by the current Collection Source.
EndUpdateCriteria() Ends update of the Collection Source’s collection criteria and applies it.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
GetCount() Returns the number of objects contained in the Collection Source’s CollectionSourceBase.Collection.
GetEnumerable(Boolean) Returns a sequence (IEnumerable or IQueryable) that contains objects from the original collection.
GetEnumerable<T>(Boolean) Returns a strongly-typed sequence (IEnumerable<T> or IQueryable<T>) that contains objects from the original collection.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetTotalCriteria() For internal use.
GetType() Gets the Type of the current instance. Inherited from Object.
IsObjectFitForCollection(Object) Tries to determine whether the specified object satisfies the criteria contained in the CollectionSourceBase.Criteria dictionary.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Reload() Reloads the current Collection Source’s CollectionSourceBase.Collection.
Remove(Object) Removes the specified object from the Collection Source’s CollectionSourceBase.Collection.
ResetCollection(Boolean) Recreates a Collection Source’s CollectionSourceBase.Collection.
SetAllowAdd(Boolean) Sets the value that specifies whether it is possible to add objects to the Collection Source’s CollectionSourceBase.Collection or not.
SetAllowRemove(Boolean) Sets the value that specifies whether it is possible to remove objects from the Collection Source’s CollectionSourceBase.Collection or not.
SetCriteria(String, String) Adds the specified criteria expression to the CollectionSourceBase.Criteria dictionary.
ToString() Returns a string that represents the current object. Inherited from Object.

Events

Name Description
CollectionChanged Occurs after the Collection Source’s collection has been recreated.
CollectionChanging Occurs before the Collection Source’s collection has been recreated.
CollectionReloaded Occurs after the Collection Source’s CollectionSourceBase.Collection has been reloaded.
CollectionReloading Occurs before the Collection Source’s CollectionSourceBase.Collection has been reloaded.
CriteriaApplied Occurs after the Collection Source’s collection has been filtered using the CriteriaOperator objects contained in the CollectionSourceBase.Criteria dictionary.
CriteriaApplying Occurs before the Collection Source’s collection has been filtered using the CriteriaOperator objects contained in the CollectionSourceBase.Criteria dictionary.
Disposed Occurs after a Collection Source has been disposed of.
See Also