Class
QueryableDataProvider

Represents an IDataProvider that works with IQueryable sources.

Definition

Namespace:Telerik.Pivot.Queryable

Assembly:Telerik.Pivot.DataProviders.Queryable.dll

Syntax:

cs-api-definition

public class QueryableDataProvider : DataProviderBase, IDataProvider, INotifyPropertyChanged, ISupportInitialize

Inheritance: objectDataProviderBaseQueryableDataProvider

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.CreateInstanceCore()DataProviderBase.FreezeCore(bool)DataProviderBase.FieldInfosDataProviderBase.DeferUpdatesDataProviderBase.StatusDataProviderBase.AggregatesPositionDataProviderBase.AggregatesLevelDataProviderBase.FieldDescriptionsProviderDataProviderBase.HasPendingChangesDataProviderBase.SettingsDataProviderBase.StatusChangedDataProviderBase.PropertyChangedDataProviderBase.PrepareDescriptionForField

Constructors

QueryableDataProvider()

Initializes a new instance of the QueryableDataProvider class.

Declaration

cs-api-definition

public QueryableDataProvider()

Properties

AggregateDescriptions

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

Declaration

cs-api-definition

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

Property Value

Collection<QueryableAggregateDescriptionBase>

CalculatedFields

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

Declaration

cs-api-definition

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

Property Value

Collection<CalculatedField>

ColumnGroupDescriptions

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

Declaration

cs-api-definition

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

Property Value

Collection<QueryableGroupDescription>

Culture

Gets or sets the CultureInfo used for grouping and formatting.

Declaration

cs-api-definition

public CultureInfo Culture { get; set; }

Property Value

CultureInfo

FilterDescriptions

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

Declaration

cs-api-definition

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

Property Value

Collection<QueryableFilterDescription>

Results

Declaration

cs-api-definition

protected override IPivotResults Results { get; }

Property Value

IPivotResults

Overrides DataProviderBase.Results

RowGroupDescriptions

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

Declaration

cs-api-definition

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

Property Value

Collection<QueryableGroupDescription>

Source

Gets or sets the IQueryable data source.

Declaration

cs-api-definition

public IQueryable Source { get; set; }

Property Value

IQueryable

State

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

Declaration

cs-api-definition

public override object State { get; }

Property Value

object

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

Overrides DataProviderBase.State

Methods

BlockUntilRefreshCompletes()

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

Declaration

cs-api-definition

public override void BlockUntilRefreshCompletes()

Overrides DataProviderBase.BlockUntilRefreshCompletes()

CreateFieldDescriptionsProvider()

Creates an instance of IFieldDescriptionProvider for this IDataProvider.

Declaration

cs-api-definition

protected override IFieldDescriptionProvider CreateFieldDescriptionsProvider()

Returns

IFieldDescriptionProvider

Overrides DataProviderBase.CreateFieldDescriptionsProvider()

GetAggregateDescriptionForFieldDescriptionCore(IPivotFieldInfo)

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

Declaration

cs-api-definition

protected override IAggregateDescription GetAggregateDescriptionForFieldDescriptionCore(IPivotFieldInfo description)

Parameters

description

IPivotFieldInfo

A IPivotFieldInfo instance.

Returns

IAggregateDescription

An IAggregateDescription instance.

Overrides DataProviderBase.GetAggregateDescriptionForFieldDescriptionCore(IPivotFieldInfo)

GetAggregateFunctionsForAggregateDescription(IAggregateDescription)

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

Declaration

cs-api-definition

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

Parameters

aggregateDescription

IAggregateDescription

The IAggregateDescription.

Returns

IEnumerable<object>

A list of possible aggregate functions.

Overrides DataProviderBase.GetAggregateFunctionsForAggregateDescription(IAggregateDescription)

GetFilterDescriptionForFieldDescriptionCore(IPivotFieldInfo)

Returns a filter description suitable for the supplied field description.

Declaration

cs-api-definition

protected override FilterDescription GetFilterDescriptionForFieldDescriptionCore(IPivotFieldInfo description)

Parameters

description

IPivotFieldInfo

A IPivotFieldInfo instance.

Returns

FilterDescription

An FilterDescription instance.

Overrides DataProviderBase.GetFilterDescriptionForFieldDescriptionCore(IPivotFieldInfo)

GetGroupDescriptionForFieldDescriptionCore(IPivotFieldInfo)

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

Declaration

cs-api-definition

protected override IGroupDescription GetGroupDescriptionForFieldDescriptionCore(IPivotFieldInfo description)

Parameters

description

IPivotFieldInfo

A IPivotFieldInfo instance.

Returns

IGroupDescription

An IGroupDescription instance.

Overrides DataProviderBase.GetGroupDescriptionForFieldDescriptionCore(IPivotFieldInfo)

RefreshOverride()

Recreates the Results.

Declaration

cs-api-definition

protected override void RefreshOverride()

Overrides DataProviderBase.RefreshOverride()

SetAggregateFunctionToAggregateDescription(IAggregateDescription, object)

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

Declaration

cs-api-definition

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

Parameters

aggregateDescription

IAggregateDescription

The IAggregateDescription.

aggregateFunction

object

The aggregate function.

Overrides DataProviderBase.SetAggregateFunctionToAggregateDescription(IAggregateDescription, object)

ClassQueryableDataProvider

Class
QueryableDataProvider