ClassLocalDataSourceProvider
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:
[SuppressMessage("Microsoft.Maintainability", "CA1506:AvoidExcessiveClassCoupling", Justification = "Will resolve in future.")]
public class LocalDataSourceProvider : DataProviderBase, IDataProvider, INotifyPropertyChanged, ISupportInitialize, IUnderlyingDataProvider
Inheritance: objectDataProviderBaseLocalDataSourceProvider
Implements:
Inherited Members
Constructors
LocalDataSourceProvider()
Initializes a new instance of the LocalDataSourceProvider class.
Declaration
public LocalDataSourceProvider()
Fields
ItemsSourceProperty
Identifies the ItemsSource dependency property.
Declaration
public static readonly DependencyProperty ItemsSourceProperty
Field Value
DependencyProperty
Properties
AggregateDescriptions
Gets a list of PropertyAggregateDescription that specify how pivot should aggregate data.
Declaration
[SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Design choice.")]
public Collection<LocalAggregateDescription> AggregateDescriptions { get; }
Property Value
CalculatedFields
Gets a list of CalculatedFields that can be used as a calculated aggregate values.
Declaration
[SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Design choice.")]
public Collection<CalculatedField> CalculatedFields { get; }
Property Value
ColumnGroupDescriptions
Gets a list of PropertyGroupDescriptionBase that specify how pivot should group columns.
Declaration
[SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Design choice.")]
public Collection<PropertyGroupDescriptionBase> ColumnGroupDescriptions { get; }
Property Value
Culture
Gets or sets the CultureInfo used for grouping and formatting.
EnableHierarchy
Gets or sets a boolean value indicating whether nested properties of the objects in the ItemsSource will be displayed in a hierarchy.
FilterDescriptions
Gets a list of PropertyFilterDescriptionBase that specified how pivot should filter items.
Declaration
[SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Design choice.")]
public Collection<PropertyFilterDescriptionBase> FilterDescriptions { get; }
Property Value
ItemsSource
The item source for the grouping.
Results
Declaration
protected override IPivotResults Results { get; }
Property Value
IPivotResults
Overrides
RowGroupDescriptions
Gets a list of PropertyGroupDescriptionBase that specified how pivot should group rows.
Declaration
[SuppressMessage("Microsoft.Design", "CA1002:DoNotExposeGenericLists", Justification = "Design choice.")]
public Collection<PropertyGroupDescriptionBase> RowGroupDescriptions { get; }
Property Value
State
Gets the state object that is provided to GetDescriptionsDataAsync(object) method.
Declaration
public override object State { get; }
Property Value
The object that will be passed to GetDescriptionsDataAsync(object) method.
Overrides
Methods
BlockUntilRefreshCompletes()
Block the calling thread until all calculations performed by calling Refresh() method completes.
Declaration
public override void BlockUntilRefreshCompletes()
Overrides
CreateFieldDescriptionsProvider()
Creates an instance of IFieldDescriptionProvider for this IDataProvider.
Declaration
protected override IFieldDescriptionProvider CreateFieldDescriptionsProvider()
Returns
Overrides
GetAggregateDescriptionForFieldDescriptionCore(IPivotFieldInfo)
Creates and returns an aggregate description suitable for the supplied field description.
Declaration
protected override IAggregateDescription GetAggregateDescriptionForFieldDescriptionCore(IPivotFieldInfo description)
Parameters
description
A IPivotFieldInfo instance.
Returns
An IAggregateDescription instance.
Overrides
GetAggregateFunctionsForAggregateDescription(IAggregateDescription)
Returns a list of suitable functions for the supplied aggregate description.
Declaration
[Obsolete("Not used. Obsoleted after 2013.Q2.SP1")]
public override IEnumerable<object> GetAggregateFunctionsForAggregateDescription(IAggregateDescription aggregateDescription)
Parameters
aggregateDescription
Returns
A list of possible aggregate functions.
Overrides
GetFilterDescriptionForFieldDescriptionCore(IPivotFieldInfo)
Returns a filter description suitable for the supplied field description.
Declaration
protected override FilterDescription GetFilterDescriptionForFieldDescriptionCore(IPivotFieldInfo description)
Parameters
description
A IPivotFieldInfo instance.
Returns
An FilterDescription instance.
Overrides
GetGroupDescriptionForFieldDescriptionCore(IPivotFieldInfo)
Creates and returns a group description suitable for the supplied field description.
Declaration
protected override IGroupDescription GetGroupDescriptionForFieldDescriptionCore(IPivotFieldInfo description)
Parameters
description
A IPivotFieldInfo instance.
Returns
An IGroupDescription instance.
Overrides
GetUnderlyingData(IGroup, IGroup)
Executes underlying data extraction for the specified row and column IGroups.
RefreshOverride()
Recreates the Results.
Declaration
protected override void RefreshOverride()
Overrides
SetAggregateFunctionToAggregateDescription(IAggregateDescription, object)
Set the aggregateFunction retrieved from GetAggregateFunctionsForAggregateDescription(IAggregateDescription) to the aggregateDescription.
Declaration
[Obsolete("Not used. Obsoleted after 2013.Q2.SP1")]
public override void SetAggregateFunctionToAggregateDescription(IAggregateDescription aggregateDescription, object aggregateFunction)
Parameters
aggregateDescription
aggregateFunction
The aggregate function.
Overrides
Events
GetUnderlyingDataCompleted
Occurs when the underlying data extraction has completed.
Declaration
public event EventHandler<DrillDownCompletedEventArgs> GetUnderlyingDataCompleted
Event Value
Implements