Class QueryableDataProvider

Represents an IDataProvider that works with IQueryable sources.

Inheritance
System.Object
DataProviderBase
QueryableDataProvider
Inherited Members
Namespace: Telerik.Pivot.Queryable
Assembly: Telerik.Pivot.DataProviders.Queryable.dll

Syntax

public class QueryableDataProvider : DataProviderBase, IDataProvider, INotifyPropertyChanged, ISupportInitialize, IAggregateDescriptionsGenerator, ICultureAwareProvider

Constructors

QueryableDataProvider()

Initializes a new instance of the QueryableDataProvider class.

Declaration
public QueryableDataProvider()

Properties

AggregateDescriptions

A list of QueryableAggregateDescription that specified how the pivot should be aggregated for the groups.

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

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

A list of QueryableGroupDescription that specified how the pivot should be grouped by columns.

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

Culture

Gets or sets the CultureInfo used for grouping and formatting.

Declaration
public CultureInfo Culture { get; set; }
Property Value
System.Globalization.CultureInfo

FilterDescriptions

A list of FilterDescription that specified how the pivot items should be filtered.

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

Results

Declaration
protected override IPivotResults Results { get; }
Property Value
IPivotResults

Overrides

RowGroupDescriptions

A list of QueryableGroupDescription that specified how the pivot should be grouped by rows.

Declaration
public Collection<QueryableGroupDescription> RowGroupDescriptions { get; }
Property Value
System.Collections.ObjectModel.Collection<QueryableGroupDescription>

Source

Gets or sets the IQueryable data source.

Declaration
public IQueryable Source { get; set; }
Property Value
System.Linq.IQueryable

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
[Obsolete("Not used. Obsoleted after 2013.Q2.SP1")]
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

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
IAggregateDescription aggregateDescription

The IAggregateDescription.
System.Object aggregateFunction

The aggregate function.
Overrides

Extension Methods