New to Telerik UI for WinFormsStart a free 30-day trial

IDataProvider

Interface

Provides data access for pivot grouping.

Definition

Namespace:Telerik.Pivot.Core

Assembly:Telerik.WinControls.PivotGrid.dll

Syntax:

C#
public interface IDataProvider : INotifyPropertyChanged, ISupportInitialize

Derived Classes: AdomdDataProviderDataProviderBaseLocalDataSourceProviderOlapDataProviderQueryableDataProviderXmlaDataProvider...

Inherited Members INotifyPropertyChanged.PropertyChangedISupportInitialize.BeginInit()ISupportInitialize.EndInit()

Properties

Gets or sets the position where groups for the aggregates should be placed.

C#
int AggregatesLevel { get; set; }

Gets or sets a value indicating where the aggregate groups should be positioned.

C#
PivotAxis AggregatesPosition { get; set; }

Gets or sets a property that indicates if changes to the grouping settings would trigger computations immediately when invalidated or on explicit Refresh().

C#
bool DeferUpdates { get; set; }

Gets the IFieldInfoData instance that provided information for all available properties of the data source.

C#
IFieldInfoData FieldInfos { get; }
Property Value:

The field information.

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.

C#
bool HasPendingChanges { get; }

Results

IPivotResults

Gets the results from the last grouping.

C#
IPivotResults Results { get; }

Gets or sets the IPivotSettings instance that is being used.

C#
IPivotSettings Settings { get; }

Gets the state object that is provided to GetDescriptionsDataAsync(object) method.

C#
object State { get; }
Property Value:

The object that will be passed to GetDescriptionsDataAsync(object) method.

Gets the status of this instance.

C#
DataProviderStatus Status { get; }

Methods

Block the calling thread until all calculations performed by calling Refresh() method completes.

C#
void BlockUntilRefreshCompletes()

Enters a defer cycle that you can use to merge changes to the data provider and delay automatic refresh.

C#
IDisposable DeferRefresh()
Returns:

IDisposable

An IDisposable object that you can use to dispose of the calling object.

Creates and returns an aggregate description suitable for the supplied field description.

C#
IAggregateDescription GetAggregateDescriptionForFieldDescription(IPivotFieldInfo info)
Parameters:infoIPivotFieldInfo

A IPivotFieldInfo instance.

Returns:

IAggregateDescription

An IAggregateDescription instance.

Returns a filter description suitable for the supplied field description.

C#
FilterDescription GetFilterDescriptionForFieldDescription(IPivotFieldInfo info)
Parameters:infoIPivotFieldInfo

A IPivotFieldInfo instance.

Returns:

FilterDescription

An FilterDescription instance.

Creates and returns a group description suitable for the supplied field description.

C#
IGroupDescription GetGroupDescriptionForFieldDescription(IPivotFieldInfo info)
Parameters:infoIPivotFieldInfo

A IPivotFieldInfo instance.

Returns:

IGroupDescription

An IGroupDescription instance.

Force recalculation operation.

C#
void Refresh()

Events

Occurs when description should be prepared for a specified field info.

C#
event EventHandler<PrepareDescriptionForFieldEventArgs> PrepareDescriptionForField

Occurs when the current operation has completed.

C#
event EventHandler<DataProviderStatusChangedEventArgs> StatusChanged