Table of Contents

Class XPServerModeView

Namespace
DevExpress.Xpo
Assembly
DevExpress.Xpo.v24.1.dll

A data source that binds DevExpress grid controls with data tables and allows retrieving data from the server side.

public class XPServerModeView : Component, IComponent, IDisposable, ISupportInitializeNotification, ISupportInitialize, IListSource, IXPClassInfoAndSessionProvider, IXPClassInfoProvider, ISessionProvider, IObjectLayerProvider, IDataLayerProvider, IXPDictionaryProvider, IColumnsServerActions, IDXCloneable
Inheritance
XPServerModeView
Implements
IColumnsServerActions
IDXCloneable
Inherited Members

Constructors

XPServerModeView()

Initializes a new XPServerModeView instance.

public XPServerModeView()

XPServerModeView(Session, XPClassInfo)

Uses a Session and object type metadata to initialize a new XPServerModeView instance.

public XPServerModeView(Session session, XPClassInfo objectClassInfo)

Parameters

session Session

The session used to load persistent objects. This value is assigned to the Session property.

objectClassInfo XPClassInfo

The XPClassInfo metadata that describes the target data table in the data store.

XPServerModeView(Session, XPClassInfo, CriteriaOperator)

Uses a Session, object type metadata, and filter criteria to initialize a new XPServerModeView instance.

public XPServerModeView(Session session, XPClassInfo objectClassInfo, CriteriaOperator fixedFilterCriteria)

Parameters

session Session

The session used to load persistent objects. This value is assigned to the Session property.

objectClassInfo XPClassInfo

The XPClassInfo metadata that describes the target data table in the data store.

fixedFilterCriteria CriteriaOperator

An expression that calculates values to be displayed in a data table. The expression is assigned to the Properties property.

XPServerModeView(Session, Type)

Uses a Session and object type to initialize a new XPServerModeView instance.

public XPServerModeView(Session session, Type objectType)

Parameters

session Session

The session used to load persistent objects. This value is assigned to the Session property.

objectType Type

A persistent type. This value is assigned to the ObjectType property and indirectly assigned to the ObjectClassInfo property.

XPServerModeView(Session, Type, CriteriaOperator)

Uses a Session, an object type and filter criteria to initialize a new XPServerModeView instance.

public XPServerModeView(Session session, Type objectType, CriteriaOperator fixedFilterCriteria)

Parameters

session Session

The session used to load persistent objects. This value is assigned to the Session property.

objectType Type

A persistent type. This value is assigned to the ObjectType property and indirectly assigned to the ObjectClassInfo property.

fixedFilterCriteria CriteriaOperator

An expression that calculates values to be displayed in a data table. The expression is assigned to the Properties property.

XPServerModeView(IContainer)

Initializes a new XPServerModeView instance and adds it to a container.

public XPServerModeView(IContainer container)

Parameters

container IContainer

A container that is the owner of the created XPServerModeView.

Fields

IsInit 

protected bool IsInit

Field Value

bool

Properties

FixedFilterCriteria

Specifies the criteria used to filter items on the data store side. Bound data-aware controls never affect the criteria.

[TypeConverter("DevExpress.Xpo.Design.CriteriaConverter, DevExpress.Xpo.v24.1.Design, Version=24.1.4.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a")]
public CriteriaOperator FixedFilterCriteria { get; set; }

Property Value

CriteriaOperator

An expression that filters items on the data store side.

FixedFilterString

Specifies a string that contains the criteria used to filter items on the data store side. Bound data-aware controls never affect the criteria.

[Browsable(false)]
public string FixedFilterString { get; set; }

Property Value

string

A string that represents a filter expression. The expression contains criteria to filter items on the data store side.

IsDesignMode 

protected bool IsDesignMode { get; }

Property Value

bool

ObjectClassInfo

Gets or sets the XPClassInfo that describes the type of items the target data table contains.

[TypeConverter("DevExpress.Xpo.Design.ObjectClassInfoTypeConverter, DevExpress.Xpo.v24.1.Design, Version=24.1.4.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a")]
public XPClassInfo ObjectClassInfo { get; set; }

Property Value

XPClassInfo

Metadata that relates to the type of items the target data table contains.

ObjectType

Gets or sets the type of items the target data table contains.

[Browsable(false)]
public Type ObjectType { get; set; }

Property Value

Type

The type of items the data source contains.

Properties

Gets a ServerViewPropertiesCollection object that contains information on a persistent type’s property names, criteria, and sort order.

public ServerViewPropertiesCollection Properties { get; }

Property Value

ServerViewPropertiesCollection

A ServerViewProperty object collection that contains information on a persistent type’s property names, criteria, and sort order.

Session

Gets or sets a session used to load persistent objects.

[TypeConverter("DevExpress.Xpo.Design.SessionReferenceConverter, DevExpress.Xpo.v24.1.Design, Version=24.1.4.0, Culture=neutral, PublicKeyToken=b88d1754d700e49a")]
public Session Session { get; set; }

Property Value

Session

The session used to load persistent objects.

Methods

AddProperty(CriteriaOperator)

Creates a new ServerViewProperty object and appends it to the Properties collection.

public ServerViewProperty AddProperty(CriteriaOperator property)

Parameters

property CriteriaOperator

The expression used to calculate values in a column on the data store side.

Returns

ServerViewProperty

The ServerViewProperty object that was added to the Properties collection.

AddProperty(string)

Creates a new ServerViewProperty object and appends it to the Properties collection.

public ServerViewProperty AddProperty(string property)

Parameters

property string

A string value that specifies the expression used to calculate values in a column on the data store side. This value is assigned to the Property property.

Returns

ServerViewProperty

The ServerViewProperty object that was added to the Properties collection.

AddProperty(string, CriteriaOperator)

Creates a new ServerViewProperty object and appends it to the Properties collection.

public ServerViewProperty AddProperty(string name, CriteriaOperator property)

Parameters

name string

A string value that specifies the property name. This value is assigned to the Name property.

property CriteriaOperator

The expression used to calculate values in a column on the data store side.

Returns

ServerViewProperty

The ServerViewProperty object that was added to the Properties collection.

AddProperty(string, CriteriaOperator, SortDirection)

Creates a new ServerViewProperty object and appends it to the Properties collection.

public ServerViewProperty AddProperty(string name, CriteriaOperator property, SortDirection sorting)

Parameters

name string

A string value that specifies the property name. This value is assigned to the Name property.

property CriteriaOperator

The expression used to calculate values in a column on the data store side.

sorting SortDirection

A SortDirection enumeration value that specifies a sort order for property values to be retrieved from the data store. This value is assigned to the Sorting property.

Returns

ServerViewProperty

The ServerViewProperty object that was added to the Properties collection.

AddProperty(string, string)

Creates a new ServerViewProperty object and appends it to the Properties collection.

public ServerViewProperty AddProperty(string name, string property)

Parameters

name string

A string value that specifies the property name. This value is assigned to the Name property.

property string

A string value that specifies the expression used to calculate values in a column on the data store side. This value is assigned to the Property property.

Returns

ServerViewProperty

The ServerViewProperty object that was added to the Properties collection.

AddProperty(string, string, SortDirection)

Creates a new ServerViewProperty object and appends it to the Properties collection.

public ServerViewProperty AddProperty(string name, string property, SortDirection sorting)

Parameters

name string

A string value that specifies the property name. This value is assigned to the Name property.

property string

A string value that specifies the expression used to calculate values in a column on the data store side. This value is assigned to the Property property.

sorting SortDirection

A SortDirection enumeration value that specifies a sort order for property values to be retrieved from the data store. This value is assigned to the Sorting property.

Returns

ServerViewProperty

The ServerViewProperty object that was added to the Properties collection.

CreateServerModeCore() 

protected virtual XpoViewServerModeCore CreateServerModeCore()

Returns

XpoViewServerModeCore

DXClone() 

protected virtual object DXClone()

Returns

object

DXCloneCreate() 

protected virtual XPServerModeView DXCloneCreate()

Returns

XPServerModeView

FatalException(Exception) 

protected virtual void FatalException(Exception e)

Parameters

e Exception

Inconsistent(ServerModeInconsistencyDetectedEventArgs) 

protected virtual void Inconsistent(ServerModeInconsistencyDetectedEventArgs e)

Parameters

e ServerModeInconsistencyDetectedEventArgs

IsInitialized() 

protected bool IsInitialized()

Returns

bool

OnResolveSession(ResolveSessionEventArgs) 

protected virtual void OnResolveSession(ResolveSessionEventArgs args)

Parameters

args ResolveSessionEventArgs

OnServerExceptionThrown(ServerExceptionThrownEventArgs) 

protected virtual void OnServerExceptionThrown(ServerExceptionThrownEventArgs e)

Parameters

e ServerExceptionThrownEventArgs

PopulateProperties()

Clears the Properties collection and populates it with properties of the persistent type specified by the ObjectType property.

public void PopulateProperties()

Reload() 

public void Reload()

Events

ResolveSession

Occurs when the XPServerModeView requests a Session to retrieve objects from the data store.

public event ResolveSessionEventHandler ResolveSession

Event Type

ResolveSessionEventHandler

ServerExceptionThrown

Occurs when a data server throws an exception.

public event ServerExceptionThrownEventHandler ServerExceptionThrown

Event Type

ServerExceptionThrownEventHandler