Class QueryableDataServiceCollectionViewBase

Represents a view for accessing and manipulating a DataServiceContext.

Inheritance
System.Object
QueryableCollectionView
QueryableDataServiceCollectionViewBase
QueryableDataServiceCollectionView<TEntity>
Inherited Members
Namespace: Telerik.Windows.Controls.DataServices
Assembly: Telerik.Windows.Controls.DataServices.dll

Syntax

public abstract class QueryableDataServiceCollectionViewBase : QueryableCollectionView, IEditableCollectionView, IEditableCollectionViewAddNewItem, ICollectionView, IEnumerable, INotifyCollectionChanged, INotifyPropertyChanged, IPagedCollectionView, IWeakEventListener<NotifyCollectionChangedEventArgs>, IWeakEventListener<CurrentChangingEventArgs>, IQueryableCollectionView, IItemProperties, IDisposable

Constructors

QueryableDataServiceCollectionViewBase(DataServiceContext, IEnumerable)

Initializes a new instance of the QueryableDataServiceCollectionViewBase class.

Declaration
protected QueryableDataServiceCollectionViewBase(DataServiceContext dataServiceContext, IEnumerable sourceCollection)
Parameters
Microsoft.OData.Client.DataServiceContext dataServiceContext

The data service context.
System.Collections.IEnumerable sourceCollection

The source collection.

Properties

AutoLoad

Gets or sets a value indicating whether Load is automatically invoked when a change occurs that impacts the query.

Declaration
public bool AutoLoad { get; set; }
Property Value
System.Boolean

true if Load will automatically be invoked when a change occurs that impacts the query; otherwise, false.

CanChangePage

Completes move to page operation. Raises PageChanged event and refreshes the data view.

Declaration
public override bool CanChangePage { get; }
Property Value
System.Boolean

Overrides

CanLoad

Gets a value indicating whether a load operation could be performed based on the present state.

Declaration
public bool CanLoad { get; }
Property Value
System.Boolean

true if this instance can load; otherwise, false.

DataServiceContext

Gets or sets the DataServiceContext instance used for executing the load and submit operations.

Declaration
public DataServiceContext DataServiceContext { get; }
Property Value
Microsoft.OData.Client.DataServiceContext

Expand

Gets or sets the expand option.

Declaration
public string Expand { get; set; }
Property Value
System.String

The expand option.
Remarks

For more information, please visit .

HasChanges

Gets a value indicating whether this collection has changes.

Declaration
public bool HasChanges { get; protected set; }
Property Value
System.Boolean

true if this instance has changes; otherwise, false.

IsBusy

Gets a value indicating whether this collection is loading or submitting data.

Declaration
public bool IsBusy { get; }
Property Value
System.Boolean

true if this collection is loading or submitting; otherwise, false.

IsLoading

Gets a value that indicates whether this collection is currently performing a Load operation.

Declaration
public override bool IsLoading { get; protected set; }
Property Value
System.Boolean

true if the collection is currently performing a Load operation; otherwise, false.
Overrides

IsSubmittingChanges

Gets a value indicating whether the collection is currently performing a Submit operation.

Declaration
public bool IsSubmittingChanges { get; protected set; }
Property Value
System.Boolean

true if the collection is currently performing a Submit operation; otherwise, false.

Methods

CancelLoad()

Cancels the current data loading operation, if any.

Declaration
public void CancelLoad()

CancelSubmit()

Cancels the current submit operation if any.

Declaration
public void CancelSubmit()

CompletePageMove(Int32)

Completes the page move.

Declaration
protected override void CompletePageMove(int newPageIndex)
Parameters
System.Int32 newPageIndex

The index of the new page.
Overrides

Load()

Initiates a Load operation if possible.

Declaration
public void Load()

Load(Boolean)

Initiates a Load operation if possible.

Declaration
public void Load(bool forceLoad)
Parameters
System.Boolean forceLoad

true if load should be performed even if the new entity query is the same as the last successfully load one; otherwise, false.

MoveToPageCore(Int32)

Requests a page move to the page at the specified index.

Declaration
protected override bool MoveToPageCore(int index)
Parameters
System.Int32 index

The index of the page to move to.
Returns
System.Boolean

true if the move was successfully initiated; otherwise, false.
Overrides

OnLoadedData(LoadedDataEventArgs)

Raises the LoadedData event.

Declaration
protected virtual void OnLoadedData(LoadedDataEventArgs args)
Parameters
LoadedDataEventArgs args

The LoadedDataEventArgs instance containing the event data.

OnLoadingData(LoadingDataEventArgs)

Raises the LoadingData event.

Declaration
protected virtual void OnLoadingData(LoadingDataEventArgs args)
Parameters
LoadingDataEventArgs args

The LoadingDataEventArgs instance containing the event data.

OnPropertyChanged(PropertyChangedEventArgs)

Raises the PropertyChanged event.

Declaration
protected override void OnPropertyChanged(PropertyChangedEventArgs e)
Parameters
System.ComponentModel.PropertyChangedEventArgs e

The System.ComponentModel.PropertyChangedEventArgs instance containing the event data.
Overrides

OnRefresh()

Invoked when the instance should be refreshed.

Declaration
protected override void OnRefresh()
Overrides

OnSubmittedChanges(DataServiceSubmittedChangesEventArgs)

Raises SubmittedChanges event.

Declaration
protected virtual void OnSubmittedChanges(DataServiceSubmittedChangesEventArgs submittedEventArgs)
Parameters
DataServiceSubmittedChangesEventArgs submittedEventArgs

The DataServiceSubmittedChangesEventArgs instance containing the event data.

OnSubmittingChanges(DataServiceSubmittingChangesEventArgs)

Raises SubmittingChanges event.

Declaration
protected virtual void OnSubmittingChanges(DataServiceSubmittingChangesEventArgs args)
Parameters
DataServiceSubmittingChangesEventArgs args

The DataServiceSubmittingChangesEventArgs instance containing the event data.

RejectChanges()

Rejects all changes.

Declaration
public void RejectChanges()

SubmitChanges()

Initiates a Submit operation if possible.

Declaration
public void SubmitChanges()

Events

LoadedData

Occurs when a data loading operation is completed.

Declaration
public event EventHandler<LoadedDataEventArgs> LoadedData
Event Type
System.EventHandler<LoadedDataEventArgs>

LoadingData

Occurs when a data loading operation is started.

Declaration
public event EventHandler<LoadingDataEventArgs> LoadingData
Event Type
System.EventHandler<LoadingDataEventArgs>

SubmittedChanges

Event raised whenever a submit operation is completed.

Declaration
public event EventHandler<DataServiceSubmittedChangesEventArgs> SubmittedChanges
Event Type
System.EventHandler<DataServiceSubmittedChangesEventArgs>

SubmittingChanges

Event raised whenever a submit operation is launched.

Declaration
public event EventHandler<DataServiceSubmittingChangesEventArgs> SubmittingChanges
Event Type
System.EventHandler<DataServiceSubmittingChangesEventArgs>

Extension Methods