DataProviderBase
Base implementation of IDataProvider.
Definition
Namespace:Telerik.Pivot.Core
Assembly:Telerik.WinControls.PivotGrid.dll
Syntax:
public abstract class DataProviderBase : IDataProvider, INotifyPropertyChanged, ISupportInitializeInheritance: objectDataProviderBase
Derived Classes:
Implements:
Properties
public int AggregatesLevel { get; set; }public PivotAxis AggregatesPosition { get; set; }Gets or sets a value that indicates if changes to this IDataProvider will trigger automatic Refresh().
public bool DeferUpdates { get; set; }Implements:
public IFieldDescriptionProvider FieldDescriptionsProvider { get; set; }Gets the IFieldInfoData instance that provided information for all available properties of the data source.
public IFieldInfoData FieldInfos { get; protected set; }The field information.
Implements:
Gets a value that indicates if there are pending changes since the last Refresh(). The value will be true after a change is applied. The value will be false after an automatic or user triggered Refresh(). The value will be false during any work or download process so even if false Results may not be ready yet. In that case you may check Status for additional information.
public bool HasPendingChanges { get; }Implements:
Results
IPivotResults
protected abstract IPivotResults Results { get; }protected IPivotSettings Settings { get; }Gets the state object that is provided to GetDescriptionsDataAsync(object) method.
public abstract object State { get; }The object that will be passed to GetDescriptionsDataAsync(object) method.
Implements:
public DataProviderStatus Status { get; }Methods
public void BeginInit()Implements:
Block the calling thread until all calculations performed by calling Refresh() method completes.
public abstract void BlockUntilRefreshCompletes()Implements:
Creates an instance of IFieldDescriptionProvider for this IDataProvider.
protected abstract IFieldDescriptionProvider CreateFieldDescriptionsProvider()Enters a defer cycle that you can use to merge changes to the provider and delay automatic refresh.
public IDisposable DeferRefresh()An IDisposable object that you can use to dispose of the calling object.
Implements:
public void EndInit()Implements:
Creates and returns an aggregate description suitable for the supplied field description.
public IAggregateDescription GetAggregateDescriptionForFieldDescription(IPivotFieldInfo info)A IPivotFieldInfo instance.
Returns:An IAggregateDescription instance.
Implements:
Creates and returns an aggregate description suitable for the supplied field description.
protected abstract IAggregateDescription GetAggregateDescriptionForFieldDescriptionCore(IPivotFieldInfo description)A IPivotFieldInfo instance.
Returns:An IAggregateDescription instance.
Returns a filter description suitable for the supplied field description.
public FilterDescription GetFilterDescriptionForFieldDescription(IPivotFieldInfo info)A IPivotFieldInfo instance.
Returns:An FilterDescription instance.
Implements:
Returns a filter description suitable for the supplied field description.
protected abstract FilterDescription GetFilterDescriptionForFieldDescriptionCore(IPivotFieldInfo description)A IPivotFieldInfo instance.
Returns:An FilterDescription instance.
Creates and returns a group description suitable for the supplied field description.
public IGroupDescription GetGroupDescriptionForFieldDescription(IPivotFieldInfo info)A IPivotFieldInfo instance.
Returns:An IGroupDescription instance.
Implements:
Creates and returns a group description suitable for the supplied field description.
protected abstract IGroupDescription GetGroupDescriptionForFieldDescriptionCore(IPivotFieldInfo description)A IPivotFieldInfo instance.
Returns:An IGroupDescription instance.
Notify that changes were applied that would alter the pivot results. Queues an automatic Refresh().
protected void Invalidate()Called when FieldDescriptionsProvider is changed.
protected virtual void OnFieldDescriptionsProviderChanged(IFieldDescriptionProvider oldProvider, IFieldDescriptionProvider newProvider)Raises the event.
protected virtual void OnPrepareDescriptionForField(PrepareDescriptionForFieldEventArgs args)The PrepareDescriptionForFieldEventArgs instance containing the event data.
Raises PropertyChanged event.
Raises the event.
protected virtual void OnStatusChanged(DataProviderStatusChangedEventArgs args)The DataProviderStatusChangedEventArgs instance containing the event data.
public void Refresh()Recreates the Results.
protected abstract void RefreshOverride()Events
Occurs when description should be prepared for a specified field info.
public event EventHandler<PrepareDescriptionForFieldEventArgs> PrepareDescriptionForFieldImplements:
public event PropertyChangedEventHandler PropertyChangedImplements:
public event EventHandler<DataProviderStatusChangedEventArgs> StatusChanged