Skip to main content
.NET Framework 4.5.2+

XPServerCollectionSource Members

The data source for a GridControl and GridLookUpEdit controls that binds these controls to data in Server Mode.

Constructors

Name Description
XPServerCollectionSource() Initializes a new instance of the XPServerCollectionSource class with the default settings.
XPServerCollectionSource(Session, XPClassInfo, CriteriaOperator) Initializes a new instance of the XPServerCollectionSource class with a given Session, object type and filter criteria.
XPServerCollectionSource(Session, XPClassInfo) Initializes a new instance of the XPServerCollectionSource class with a given Session and object type.
XPServerCollectionSource(Session, Type, CriteriaOperator) Initializes a new instance of the XPServerCollectionSource class with a given Session, object type and filter criteria.
XPServerCollectionSource(Session, Type) Initializes a new instance of the XPServerCollectionSource class with a given Session and object type.
XPServerCollectionSource(IContainer) Initializes a new instance of the XPServerCollectionSource class and adds it to a form’s container.

Properties

Name Description
AllowEdit Gets or sets whether data editing is allowed.
AllowNew Gets or sets whether new items can be added to a collection by a bound control.
AllowRemove Gets or sets whether items can be removed from a collection by a bound control.
CanRaiseEvents protected Gets a value indicating whether the component can raise an event. Inherited from Component.
Container Gets the IContainer that contains the Component. Inherited from Component.
DefaultSorting Specifies how data source contents are sorted by default, when sort order is not specified by the bound control.
DeleteObjectOnRemove Gets or sets whether the persistent object is deleted from the data store when it is removed from the collection.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DisplayableProperties Gets or sets properties that are available for binding in a bound data-aware control at design time.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
FixedFilterCriteria Gets or sets the criteria used to filter objects on the data store side. These criteria are never affected by the data-aware control that is bound to the current XPServerCollectionSource object.
FixedFilterString Gets or sets an expression in a string format, used to filter objects on the data store side. This filter is never affected by the data-aware control that is bound to the current XPServerCollectionSource object.
ObjectClassInfo Gets a XPClassInfo object that describes the target data table in the data store.
ObjectType Gets the type of the object that describes the target data table in the data store.
Session Gets or sets the Session used by the current XPServerCollectionSource object.
Site Gets or sets the ISite of the Component. Inherited from Component.
TrackChanges Gets or sets whether the XPServerCollectionSource tracks item changes.

Methods

Name Description
Dispose() Releases all resources used by the Component. Inherited from Component.
Dispose(Boolean) protected Releases the unmanaged resources used by the Component and optionally releases the managed resources. Inherited from Component.
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.
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.
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.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
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.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
Reload() Forces the bound data-aware control to reload data from the data store.
ToString() Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.

Events

Name Description
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
ResolveSession Enables the XPServerCollectionSource to be associated with a session.
ServerExceptionThrown Fires when a data server throws an exception.
See Also