Class RadDataServiceDataSource

Provides an object for loading, paging, filtering, sorting and editing entities coming from a WCF Data Service.

Inheritance
System.Object
RadDataServiceDataSource
Namespace: Telerik.Windows.Controls
Assembly: Telerik.Windows.Controls.DataServices.dll

Syntax

[TelerikToolboxCategory("Data")]
public class RadDataServiceDataSource : Control
Remarks

Use this component to simplify the interaction between the user interface and data from a DataServiceContext. After specifying a DataServiceContext and QueryName, the RadDataServiceDataSource can load data and expose it through the DataView properties. This component also provides codeless integration with other data controls like RadGridView, RadDataPager and RadDataFilter.

Constructors

RadDataServiceDataSource()

Initializes a new instance of the RadDataServiceDataSource class.

Declaration
public RadDataServiceDataSource()

Fields

AutoLoadProperty

Identifies AutoLoad dependency property.

Declaration
public static readonly DependencyProperty AutoLoadProperty
Field Value
System.Windows.DependencyProperty

CanLoadProperty

Identifies CanLoad dependency property.

Declaration
public static readonly DependencyProperty CanLoadProperty
Field Value
System.Windows.DependencyProperty

DataServiceContextProperty

Identifies DataServiceContext dependency property.

Declaration
public static readonly DependencyProperty DataServiceContextProperty
Field Value
System.Windows.DependencyProperty

ExpandProperty

Identifies Expand dependency property.

Declaration
public static readonly DependencyProperty ExpandProperty
Field Value
System.Windows.DependencyProperty

HasChangesProperty

Identifies HasChanges dependency property.

Declaration
public static readonly DependencyProperty HasChangesProperty
Field Value
System.Windows.DependencyProperty

IsBusyProperty

Identifies IsBusy dependency property.

Declaration
public static readonly DependencyProperty IsBusyProperty
Field Value
System.Windows.DependencyProperty

IsLoadingDataProperty

Identifies IsLoadingData dependency property.

Declaration
public static readonly DependencyProperty IsLoadingDataProperty
Field Value
System.Windows.DependencyProperty

IsSubmittingChangesProperty

Identifies IsSubmittingChanges dependency property.

Declaration
public static readonly DependencyProperty IsSubmittingChangesProperty
Field Value
System.Windows.DependencyProperty

LoadDelayProperty

Identifies LoadDelay dependency property.

Declaration
public static readonly DependencyProperty LoadDelayProperty
Field Value
System.Windows.DependencyProperty

PageSizeProperty

Identifies PageSize dependency property.

Declaration
public static readonly DependencyProperty PageSizeProperty
Field Value
System.Windows.DependencyProperty

QueryNameProperty

Identifies QueryName dependency property.

Declaration
public static readonly DependencyProperty QueryNameProperty
Field Value
System.Windows.DependencyProperty

Properties

AutoLoad

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

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

true if the data source is will automatically invoke Load when a change occurs that impacts the query composed by the data source; otherwise, false.

CancelLoadCommand

Gets the command for cancelling load.

Declaration
public ICommand CancelLoadCommand { get; }
Property Value
System.Windows.Input.ICommand

The command for cancelling load.

CancelSubmitCommand

Gets the command for cancelling submit.

Declaration
public ICommand CancelSubmitCommand { get; }
Property Value
System.Windows.Input.ICommand

The command for cancelling submit.

CanLoad

Gets a value indicating whether the control can perform a load operation based on the present state.

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

true if this instance can load data; otherwise, false.

DataServiceContext

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

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

The WCF DataServiceContext.
Remarks

The only supported DataServiceContext.MergeOption is MergeOption.OverwriteChanges. Setting the MergeOption to anything else will result in an InvalidOperationException.

DataView

Gets the current view of entities resulting from the last load operation, using a DataItemCollection.

Declaration
public DataItemCollection DataView { get; }
Property Value
DataItemCollection

The current view of entities resulting from the last load operation.

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 .

FilterDescriptors

Gets the filter descriptors used for filtering operations.

Declaration
public CompositeFilterDescriptorCollection FilterDescriptors { get; }
Property Value
CompositeFilterDescriptorCollection

The filter descriptors.

GroupDescriptors

Gets the group descriptors used for grouping operations.

Declaration
public GroupDescriptorCollection GroupDescriptors { get; }
Property Value
GroupDescriptorCollection

The group descriptors.

HasChanges

Gets a value indicating whether the DataServiceContext currently has any entities with pending changes.

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

true if DataServiceContext has changes; otherwise, false.

IsBusy

Gets or sets a value indicating whether the dataService data source is busy (loading or submitting).

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

true if the dataService data source is busy; otherwise, false.

IsLoadingData

Gets a value indicating whether RadDataServiceDataSource is currently loading data.

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

true if this instance is loading data; otherwise, false.

IsSubmittingChanges

Gets a value indicating whether RadDataServiceDataSource is currently submitting changes as a result of a call to SubmitChanges().

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

true if this instance is submitting changes; otherwise, false.

LoadCommand

Gets the command for loading data.

Declaration
public ICommand LoadCommand { get; }
Property Value
System.Windows.Input.ICommand

The command for loading data.

LoadDelay

Gets or sets the delay before an automatic data loading operation is started.

Declaration
public TimeSpan LoadDelay { get; set; }
Property Value
System.TimeSpan

The delay before an automatic data loading operation is started.

PageSize

Gets or sets the number of items displayed on each page of the view returned from Data, or 0 to disable paging. A non-zero page size will cause the number of entities loaded with each Load operation to be limited as well, using server-side paging.

Declaration
public int PageSize { get; set; }
Property Value
System.Int32

The size of the page.

QueryName

Gets or sets the name of the query to use for loading.

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

The name of the query to use for loading data.
Remarks

The DataServiceContext will be searched for a method that returns an EntityQuery, with a name that matches the name provided to QueryName. The matched name can be with or without a "Query" suffix.

RejectChangesCommand

Gets the command for rejecting changes.

Declaration
public ICommand RejectChangesCommand { get; }
Property Value
System.Windows.Input.ICommand

The command for rejecting changes.

SortDescriptors

Gets the sort descriptors used for sorting operations.

Declaration
public SortDescriptorCollection SortDescriptors { get; }
Property Value
SortDescriptorCollection

The sort descriptors.

SubmitChangesCommand

Gets the command for submitting changes.

Declaration
public ICommand SubmitChangesCommand { get; }
Property Value
System.Windows.Input.ICommand

The command for submitting changes.

Methods

BeginInit()

Starts the initialization process for this element.

Declaration
public override void BeginInit()

CancelLoad()

Cancels the current load operation if any.

Declaration
public void CancelLoad()

CancelSubmit()

Cancels the current submit operation if any.

Declaration
public void CancelSubmit()

EndInit()

Indicates that the initialization process for the element is complete.

Declaration
public override void EndInit()
Exceptions
System.InvalidOperationException

System.Windows.FrameworkElement.EndInit was called without System.Windows.FrameworkElement.BeginInit having previously been called on the element.

Load()

Initiates a Load operation if possible.

Declaration
public void Load()

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