Back to Devexpress

XPObjectSource Members

xpo-devexpress-dot-xpo-dot-xpobjectsource-dot-underscore-members.md

latest12.8 KB
Original Source

XPObjectSource Members

Enables binding reports to XPO persistent class’ data.

Constructors

NameDescription
XPObjectSource()Initializes a new instance of the XPObjectSource class with the default settings.
XPObjectSource(IContainer)Initializes a new instance of the XPObjectSource class with a specified container.

Properties

NameDescription
Base64For internal use.
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
ConnectionStringSpecifies a connection string used to connect to a database.
ConnectionStringNameSpecifies the name of the connection string used to connect to a database. The specified name should exist in the application configuration file.
ConnectionStringsProviderFor internal use.
ContainerGets the IContainer that contains the Component. Inherited from Component.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
DictionaryFor internal use.
EntityTypeSpecifies metadata information for an XPO class mapped to the required data.
EntityTypeStringSpecifies the fully qualified name of an XPO class mapped to the required data.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
FilterSpecifies the criteria used to filter data.
FilterStringSpecifies the string criteria used to filter data.
GroupFilterSpecifies the CriteriaOperator containing grouped/aggregated columns.
GroupFilterStringSpecifies the string criteria containing grouped/aggregated columns.
NameInherited from DataComponentBase.
ParametersGets a list of parameters you can use in CriteriaOperators passed to the XPObjectSource.Filter, XPObjectSource.GroupFilter, XPObjectSource.Properties and XPObjectSource.Sorting properties.
PropertiesSpecifies the list of persistent class’ properties loaded by XPObjectSource. When the list is not emply, only the listed properties are loaded. Otherwise, XPObjectSource loads all properties of the class specified by XPObjectSource.EntityType.
SiteGets or sets the ISite of the Component. Inherited from Component.
SkipReturnedRecordsSpecifies the number of records to exclude when loading data.
SortingSpecifies the data sorting within the XPObjectSource.
TagSpecifies the data associated with the XPObjectSource object. This data is passed to the XPObjectSource.ResolveSession and XPObjectSource.DismissSession events.
TopReturnedRecordsSpecifies the maximum number of retrieved records.

Methods

NameDescription
Dispose()Releases all resources used by the Component. Inherited from Component.
Equals(Object, Object) staticDetermines 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.
Fill()Retrieves the data from the data source and populates the internal objects collection.
Fill(IEnumerable<IParameter>)Retrieves the data from the data source and populates the internal objects collection using the specified parameters.
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)Inherited from DataComponentBase.
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.
LoadFromXml(XElement)For internal use.
MemberwiseClone() protectedCreates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protectedCreates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
PopulateProperties()Clears the XPObjectSource.Properties collection and populates it with properties of the persistent class specified by the XPObjectSource.EntityType property.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
Reset(Boolean)Triggers the IBindingList.ListChanged event.
SaveToXml()For internal use.
SetEntityType(Type)Gets the XPClassInfo object corresponding to the specified type and assigns this object to the XPObjectSource.EntityType property.
ToString()Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.

Events

NameDescription
AfterFillFor internal use.
BeforeFillFor internal use.
DismissSessionOccurs when the XPObjectSource no longer needs the Session it used to retrieve objects from the data store.
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
ResolveSessionOccurs when the XPObjectSource needs a Session to retrieve objects from the data store.

See Also

XPObjectSource Class

DevExpress.Xpo Namespace