Table of Contents

Class XpoServerCollectionWrapperBase

Namespace
DevExpress.Xpo.Helpers
Assembly
DevExpress.Xpo.v24.1.dll
public abstract class XpoServerCollectionWrapperBase : IXpoServerModeGridDataSource, IListServerHints, IXtraRefreshable, IDXCloneable, IFilteredXtraBindingList, IBindingList, IList, ICollection, IEnumerable, IFilteredDataSource, ITypedList, IListServer, IXPClassInfoAndSessionProvider, IXPClassInfoProvider, ISessionProvider, IObjectLayerProvider, IDataLayerProvider, IXPDictionaryProvider, IColumnsServerActions
Inheritance
XpoServerCollectionWrapperBase
Implements
IListServerHints
IXtraRefreshable
IDXCloneable
IFilteredXtraBindingList
IFilteredDataSource
IListServer
IColumnsServerActions
Derived
Inherited Members

Constructors

XpoServerCollectionWrapperBase(IXpoServerModeGridDataSource)

protected XpoServerCollectionWrapperBase(IXpoServerModeGridDataSource nested)

Parameters

nested IXpoServerModeGridDataSource

Fields

Nested

public readonly IXpoServerModeGridDataSource Nested

Field Value

IXpoServerModeGridDataSource

Properties

AllowEdit

public virtual bool AllowEdit { get; }

Property Value

bool

AllowNew

public virtual bool AllowNew { get; }

Property Value

bool

AllowRemove

public virtual bool AllowRemove { get; }

Property Value

bool

ClassInfo

public virtual XPClassInfo ClassInfo { get; }

Property Value

XPClassInfo

Count

public virtual int Count { get; }

Property Value

int

DataLayer

public IDataLayer DataLayer { get; }

Property Value

IDataLayer

Dictionary

public XPDictionary Dictionary { get; }

Property Value

XPDictionary

IsFixedSize

public virtual bool IsFixedSize { get; }

Property Value

bool

IsReadOnly

public virtual bool IsReadOnly { get; }

Property Value

bool

IsSynchronized

public virtual bool IsSynchronized { get; }

Property Value

bool

this[int]

public virtual object this[int index] { get; set; }

Parameters

index int

Property Value

object

ObjectLayer

public IObjectLayer ObjectLayer { get; }

Property Value

IObjectLayer

RefreshSupported

public virtual bool RefreshSupported { get; }

Property Value

bool

Session

public Session Session { get; }

Property Value

Session

SupportsChangeNotification

public virtual bool SupportsChangeNotification { get; }

Property Value

bool

SyncRoot

public object SyncRoot { get; }

Property Value

object

Methods

Add(object)

public virtual int Add(object value)

Parameters

value object

Returns

int

AddNew()

public virtual object AddNew()

Returns

object

AllowAction(string, ColumnServerActionType)

public virtual bool AllowAction(string fieldName, ColumnServerActionType action)

Parameters

fieldName string
action ColumnServerActionType

Returns

bool

Apply(CriteriaOperator, ICollection<ServerModeOrderDescriptor[]>, int, ICollection<ServerModeSummaryDescriptor>, ICollection<ServerModeSummaryDescriptor>)

public virtual void Apply(CriteriaOperator filterCriteria, ICollection<ServerModeOrderDescriptor[]> sortInfo, int groupCount, ICollection<ServerModeSummaryDescriptor> summaryInfo, ICollection<ServerModeSummaryDescriptor> totalSummaryInfo)

Parameters

filterCriteria CriteriaOperator
sortInfo ICollection<ServerModeOrderDescriptor[]>
groupCount int
summaryInfo ICollection<ServerModeSummaryDescriptor>
totalSummaryInfo ICollection<ServerModeSummaryDescriptor>

Clear()

public virtual void Clear()

Contains(object)

public virtual bool Contains(object value)

Parameters

value object

Returns

bool

CopyTo(Array, int)

public virtual void CopyTo(Array array, int index)

Parameters

array Array
index int

DXClone()

public abstract object DXClone()

Returns

object

FindIncremental(CriteriaOperator, string, int, bool, bool, bool)

public virtual int FindIncremental(CriteriaOperator expression, string value, int startIndex, bool searchUp, bool ignoreStartRow, bool allowLoop)

Parameters

expression CriteriaOperator
value string
startIndex int
searchUp bool
ignoreStartRow bool
allowLoop bool

Returns

int

GetAllFilteredAndSortedRows()

public virtual IList GetAllFilteredAndSortedRows()

Returns

IList

GetEnumerator()

public virtual IEnumerator GetEnumerator()

Returns

IEnumerator

GetGroupInfo(ListSourceGroupInfo)

public virtual List<ListSourceGroupInfo> GetGroupInfo(ListSourceGroupInfo parentGroup)

Parameters

parentGroup ListSourceGroupInfo

Returns

List<ListSourceGroupInfo>

GetItemProperties(PropertyDescriptor[])

public virtual PropertyDescriptorCollection GetItemProperties(PropertyDescriptor[] listAccessors)

Parameters

listAccessors PropertyDescriptor[]

Returns

PropertyDescriptorCollection

GetListName(PropertyDescriptor[])

public virtual string GetListName(PropertyDescriptor[] listAccessors)

Parameters

listAccessors PropertyDescriptor[]

Returns

string

GetRowIndexByKey(object)

public virtual int GetRowIndexByKey(object key)

Parameters

key object

Returns

int

GetRowKey(int)

public virtual object GetRowKey(int index)

Parameters

index int

Returns

object

GetTotalSummary()

public virtual List<object> GetTotalSummary()

Returns

List<object>

GetUniqueColumnValues(CriteriaOperator, int, CriteriaOperator, bool)

public virtual object[] GetUniqueColumnValues(CriteriaOperator valuesExpression, int maxCount, CriteriaOperator filterExpression, bool ignoreAppliedFilter)

Parameters

valuesExpression CriteriaOperator
maxCount int
filterExpression CriteriaOperator
ignoreAppliedFilter bool

Returns

object[]

IndexOf(object)

public virtual int IndexOf(object value)

Parameters

value object

Returns

int

Insert(int, object)

public virtual void Insert(int index, object value)

Parameters

index int
value object

LocateByExpression(CriteriaOperator, int, bool)

public virtual int LocateByExpression(CriteriaOperator expression, int startIndex, bool searchUp)

Parameters

expression CriteriaOperator
startIndex int
searchUp bool

Returns

int

LocateByValue(CriteriaOperator, object, int, bool)

public virtual int LocateByValue(CriteriaOperator expression, object value, int startIndex, bool searchUp)

Parameters

expression CriteriaOperator
value object
startIndex int
searchUp bool

Returns

int

PrefetchRows(ListSourceGroupInfo[], CancellationToken)

public virtual bool PrefetchRows(ListSourceGroupInfo[] groupsToPrefetch, CancellationToken cancellationToken)

Parameters

groupsToPrefetch ListSourceGroupInfo[]
cancellationToken CancellationToken

Returns

bool

Refresh()

public virtual void Refresh()

Remove(object)

public virtual void Remove(object value)

Parameters

value object

RemoveAt(int)

public virtual void RemoveAt(int index)

Parameters

index int

SetFixedCriteria(CriteriaOperator)

public virtual void SetFixedCriteria(CriteriaOperator fixedCriteria)

Parameters

fixedCriteria CriteriaOperator

Events

ExceptionThrown

public event EventHandler<ServerModeExceptionThrownEventArgs> ExceptionThrown

Event Type

EventHandler<ServerModeExceptionThrownEventArgs>

InconsistencyDetected

public event EventHandler<ServerModeInconsistencyDetectedEventArgs> InconsistencyDetected

Event Type

EventHandler<ServerModeInconsistencyDetectedEventArgs>

ListChanged

public virtual event ListChangedEventHandler ListChanged

Event Type

ListChangedEventHandler