Class LocalDataSourceProvider

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

Inheritance
System.Object
DataProviderBase
LocalDataSourceProvider
Inherited Members
Namespace: Telerik.Pivot.Core
Assembly: Telerik.Pivot.Core.dll

Syntax

public class LocalDataSourceProvider : DataProviderBase, IDataProvider, INotifyPropertyChanged, ISupportInitialize, IAggregateDescriptionsGenerator, IUnderlyingDataProvider, ICultureAwareProvider

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
System.Windows.DependencyProperty

Properties

AggregateDescriptions

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

Declaration
public Collection<LocalAggregateDescription> AggregateDescriptions { get; }
Property Value
System.Collections.ObjectModel.Collection<LocalAggregateDescription>

CalculatedFields

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

Declaration
public Collection<CalculatedField> CalculatedFields { get; }
Property Value
System.Collections.ObjectModel.Collection<CalculatedField>

ColumnGroupDescriptions

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

Declaration
public Collection<PropertyGroupDescriptionBase> ColumnGroupDescriptions { get; }
Property Value
System.Collections.ObjectModel.Collection<PropertyGroupDescriptionBase>

Culture

Gets or sets the CultureInfo used for grouping and formatting.

Declaration
public CultureInfo Culture { get; set; }
Property Value
System.Globalization.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
public bool EnableHierarchy { get; set; }
Property Value
System.Boolean

FilterDescriptions

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

Declaration
public Collection<PropertyFilterDescriptionBase> FilterDescriptions { get; }
Property Value
System.Collections.ObjectModel.Collection<PropertyFilterDescriptionBase>

ItemsSource

The item source for the grouping.

Declaration
public object ItemsSource { get; set; }
Property Value
System.Object

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
public Collection<PropertyGroupDescriptionBase> RowGroupDescriptions { get; }
Property Value
System.Collections.ObjectModel.Collection<PropertyGroupDescriptionBase>

State

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

Declaration
public override object State { get; }
Property Value
System.Object

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
IFieldDescriptionProvider

Overrides

GetAggregateDescriptionForFieldDescriptionCore(IPivotFieldInfo)

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

Declaration
protected override IAggregateDescription GetAggregateDescriptionForFieldDescriptionCore(IPivotFieldInfo description)
Parameters
IPivotFieldInfo description

A IPivotFieldInfo instance.
Returns
IAggregateDescription

An IAggregateDescription instance.
Overrides

GetAggregateFunctionsForAggregateDescription(IAggregateDescription)

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

Declaration
public override IEnumerable<object> GetAggregateFunctionsForAggregateDescription(IAggregateDescription aggregateDescription)
Parameters
IAggregateDescription aggregateDescription

The IAggregateDescription.
Returns
System.Collections.Generic.IEnumerable<System.Object>

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
IPivotFieldInfo description

A IPivotFieldInfo instance.
Returns
FilterDescription

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
IPivotFieldInfo description

A IPivotFieldInfo instance.
Returns
IGroupDescription

An IGroupDescription instance.
Overrides

GetUnderlyingData(IGroup, IGroup)

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

Declaration
public void GetUnderlyingData(IGroup rowGroup, IGroup columnGroup)
Parameters
IGroup rowGroup

The IGroup for rows.
IGroup columnGroup

The IGroup for columns.
Implements

RefreshOverride()

Recreates the Results.

Declaration
protected override void RefreshOverride()
Overrides

SetAggregateFunctionToAggregateDescription(IAggregateDescription, Object)

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

Declaration
public override void SetAggregateFunctionToAggregateDescription(IAggregateDescription aggregateDescription, object aggregateFunction)
Parameters
IAggregateDescription aggregateDescription

The IAggregateDescription.
System.Object aggregateFunction

The aggregate function.
Overrides

Events

GetUnderlyingDataCompleted

Occurs when the underlying data extraction has completed.

Declaration
public event EventHandler<DrillDownCompletedEventArgs> GetUnderlyingDataCompleted
Event Type
System.EventHandler<DrillDownCompletedEventArgs>

Implements

Extension Methods