Class
LocalDataSourceProvider

Provides a pivot grouping access to local source such as an IList of instances of user defined classes.

Definition

Namespace:Telerik.Pivot.Core

Assembly:Telerik.Pivot.Core.dll

Syntax:

cs-api-definition
[SuppressMessage("Microsoft.Maintainability", "CA1506:AvoidExcessiveClassCoupling", Justification = "Will resolve in future.")]
public class LocalDataSourceProvider : DataProviderBase, IDataProvider, INotifyPropertyChanged, ISupportInitialize, IUnderlyingDataProvider

Inheritance: objectDataProviderBaseLocalDataSourceProvider

Implements: IDataProviderINotifyPropertyChangedISupportInitializeIUnderlyingDataProvider

Inherited Members DataProviderBase.BeginInit()DataProviderBase.EndInit()DataProviderBase.Refresh()DataProviderBase.DeferRefresh()DataProviderBase.Invalidate()DataProviderBase.OnStatusChanged(DataProviderStatusChangedEventArgs)DataProviderBase.OnPrepareDescriptionForField(PrepareDescriptionForFieldEventArgs)DataProviderBase.OnFieldDescriptionsProviderChanged(IFieldDescriptionProvider, IFieldDescriptionProvider)DataProviderBase.OnPropertyChanged(string)DataProviderBase.GetAggregateDescriptionForFieldDescription(IPivotFieldInfo)DataProviderBase.GetGroupDescriptionForFieldDescription(IPivotFieldInfo)DataProviderBase.GetFilterDescriptionForFieldDescription(IPivotFieldInfo)DataProviderBase.CreateInstanceCore()DataProviderBase.FreezeCore(bool)DataProviderBase.FieldInfosDataProviderBase.DeferUpdatesDataProviderBase.StatusDataProviderBase.AggregatesPositionDataProviderBase.AggregatesLevelDataProviderBase.FieldDescriptionsProviderDataProviderBase.HasPendingChangesDataProviderBase.SettingsDataProviderBase.StatusChangedDataProviderBase.PropertyChangedDataProviderBase.PrepareDescriptionForField

Constructors

LocalDataSourceProvider()

Initializes a new instance of the LocalDataSourceProvider class.

Declaration

cs-api-definition
public LocalDataSourceProvider()

Fields

ItemsSourceProperty

Identifies the ItemsSource dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty ItemsSourceProperty

Field Value

DependencyProperty

Properties

AggregateDescriptions

Gets a list of PropertyAggregateDescription that specify how pivot should aggregate data.

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Design choice.")]
public Collection<LocalAggregateDescription> AggregateDescriptions { get; }

Property Value

Collection<LocalAggregateDescription>

CalculatedFields

Gets a list of CalculatedFields that can be used as a calculated aggregate values.

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Design choice.")]
public Collection<CalculatedField> CalculatedFields { get; }

Property Value

Collection<CalculatedField>

ColumnGroupDescriptions

Gets a list of PropertyGroupDescriptionBase that specify how pivot should group columns.

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Design choice.")]
public Collection<PropertyGroupDescriptionBase> ColumnGroupDescriptions { get; }

Property Value

Collection<PropertyGroupDescriptionBase>

Culture

Gets or sets the CultureInfo used for grouping and formatting.

Declaration

cs-api-definition
public CultureInfo Culture { get; set; }

Property Value

CultureInfo

EnableHierarchy

Gets or sets a boolean value indicating whether nested properties of the objects in the ItemsSource will be displayed in a hierarchy.

Declaration

cs-api-definition
public bool EnableHierarchy { get; set; }

Property Value

bool

FilterDescriptions

Gets a list of PropertyFilterDescriptionBase that specified how pivot should filter items.

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Design choice.")]
public Collection<PropertyFilterDescriptionBase> FilterDescriptions { get; }

Property Value

Collection<PropertyFilterDescriptionBase>

ItemsSource

The item source for the grouping.

Declaration

cs-api-definition
public object ItemsSource { get; set; }

Property Value

object

Results

Declaration

cs-api-definition
protected override IPivotResults Results { get; }

Property Value

IPivotResults

Overrides DataProviderBase.Results

RowGroupDescriptions

Gets a list of PropertyGroupDescriptionBase that specified how pivot should group rows.

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Design choice.")]
public Collection<PropertyGroupDescriptionBase> RowGroupDescriptions { get; }

Property Value

Collection<PropertyGroupDescriptionBase>

State

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

Declaration

cs-api-definition
public override object State { get; }

Property Value

object

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

Overrides DataProviderBase.State

Methods

BlockUntilRefreshCompletes()

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

Declaration

cs-api-definition
public override void BlockUntilRefreshCompletes()

Overrides DataProviderBase.BlockUntilRefreshCompletes()

CreateFieldDescriptionsProvider()

Creates an instance of IFieldDescriptionProvider for this IDataProvider.

Declaration

cs-api-definition
protected override IFieldDescriptionProvider CreateFieldDescriptionsProvider()

Returns

IFieldDescriptionProvider

Overrides DataProviderBase.CreateFieldDescriptionsProvider()

GetAggregateDescriptionForFieldDescriptionCore(IPivotFieldInfo)

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

Declaration

cs-api-definition
protected override IAggregateDescription GetAggregateDescriptionForFieldDescriptionCore(IPivotFieldInfo description)

Parameters

description

IPivotFieldInfo

A IPivotFieldInfo instance.

Returns

IAggregateDescription

An IAggregateDescription instance.

Overrides DataProviderBase.GetAggregateDescriptionForFieldDescriptionCore(IPivotFieldInfo)

GetAggregateFunctionsForAggregateDescription(IAggregateDescription)

Returns a list of suitable functions for the supplied aggregate description.

Declaration

cs-api-definition
[Obsolete("Not used. Obsoleted after 2013.Q2.SP1")]
public override IEnumerable<object> GetAggregateFunctionsForAggregateDescription(IAggregateDescription aggregateDescription)

Parameters

aggregateDescription

IAggregateDescription

The IAggregateDescription.

Returns

IEnumerable<object>

A list of possible aggregate functions.

Overrides DataProviderBase.GetAggregateFunctionsForAggregateDescription(IAggregateDescription)

GetFilterDescriptionForFieldDescriptionCore(IPivotFieldInfo)

Returns a filter description suitable for the supplied field description.

Declaration

cs-api-definition
protected override FilterDescription GetFilterDescriptionForFieldDescriptionCore(IPivotFieldInfo description)

Parameters

description

IPivotFieldInfo

A IPivotFieldInfo instance.

Returns

FilterDescription

An FilterDescription instance.

Overrides DataProviderBase.GetFilterDescriptionForFieldDescriptionCore(IPivotFieldInfo)

GetGroupDescriptionForFieldDescriptionCore(IPivotFieldInfo)

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

Declaration

cs-api-definition
protected override IGroupDescription GetGroupDescriptionForFieldDescriptionCore(IPivotFieldInfo description)

Parameters

description

IPivotFieldInfo

A IPivotFieldInfo instance.

Returns

IGroupDescription

An IGroupDescription instance.

Overrides DataProviderBase.GetGroupDescriptionForFieldDescriptionCore(IPivotFieldInfo)

GetUnderlyingData(IGroup, IGroup)

Executes underlying data extraction for the specified row and column IGroups.

Declaration

cs-api-definition
public void GetUnderlyingData(IGroup rowGroup, IGroup columnGroup)

Parameters

rowGroup

IGroup

The IGroup for rows.

columnGroup

IGroup

The IGroup for columns.

Implements IUnderlyingDataProvider.GetUnderlyingData(IGroup, IGroup)

RefreshOverride()

Recreates the Results.

Declaration

cs-api-definition
protected override void RefreshOverride()

Overrides DataProviderBase.RefreshOverride()

SetAggregateFunctionToAggregateDescription(IAggregateDescription, object)

Set the aggregateFunction retrieved from GetAggregateFunctionsForAggregateDescription(IAggregateDescription) to the aggregateDescription.

Declaration

cs-api-definition
[Obsolete("Not used. Obsoleted after 2013.Q2.SP1")]
public override void SetAggregateFunctionToAggregateDescription(IAggregateDescription aggregateDescription, object aggregateFunction)

Parameters

aggregateDescription

IAggregateDescription

The IAggregateDescription.

aggregateFunction

object

The aggregate function.

Overrides DataProviderBase.SetAggregateFunctionToAggregateDescription(IAggregateDescription, object)

Events

GetUnderlyingDataCompleted

Occurs when the underlying data extraction has completed.

Declaration

cs-api-definition
public event EventHandler<DrillDownCompletedEventArgs> GetUnderlyingDataCompleted

Event Value

EventHandler<DrillDownCompletedEventArgs>

Implements IUnderlyingDataProvider.GetUnderlyingDataCompleted