ClassRadDataServiceDataSource
Provides an object for loading, paging, filtering, sorting and editing entities coming from a WCF Data Service.
Definition
Namespace:Telerik.Windows.Controls
Assembly:Telerik.Windows.Controls.DataServices.dll
Syntax:
[TelerikToolboxCategory("Data")]
public class RadDataServiceDataSource : ControlInheritance: objectRadDataServiceDataSource
Constructors
RadDataServiceDataSource()
Initializes a new instance of the RadDataServiceDataSource class.
Declaration
public RadDataServiceDataSource()Fields
AutoLoadProperty
Identifies AutoLoad dependency property.
Declaration
public static readonly DependencyProperty AutoLoadPropertyField Value
DependencyProperty
CanLoadProperty
Identifies CanLoad dependency property.
Declaration
public static readonly DependencyProperty CanLoadPropertyField Value
DependencyProperty
DataServiceContextProperty
Identifies DataServiceContext dependency property.
Declaration
public static readonly DependencyProperty DataServiceContextPropertyField Value
DependencyProperty
ExpandProperty
Identifies Expand dependency property.
Declaration
public static readonly DependencyProperty ExpandPropertyField Value
DependencyProperty
HasChangesProperty
Identifies HasChanges dependency property.
Declaration
public static readonly DependencyProperty HasChangesPropertyField Value
DependencyProperty
IsBusyProperty
Identifies IsBusy dependency property.
Declaration
public static readonly DependencyProperty IsBusyPropertyField Value
DependencyProperty
IsLoadingDataProperty
Identifies IsLoadingData dependency property.
Declaration
public static readonly DependencyProperty IsLoadingDataPropertyField Value
DependencyProperty
IsSubmittingChangesProperty
Identifies IsSubmittingChanges dependency property.
Declaration
public static readonly DependencyProperty IsSubmittingChangesPropertyField Value
DependencyProperty
LoadDelayProperty
Identifies LoadDelay dependency property.
Declaration
public static readonly DependencyProperty LoadDelayPropertyField Value
DependencyProperty
PageSizeProperty
Identifies PageSize dependency property.
Declaration
public static readonly DependencyProperty PageSizePropertyField Value
DependencyProperty
QueryNameProperty
Identifies QueryName dependency property.
Declaration
public static readonly DependencyProperty QueryNamePropertyField Value
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
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.
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
true if this instance can load data; otherwise, false.
CancelLoadCommand
Gets the command for cancelling load.
Declaration
public ICommand CancelLoadCommand { get; }Property Value
The command for cancelling load.
CancelSubmitCommand
Gets the command for cancelling submit.
Declaration
public ICommand CancelSubmitCommand { get; }Property Value
The command for cancelling submit.
DataServiceContext
Gets or sets the WCF DataServiceContext instance used for executing the load and submit operations.
Declaration
public DataServiceContext DataServiceContext { get; set; }Property Value
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
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
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
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
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
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
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
true if this instance is submitting changes; otherwise, false.
LoadCommand
Gets the command for loading data.
Declaration
public ICommand LoadCommand { get; }Property Value
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
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
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
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
The command for rejecting changes.
SortDescriptors
Gets the sort descriptors used for sorting operations.
Declaration
public SortDescriptorCollection SortDescriptors { get; }Property Value
The sort descriptors.
SubmitChangesCommand
Gets the command for submitting changes.
Declaration
public ICommand SubmitChangesCommand { get; }Property Value
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
was called without having previously been called on the element.
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> LoadedDataEvent Value
LoadingData
Occurs when a data loading operation is started.
Declaration
public event EventHandler<LoadingDataEventArgs> LoadingDataEvent Value
SubmittedChanges
Event raised whenever a submit operation is completed.
Declaration
public event EventHandler<DataServiceSubmittedChangesEventArgs> SubmittedChangesEvent Value
SubmittingChanges
Event raised whenever a submit operation is launched.
Declaration
public event EventHandler<DataServiceSubmittingChangesEventArgs> SubmittingChangesEvent Value