Provides an object for loading, paging, filtering, sorting and editing entities coming from a WCF Data Service.
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.
Definition
Namespace:Telerik.Windows.Controls
Assembly:Telerik.Windows.Controls.DataServices.dll
Syntax:
[TelerikToolboxCategory("Data")]
public class RadDataServiceDataSource : ControlInheritance: objectRadDataServiceDataSource
Constructors
Initializes a new instance of the RadDataServiceDataSource class.
public RadDataServiceDataSource()Fields
AutoLoadProperty
DependencyProperty
Identifies AutoLoad dependency property.
public static readonly DependencyProperty AutoLoadPropertyCanLoadProperty
DependencyProperty
Identifies CanLoad dependency property.
public static readonly DependencyProperty CanLoadPropertyDataServiceContextProperty
DependencyProperty
Identifies DataServiceContext dependency property.
public static readonly DependencyProperty DataServiceContextPropertyExpandProperty
DependencyProperty
Identifies Expand dependency property.
public static readonly DependencyProperty ExpandPropertyHasChangesProperty
DependencyProperty
Identifies HasChanges dependency property.
public static readonly DependencyProperty HasChangesPropertyIsBusyProperty
DependencyProperty
Identifies IsBusy dependency property.
public static readonly DependencyProperty IsBusyPropertyIsLoadingDataProperty
DependencyProperty
Identifies IsLoadingData dependency property.
public static readonly DependencyProperty IsLoadingDataPropertyIsSubmittingChangesProperty
DependencyProperty
Identifies IsSubmittingChanges dependency property.
public static readonly DependencyProperty IsSubmittingChangesPropertyLoadDelayProperty
DependencyProperty
Identifies LoadDelay dependency property.
public static readonly DependencyProperty LoadDelayPropertyPageSizeProperty
DependencyProperty
Identifies PageSize dependency property.
public static readonly DependencyProperty PageSizePropertyQueryNameProperty
DependencyProperty
Identifies QueryName dependency property.
public static readonly DependencyProperty QueryNamePropertyProperties
Gets or sets a value indicating whether Load is automatically invoked when a change occurs that impacts the query composed by the data source.
public bool AutoLoad { get; set; }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.
Gets the command for cancelling load.
public ICommand CancelLoadCommand { get; }The command for cancelling load.
Gets the command for cancelling submit.
public ICommand CancelSubmitCommand { get; }The command for cancelling submit.
Gets a value indicating whether the control can perform a load operation based on the present state.
public bool CanLoad { get; }true if this instance can load data; otherwise, false.
DataServiceContext
DataServiceContext
Gets or sets the WCF DataServiceContext instance used for executing the load and submit operations.
public DataServiceContext DataServiceContext { get; set; }The WCF DataServiceContext.
The only supported DataServiceContext.MergeOption is MergeOption.OverwriteChanges. Setting the MergeOption to anything else will result in an InvalidOperationException.
Gets the current view of entities resulting from the last load operation, using a DataItemCollection.
public DataItemCollection DataView { get; }The current view of entities resulting from the last load operation.
Gets or sets the expand option.
public string Expand { get; set; }The expand option.
For more information, please visit
.
Gets the filter descriptors used for filtering operations.
public CompositeFilterDescriptorCollection FilterDescriptors { get; }The filter descriptors.
Gets the group descriptors used for grouping operations.
public GroupDescriptorCollection GroupDescriptors { get; }The group descriptors.
Gets a value indicating whether the DataServiceContext currently has any entities with pending changes.
public bool HasChanges { get; }true if DataServiceContext has changes; otherwise, false.
Gets or sets a value indicating whether the dataService data source is busy (loading or submitting).
public bool IsBusy { get; }true if the dataService data source is busy; otherwise, false.
Gets a value indicating whether RadDataServiceDataSource is currently loading data.
public bool IsLoadingData { get; }true if this instance is loading data; otherwise, false.
Gets a value indicating whether RadDataServiceDataSource is currently submitting changes as a result of a call to SubmitChanges().
public bool IsSubmittingChanges { get; }true if this instance is submitting changes; otherwise, false.
Gets the command for loading data.
public ICommand LoadCommand { get; }The command for loading data.
Gets or sets the delay before an automatic data loading operation is started.
public TimeSpan LoadDelay { get; set; }The delay before an automatic data loading operation is started.
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.
public int PageSize { get; set; }The size of the page.
Gets or sets the name of the query to use for loading.
public string QueryName { get; set; }The name of the query to use for loading data.
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.
Gets the command for rejecting changes.
public ICommand RejectChangesCommand { get; }The command for rejecting changes.
Gets the sort descriptors used for sorting operations.
public SortDescriptorCollection SortDescriptors { get; }The sort descriptors.
Gets the command for submitting changes.
public ICommand SubmitChangesCommand { get; }The command for submitting changes.
Methods
Starts the initialization process for this element.
public override void BeginInit()Cancels the current load operation if any.
public void CancelLoad()Cancels the current submit operation if any.
public void CancelSubmit()Indicates that the initialization process for the element is complete.
public override void EndInit()was called without having previously been called on the element.
Initiates a Load operation if possible.
public void Load()Rejects all changes.
public void RejectChanges()Initiates a Submit operation if possible.
public void SubmitChanges()Events
Occurs when a data loading operation is completed.
public event EventHandler<LoadedDataEventArgs> LoadedDataOccurs when a data loading operation is started.
public event EventHandler<LoadingDataEventArgs> LoadingDataEvent raised whenever a submit operation is completed.
public event EventHandler<DataServiceSubmittedChangesEventArgs> SubmittedChangesEvent raised whenever a submit operation is launched.
public event EventHandler<DataServiceSubmittingChangesEventArgs> SubmittingChanges