New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

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

Definition

Namespace:Telerik.Web.UI.PivotGrid.Core

Assembly:Telerik.Web.UI.dll

Syntax:

C#
public class LocalDataSourceProvider : DataProviderBase, IDataProvider, INotifyPropertyChanged, ISupportInitialize

Inheritance: objectDataProviderBaseLocalDataSourceProvider

Implements: IDataProviderINotifyPropertyChangedISupportInitialize

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.FieldInfosDataProviderBase.DeferUpdatesDataProviderBase.StatusDataProviderBase.AggregatesPositionDataProviderBase.AggregatesLevelDataProviderBase.FieldDescriptionsProviderDataProviderBase.HasPendingChangesDataProviderBase.SettingsDataProviderBase.StatusChangedDataProviderBase.PropertyChangedDataProviderBase.PrepareDescriptionForFieldobject.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()object.GetType()object.MemberwiseClone()...

Constructors

Initializes a new instance of the LocalDataSourceProvider class.

C#
public LocalDataSourceProvider()

Properties

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

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

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

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

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

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

Gets or sets the CultureInfo used for grouping and formatting.

C#
public CultureInfo Culture { get; set; }

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

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

The item source for the grouping.

C#
public object ItemsSource { get; set; }
C#
protected override IPivotResults Results { get; }

Overrides: DataProviderBase.Results

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

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

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

C#
public override object State { get; }
Property Value:

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

Overrides: DataProviderBase.State

Methods

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

C#
public override void BlockUntilRefreshCompletes()

Overrides: DataProviderBase.BlockUntilRefreshCompletes()

Creates an instance of IFieldDescriptionProvider for this IDataProvider.

C#
protected override IFieldDescriptionProvider CreateFieldDescriptionsProvider()
Returns:

IFieldDescriptionProvider

Overrides: DataProviderBase.CreateFieldDescriptionsProvider()

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

C#
protected override IAggregateDescription GetAggregateDescriptionForFieldDescriptionCore(IPivotFieldInfo description)
Parameters:descriptionIPivotFieldInfo

A IPivotFieldInfo instance.

Returns:

IAggregateDescription

An IAggregateDescription instance.

Overrides: DataProviderBase.GetAggregateDescriptionForFieldDescriptionCore(IPivotFieldInfo)

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

C#
[Obsolete("Not used. Obsoleted after 2013.Q2.SP1")]
public override IEnumerable<object> GetAggregateFunctionsForAggregateDescription(IAggregateDescription aggregateDescription)
Parameters:aggregateDescriptionIAggregateDescription

The IAggregateDescription.

Returns:

IEnumerable<object>

A list of possible aggregate functions.

Overrides: DataProviderBase.GetAggregateFunctionsForAggregateDescription(IAggregateDescription)

Returns a filter description suitable for the supplied field description.

C#
protected override FilterDescription GetFilterDescriptionForFieldDescriptionCore(IPivotFieldInfo description)
Parameters:descriptionIPivotFieldInfo

A IPivotFieldInfo instance.

Returns:

FilterDescription

An FilterDescription instance.

Overrides: DataProviderBase.GetFilterDescriptionForFieldDescriptionCore(IPivotFieldInfo)

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

C#
protected override IGroupDescription GetGroupDescriptionForFieldDescriptionCore(IPivotFieldInfo description)
Parameters:descriptionIPivotFieldInfo

A IPivotFieldInfo instance.

Returns:

IGroupDescription

An IGroupDescription instance.

Overrides: DataProviderBase.GetGroupDescriptionForFieldDescriptionCore(IPivotFieldInfo)

Recreates the Results.

C#
protected override void RefreshOverride()

Overrides: DataProviderBase.RefreshOverride()

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

C#
[Obsolete("Not used. Obsoleted after 2013.Q2.SP1")]
public override void SetAggregateFunctionToAggregateDescription(IAggregateDescription aggregateDescription, object aggregateFunction)
Parameters:aggregateDescriptionIAggregateDescription

The IAggregateDescription.

aggregateFunctionobject

The aggregate function.

Overrides: DataProviderBase.SetAggregateFunctionToAggregateDescription(IAggregateDescription, object)