ClientViewSource Class

Data source object exposing data from ClientCacheBase to which GUI controls can bind. Using a ClientViewSource, you can load, filter, group, and sort data easily.

Inheritance

object

DispatcherObject

DependencyObject

ClientViewSource

EntityViewSource

Implements

INotifyPropertyChanged

ISupportInitialize

Namespace: C1.Data.DataSource

Assembly: C1.Data.Entity.4.8.dll

Syntax

public class ClientViewSource : DependencyObject, INotifyPropertyChanged, ISupportInitialize

Public Class ClientViewSource
    Inherits DependencyObject
    Implements INotifyPropertyChanged, ISupportInitialize

Constructors

Name	Description
ClientViewSource()	Initializes a new instance of the ClientViewSource class.

Properties

Name	Description
AutoLoad	Gets or sets a value indicating whether Load() is automatically invoked on startup and when a change occurs that impacts the query composed by the ClientViewSource. The default is True.
BaseView	Gets or sets an instance of ClientView<T> that the ClientViewSource uses as the base for composing queries.
CacheTimeout	Gets or sets the period of time entities loaded in virtual mode are kept in the cache without checking whether they are needed or not. If an entity was neither used nor considered needed for a period of time longer than CacheTimeout, ClientViewSource may evict it from the cache.
CurrentClientView	Gets the current client view used to load entities, or null in virtual mode.
DataView	Gets the current view of entities resulting from the last load operation.
FilterDescriptors	Gets the collection of FilterDescriptor objects used when performing loads.
FilterOperator	Gets or sets the logical operator used for combinining FilterDescriptors in the filter collection. The default value is And.
GroupDescriptors	Gets the collection of GroupDescriptor objects used to organize the loaded entities into groups.
Include	Gets or sets a comma-separated list of property paths that specify related objects to include during the Load() operation.
IsLoadingData	Gets a value indicating whether the ClientViewSource is currently loading data.
LoadCommand	Gets an ICommand that invokes Load() on this ClientViewSource.
LoadDelay	Gets or sets the delay before an automatic data loading operation is started. It is the delay from the time a change prompting automatic load occurs until the time the resulting Load() is started. The default delay is 25 milliseconds.
LoadSize	Gets or sets the maximum number of items to load each time a Load() is executed. When equal to 0, all requested entities will be loaded. The default is 0.
MoveToFirstOnLoad	Gets or sets a value indicating that the first item must be made current after Load() operation is completed if current item was not set by other means.
Name	Gets a name of this ClientViewSource to reference it in a C1DataSource.ViewSources collection. By default it is determined by the EntitySetName (for Entity Framework) or QueryName (for RIA Services), but it can be overrided by NameOverride.
NameOverride	Gets or sets a value that overrides the value of the Name property.
PageSize	Gets or sets the number of items displayed on each page of the DataView, or the number of items to fetch in each query in virtual mode, or 0 to disable paging.
SortDescriptors	Gets the collection of SortDescriptor objects used to sort the data.
VirtualMode	Gets or sets a value indicating whether the ClientViewSource is in virtual mode. Virtual mode is an innovative technology allowing to bind GUI controls directly to very large data sets without delays and performance degradation and without inconvenience of paging. By default, virtual mode is disabled (the default value is None).

Methods

Name	Description
DeferLoad()	Used to group changes to multiple load-affecting properties together, deferring the resulting load operations so a single load operation is performed in the end, that is, when the object returned from this method is disposed.
Load()	Starts a load operation. Any pending load will be implicitly canceled.
LoadRange(int, int)	If in virtual mode, loads a specific range of entities.
Refresh()	Starts a load operation ignoring the client-side cache. Any pending load will be implicitly canceled.

Events

Name	Description
LoadedData	Occurs when a load operation is completed, or when an exception was thrown during the load operation.
PropertyChanged	Occurs when a property value changes.