CollectionSource Members
The Collection Source used for the List Views that display collections of business objects.Constructors
| Name | Description |
|---|---|
| CollectionSource(IObjectSpace, Type, CollectionSourceDataAccessMode, CollectionSourceMode) | Initializes a new instance of the CollectionSource. |
| CollectionSource(IObjectSpace, Type, CollectionSourceDataAccessMode) | Initializes a new instance of the CollectionSource. |
| CollectionSource(IObjectSpace, Type, Boolean, CollectionSourceMode) | Initializes a new instance of the CollectionSource. |
| CollectionSource(IObjectSpace, Type, Boolean) | Initializes a new instance of the CollectionSource. |
| CollectionSource(IObjectSpace, Type) | Creates and initializes an instance of the CollectionSource class with the specified parameters. |
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. Inherited from CollectionSourceBase. |
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. Inherited from CollectionSourceBase. |
| AllowRemove | Returns the value that indicates whether it is possible to remove objects from the Collection Source’s CollectionSourceBase.Collection or not. Inherited from CollectionSourceBase. |
| CanApplyCriteria | |
| CanApplySorting | Specifies whether or not sorting options are applied from the application model. Inherited from CollectionSourceBase. |
| Collection | Provides access to the Collection Source’s (see CollectionSourceBase) collection of objects. Inherited from CollectionSourceBase. |
| Criteria | Provides access to the Collection Source’s CriteriaOperator dictionary that define the way in which the Collection Source’s CollectionSourceBase.Collection is filtered. Inherited from CollectionSourceBase. |
| DataAccessMode | Gets the mode used to access the CollectionSourceBase‘s collection. Inherited from CollectionSourceBase. |
| DeleteObjectOnRemove | Gets or sets whether persistent objects are deleted from the data store when they are removed from the CollectionSourceBase.Collection. Inherited from CollectionSourceBase. |
| DisplayableProperties | Provides access to the semicolon-delimited list of the CollectionSourceBase.Collection‘s Property Descriptors and/or expressions. Inherited from CollectionSourceBase. |
| IsAsyncServerMode | This property is intended for internal use. |
| IsCollectionReloading | Inherited from CollectionSourceBase. |
| IsCollectionResetting | Gets a value indicating whether or not the CollectionSourceBase.Collection is currently being reinitialized. Inherited from CollectionSourceBase. |
| IsCriteriaApplying | Inherited from CollectionSourceBase. |
| IsCriteriaLocked | For internal use. Inherited from CollectionSourceBase. |
| IsLoaded | Indicates whether the Collection Source’s collection has been instantiated. Inherited from CollectionSourceBase. |
| IsServerMode | For internal use. Use the CollectionSourceBase.DataAccessMode property instead. Inherited from CollectionSourceBase. |
| List | Returns a list of objects contained in the Collection Source’s Collection. Inherited from CollectionSourceBase. |
| Mode | Indicates the Collection Source’s mode of operation. Inherited from CollectionSourceBase. |
| ObjectSpace | Provides access to the Object Space used by the Collection Source to interact with the database. Inherited from CollectionSourceBase. |
| ObjectTypeInfo | Provides metadata information on the type of the objects contained in the CollectionSource‘s collection. |
| Sorting | Specifies the CollectionSourceBase.Collection‘s sort settings. Inherited from CollectionSourceBase. |
| TopReturnedObjects | Specifies the number of objects that can be retrieved by the Collection Source’s CollectionSourceBase.Collection from the database. Inherited from CollectionSourceBase. |
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. Inherited from CollectionSourceBase. |
| Dispose() | Releases all the resources allocated by the current Collection Source. Inherited from CollectionSourceBase. |
| EndUpdateCriteria() | Ends update of the Collection Source’s collection criteria and applies it. Inherited from CollectionSourceBase. |
| 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. Inherited from CollectionSourceBase. |
| GetEnumerable(Boolean) | Returns a sequence (IEnumerable or IQueryable) that contains objects from the original collection. Inherited from CollectionSourceBase. |
| GetEnumerable<T>(Boolean) | Returns a strongly-typed sequence (IEnumerable<T> or IQueryable<T>) that contains objects from the original collection. Inherited from CollectionSourceBase. |
| 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. Inherited from CollectionSourceBase. |
| Remove(Object) | Removes the specified object from the Collection Source’s CollectionSourceBase.Collection. |
| ResetCollection(Boolean) | Recreates a Collection Source’s CollectionSourceBase.Collection. Inherited from CollectionSourceBase. |
| SetAllowAdd(Boolean) | Sets the value that specifies whether it is possible to add objects to the Collection Source’s CollectionSourceBase.Collection or not. Inherited from CollectionSourceBase. |
| SetAllowRemove(Boolean) | Sets the value that specifies whether it is possible to remove objects from the Collection Source’s CollectionSourceBase.Collection or not. Inherited from CollectionSourceBase. |
| SetCriteria(String, String) | Adds the specified criteria expression to the CollectionSourceBase.Criteria dictionary. Inherited from CollectionSourceBase. |
| 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. Inherited from CollectionSourceBase. |
| CollectionChanging | Occurs before the Collection Source’s collection has been recreated. Inherited from CollectionSourceBase. |
| CollectionReloaded | Occurs after the Collection Source’s CollectionSourceBase.Collection has been reloaded. Inherited from CollectionSourceBase. |
| CollectionReloading | Occurs before the Collection Source’s CollectionSourceBase.Collection has been reloaded. Inherited from CollectionSourceBase. |
| CriteriaApplied | Occurs after the Collection Source’s collection has been filtered using the CriteriaOperator objects contained in the CollectionSourceBase.Criteria dictionary. Inherited from CollectionSourceBase. |
| CriteriaApplying | Occurs before the Collection Source’s collection has been filtered using the CriteriaOperator objects contained in the CollectionSourceBase.Criteria dictionary. Inherited from CollectionSourceBase. |
| Disposed | Occurs after a Collection Source has been disposed of. Inherited from CollectionSourceBase. |
See Also