.NET Framework 4.5.2+
.NET Framework 4.5.2+
.NET Standard 2.0+

XPCollection Members

The collection of persistent objects that implements delayed loading and can serve as a data source for a data-aware control.

Constructors

Name Description
XPCollection() Initializes a new instance of the XPCollection class with the default Session.
XPCollection(PersistentCriteriaEvaluationBehavior, Session, XPClassInfo, CriteriaOperator) Initializes a new instance of the XPCollection class with specified settings.
XPCollection(PersistentCriteriaEvaluationBehavior, Session, XPClassInfo, CriteriaOperator, Boolean) Initializes a new instance of the XPCollection class with specified settings.
XPCollection(PersistentCriteriaEvaluationBehavior, Session, Type, CriteriaOperator) Initializes a new instance of the XPCollection class with specified settings.
XPCollection(Session, XPClassInfo) Initializes a new instance of the XPCollection class with specified settings.
XPCollection(Session, XPClassInfo, CriteriaOperator, SortProperty[]) Initializes a new instance of the XPCollection class with a specified Session and criteria-specific options.
XPCollection(Session, XPClassInfo, Boolean) Initializes a new instance of the XPCollection class with specified settings.
XPCollection(Session, XPClassInfo, IEnumerable) Initializes a new instance of the XPCollection class by copying objects from a specific collection using specified settings.
XPCollection(Session, XPClassInfo, IEnumerable, CriteriaOperator) Initializes a new instance of the XPCollection class by copying objects from a specific collection using specified settings.
XPCollection(Session, XPClassInfo, IEnumerable, CriteriaOperator, Boolean) Initializes a new instance of the XPCollection class by copying objects from a specific collection using specified settings.
XPCollection(Session, XPBaseCollection) Initializes a new instance of the XPCollection class by copying objects from a specific collection using specified settings.
XPCollection(Session, XPBaseCollection, CriteriaOperator) Initializes a new instance of the XPCollection class by copying objects from a specific collection using specified settings.
XPCollection(Session, XPBaseCollection, CriteriaOperator, Boolean) Initializes a new instance of the XPCollection class by copying objects from a specific collection using specified settings.
XPCollection(Session, Object, XPMemberInfo) Initializes a new instance of the XPCollection class with specified settings.
XPCollection(Session, Type) Initializes a new instance of the XPCollection class with specified settings.
XPCollection(Session, Type, CriteriaOperator, SortProperty[]) Initializes a new instance of the XPCollection class with a specified Session and criteria-specific options.
XPCollection(Session, Type, Boolean) Initializes a new instance of the XPCollection class with specified settings.
XPCollection(XPBaseCollection) Initializes a new instance of the XPCollection class by copying objects from a specified collection.
XPCollection(XPBaseCollection, CriteriaOperator) Initializes a new instance of the XPCollection class by copying objects from a specific collection using specified settings.
XPCollection(XPBaseCollection, CriteriaOperator, Boolean) Initializes a new instance of the XPCollection class by copying objects from a specific collection using specified settings.
XPCollection(IContainer) Initializes a new instance of the XPCollection class and adds it to a form’s container.
XPCollection(Type) Initializes a new instance of the XPCollection class with the default Session and object type.
XPCollection(Type, CriteriaOperator, SortProperty[]) Initializes a new instance of the XPCollection class with default Session and criteria-specific options.

Properties

Name Description
BindingBehavior

Defines which operations a bound control can perform on a collection.

This enumeration has a FlagsAttribute that allows a bitwise combination of its member values.

Inherited from XPBaseCollection.
CanRaiseEvents protected Gets a value indicating whether the component can raise an event. Inherited from Component.
CaseSensitive Gets or sets whether string comparisons during sorting and filtering of the XPBaseCollection are case-sensitive. Inherited from XPBaseCollection.
ClearCount For internal use. Inherited from XPBaseCollection.
Container Gets the IContainer that contains the Component. Inherited from Component.
Count Gets the number of elements contained in the XPBaseCollection instance. Inherited from XPBaseCollection.
Criteria Gets or sets the criteria used to filter objects on the data store side. Inherited from XPBaseCollection.
CriteriaString Gets or sets the criteria used to filter objects on the data store side. Inherited from XPBaseCollection.
DeleteObjectOnRemove Gets or sets whether the persistent object is deleted from the data store when it is removed from the collection. Inherited from XPBaseCollection.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DisplayableProperties Gets or sets the displayable properties list for a bound control. Inherited from XPBaseCollection.
EnableObjectChangedNotificationsWhileEditing static Obsolete. Specifies whether object changed notifications occur when editing a property. Inherited from XPBaseCollection.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
Filter Gets or sets the criteria used to filter objects on the client side. Inherited from XPBaseCollection.
HintCollection This member supports the .NET Framework infrastructure and cannot be used directly from your code. Inherited from XPBaseCollection.
IsAsyncLoading For internal use. Inherited from XPBaseCollection.
IsLoaded Gets whether the XPBaseCollection collection is loaded with objects from the data store. Inherited from XPBaseCollection.
LoadingEnabled Gets or sets whether loading of data from a data store to the collection is enabled. Inherited from XPBaseCollection.
Object[Int32] Gets the object at the specified index.
ObjectClassInfo Gets or sets the metadata information that describes the type of objects stored in the current collection.
ObjectType This member supports the XPO Framework infrastructure and is not intended to be used directly from your code.
SelectDeleted Gets or sets whether objects that are marked as deleted are retrieved by a collection from a data store. Inherited from XPBaseCollection.
Session Gets or sets the Session used by the current collection. Inherited from XPBaseCollection.
Site Gets or sets the ISite of the Component. Inherited from Component.
SkipReturnedObjects Gets or sets the number of objects to exclude when populating the collection with objects from a data store. Inherited from XPBaseCollection.
Sorting Gets or sets the sort settings for the current collection. Inherited from XPBaseCollection.
TopReturnedObjects Gets or sets the maximum number of objects retrieved by the collection from a data store. Inherited from XPBaseCollection.

Methods

Name Description
Add(Object) Adds the specified persistent object to the XPCollection.
AddRange(ICollection) Adds each element from a specified collection of persistent objects to the XPCollection.
BaseAdd(Object) Adds the specified persistent object to the XPBaseCollection. Inherited from XPBaseCollection.
BaseAddRange(ICollection) Adds each element from a specified collection of persistent objects to the XPBaseCollection. Inherited from XPBaseCollection.
BaseIndexer(Int32) Gets the object at the specified index. Inherited from XPBaseCollection.
BaseIndexOf(Object) Determines the index of the specified object in the XPBaseCollection. Inherited from XPBaseCollection.
BaseRemove(Object) Removes the specified persistent object from the XPBaseCollection. Inherited from XPBaseCollection.
BaseRemoveAsync(Object, CancellationToken) Asynchronously removes the specified persistent object from the XPBaseCollection. Inherited from XPBaseCollection.
BeginLoad() Starts the loading process. Inherited from XPBaseCollection.
BeginLoad(Boolean) Starts the loading process. Inherited from XPBaseCollection.
BeginLoadAsync(Boolean, CancellationToken) Inherited from XPBaseCollection.
BeginLoadAsync(CancellationToken) Inherited from XPBaseCollection.
CreateObjRef(Type) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
Dispose() Releases all resources used by the Component. Inherited from Component.
EndLoad(IEnumerable) Ends the loading process. Inherited from XPBaseCollection.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
EvaluateDatastoreCount() Specifies the number of elements that will be contained in the collection after loading it. Inherited from XPBaseCollection.
GetDefaultDisplayableProperties(XPClassInfo) static Returns the default value for the XPBaseCollection.DisplayableProperties property for the specified object type. Inherited from XPBaseCollection.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetLifetimeService() Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetObjectClassInfo() Gets the metadata information for the persistent objects contained in the collection.
GetRealFetchClassInfo() This method is intended for internal use. Inherited from XPBaseCollection.
GetRealFetchCriteria() This method is intended for internal use. Inherited from XPBaseCollection.
GetService(Type) protected Returns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetType() Gets the Type of the current instance. Inherited from Object.
IndexOf(Object) Returns the index of the specified object in the XPCollection.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
Load() Loads persistent objects of a specific type from the data store into the collection. Inherited from XPBaseCollection.
LoadAsync() Asynchronously loads persistent objects of a specific type from the data store into the collection. Inherited from XPBaseCollection.
LoadAsync(AsyncLoadObjectsCallback) Asynchronously loads persistent objects of a specific type from the data store into the collection, and notifies upon completion. Inherited from XPBaseCollection.
LoadAsync(CancellationToken) Asynchronously loads persistent objects of a specific type from the data store into the collection. Inherited from XPBaseCollection.
Lookup(Object) Retrieves an object from the collection by object ID.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protected Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
PreFetch(String[]) Enforces loading data for associated collections and delayed properties. Inherited from XPBaseCollection.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Reload() Clears the collection and marks it to be reloaded with data from the data store. Inherited from XPBaseCollection.
Remove(Object) Removes the specified object from the XPCollection.
ResumeChangedEvents() Resumes the immediate update of the collection after it was suspended using the XPBaseCollection.SuspendChangedEvents method. Inherited from XPBaseCollection.
SuspendChangedEvents() Prevents the immediate update of the collection when objects are added/removed and filtering/sorting is changed until the XPBaseCollection.ResumeChangedEvents method is called. Inherited from XPBaseCollection.
ToString() Returns a string that represents the current XPCollection. Inherited from XPBaseCollection.

Events

Name Description
CollectionChanged Occurs when an item is added to, or removed from the XPBaseCollection (when the XPBaseCollection.BaseAdd or XPBaseCollection.BaseRemove method is called). Inherited from XPBaseCollection.
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
ListChanged Occurs when the list or an item in the list of the XPBaseCollection collection is changed. Inherited from XPBaseCollection.
ResolveSession Enables the collection to be associated with a session. Inherited from XPBaseCollection.
See Also