Class QueryableDataProvider

Provides pivot data operations for IQueryable data sources using LINQ expressions. This data provider enables pivot operations on in-memory collections, Entity Framework contexts, and other LINQ-compatible data sources with support for dynamic grouping, filtering, and aggregation.

Inheritance
System.Object
DataProviderBase
QueryableDataProvider
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Pivot.Queryable
Assembly: Telerik.WinControls.PivotGrid.dll

Syntax

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

Constructors

QueryableDataProvider()

Initializes a new instance of the QueryableDataProvider class with default pivot engine. Sets up the provider for processing IQueryable data sources with LINQ-based pivot operations.

Declaration
public QueryableDataProvider()

Properties

AggregateDescriptions

Gets a collection of QueryableAggregateDescriptionBase objects that specify how data should be aggregated within the intersection of row and column groups. These define the calculated values displayed in pivot cells using LINQ aggregate functions.

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

CalculatedFields

Gets a collection of CalculatedField objects that define calculated aggregate values. Calculated fields allow creating custom expressions and formulas that can be used as aggregate values in the pivot.

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

ColumnGroupDescriptions

Gets a collection of QueryableGroupDescription objects that specify how the pivot data should be grouped by columns. Column groupings create the hierarchical structure displayed at the top of the pivot grid using LINQ expressions.

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

Culture

Gets or sets the System.Globalization.CultureInfo used for grouping, formatting, and date/time operations. This culture affects how data is grouped and displayed in different locales.

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

FilterDescriptions

Gets a collection of QueryableFilterDescription objects that specify how pivot items should be filtered. Filters are applied to the IQueryable source before grouping and aggregation operations are performed.

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

Results

Gets the current pivot calculation results containing the processed data from the IQueryable source. This property provides access to the aggregated and grouped data ready for display in pivot controls.

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

Overrides

RowGroupDescriptions

Gets a collection of QueryableGroupDescription objects that specify how the pivot data should be grouped by rows. Row groupings create the hierarchical structure displayed on the left side of the pivot grid using LINQ expressions.

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

Source

Gets or sets the IQueryable data source for pivot operations. This can be any IQueryable implementation including LINQ to Objects collections, Entity Framework contexts, or other LINQ providers that support the required query operations.

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

State

Gets the current state object representing the IQueryable source for this data provider. This state is used for field description retrieval and connection management.

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

The Source object representing the current provider state.
Overrides

Methods

BlockUntilRefreshCompletes()

Blocks the calling thread until the current refresh operation completes. For queryable data provider, this waits for the parallel processing engine to complete all operations.

Declaration
public override void BlockUntilRefreshCompletes()
Overrides

CreateFieldDescriptionsProvider()

Creates a field description provider for retrieving metadata and field information from the IQueryable data source. This provider is used to discover available properties and their types in the source data.

Declaration
protected override IFieldDescriptionProvider CreateFieldDescriptionsProvider()
Returns
IFieldDescriptionProvider

A new QueryableFieldDescriptionsProvider instance for analyzing the queryable source.
Overrides

GetAggregateDescriptionForFieldDescriptionCore(IPivotFieldInfo)

Creates an aggregate description for the specified field that can be used in queryable pivot operations. The description is configured based on the field type, using appropriate aggregate functions for numeric vs non-numeric data.

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

The pivot field information to create an aggregate description for.
Returns
IAggregateDescription

A QueryableAggregateDescriptionBase configured for the specified field.
Overrides
Exceptions
System.ArgumentNullException

Thrown when description is null.

GetFilterDescriptionForFieldDescriptionCore(IPivotFieldInfo)

Creates a filter description for the specified field that can be used in queryable pivot filtering operations. The description is configured with the field name for property-based filtering using LINQ expressions.

Declaration
protected override FilterDescription GetFilterDescriptionForFieldDescriptionCore(IPivotFieldInfo description)
Parameters
IPivotFieldInfo description

The pivot field information to create a filter description for.
Returns
FilterDescription

A QueryablePropertyFilterDescription configured for the specified field.
Overrides
Exceptions
System.ArgumentNullException

Thrown when description is null.

GetGroupDescriptionForFieldDescriptionCore(IPivotFieldInfo)

Creates a group description for the specified field that can be used in queryable pivot grouping operations. The description type is chosen based on the field data type, supporting numeric ranges, date/time steps, and property grouping.

Declaration
protected override IGroupDescription GetGroupDescriptionForFieldDescriptionCore(IPivotFieldInfo description)
Parameters
IPivotFieldInfo description

The pivot field information to create a group description for.
Returns
IGroupDescription

A QueryableGroupDescription configured for the specified field type.
Overrides
Exceptions
System.ArgumentNullException

Thrown when description is null.

RefreshOverride()

Performs the core refresh operation by generating LINQ queries, executing them against the IQueryable source, and processing the results. This method handles field initialization, query generation, and result processing.

Declaration
protected override void RefreshOverride()
Overrides

Extension Methods