Back to Devexpress

XPView Members

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

latest15.5 KB
Original Source

XPView Members

The view that stores data retrieved from persistent objects.

Constructors

NameDescription
XPView()Initializes a new instance of the XPView class with the default settings.
XPView(Session, XPClassInfo, CriteriaOperatorCollection, CriteriaOperator, CriteriaOperator)Initializes a new instance of the XPView class with the specified settings.
XPView(Session, XPClassInfo, CriteriaOperatorCollection, CriteriaOperator)Initializes a new instance of the XPView class with the specified settings.
XPView(Session, XPClassInfo, String, CriteriaOperator)Initializes a new instance of the XPView class with the specified settings.
XPView(Session, XPClassInfo)Initializes a new instance of the XPView class with the specified XPView.Session and XPView.ObjectClassInfo properties.
XPView(Session, Type, CriteriaOperatorCollection, CriteriaOperator)Initializes a new instance of the XPView class with the specified settings.
XPView(Session, Type, String, CriteriaOperator)Initializes a new instance of the XPView class with the specified settings.
XPView(Session, Type)Initializes a new instance of the XPView class with the specified session and type of persistent objects to include in the view.
XPView(IContainer)Initializes a new instance of the XPView class and adds it to a form’s container.

Properties

NameDescription
CanRaiseEvents protectedGets a value indicating whether the component can raise an event. Inherited from Component.
CaseSensitiveGets or sets whether string comparisons evaluated by the XPView on the client are case-sensitive.
ContainerGets the IContainer that contains the Component. Inherited from Component.
CountGets the number of records within the view.
CriteriaGets or sets the criteria associated with the view.
CriteriaStringGets or sets the criteria used to filter objects while the view is being loaded.
DesignMode protectedGets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Events protectedGets the list of event handlers that are attached to this Component. Inherited from Component.
FilterGets or sets the expression used to filter the rows displayed in the view (on the client side).
GroupCriteriaGets or sets the grouping criteria which is associated with the view.
GroupCriteriaStringGets or sets the grouping criteria which is associated with the view.
Item[Int32]Provides indexed access to individual records within the view.
ObjectClassInfoGets the metadata information for the persistent objects retrieved by the view.
ObjectTypeGets the type of the class whose metadata is provided by the XPView.ObjectClassInfo property.
PropertiesGets a collection of ViewProperty objects that represent view columns.
SelectDeletedSpecifies whether objects marked as deleted are retrieved by the XPView.
SessionGets or sets the session which is used to load and save persistent objects.
SiteGets or sets the ISite of the Component. Inherited from Component.
SkipReturnedRecordsGets or sets the number of records to exclude when populating the view.
SortingProvides access to the collection whose elements identify the sorted columns within the view.
TopReturnedRecordsGets or sets the maximum number of records retrieved by the view.

Methods

NameDescription
AddProperty(CriteriaOperator)Creates a new ViewProperty object and appends it to the XPView.Properties collection.
AddProperty(String, CriteriaOperator, Boolean, Boolean, SortDirection)Creates a new ViewProperty object with the specified settings and appends it to the XPView.Properties collection.
AddProperty(String, CriteriaOperator, Boolean)Creates a new ViewProperty object with the specified expression and appends it to the XPView.Properties collection.
AddProperty(String, CriteriaOperator)Creates a new ViewProperty object with the specified expression and appends it to the XPView.Properties collection.
AddProperty(String, String, Boolean, Boolean, SortDirection)Creates a new ViewProperty object with the specified settings and appends it to the XPView.Properties collection.
AddProperty(String, String, Boolean)Creates a new ViewProperty object with the specified expression and appends it to the XPView.Properties collection.
AddProperty(String, String)Creates a new ViewProperty object with the specified expression and appends it to the XPView.Properties collection.
AddProperty(String)Creates a new ViewProperty object with the specified name and appends it to the XPView.Properties collection.
Dispose()Releases all resources used by the Component. Inherited from Component.
Dispose(Boolean) protectedReleases the unmanaged resources used by the Component and optionally releases the managed resources. 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.
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) protectedReturns 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.
LoadAsync()Asynchronously loads data from the data store into the view.
LoadAsync(AsyncLoadObjectsCallback)Asynchronously loads data from the data store into the view, and notifies upon completion.
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.
ReferenceEquals(Object, Object) staticDetermines whether the specified Object instances are the same instance. Inherited from Object.
Reload()Clears the view and marks it to be reloaded with 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

NameDescription
DisposedOccurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
ListChangedOccurs when the view’s settings are changed.
ResolveSessionEnables the view to be associated with a session.

See Also

XPView Class

DevExpress.Xpo Namespace