New to Telerik UI for WPFStart a free 30-day trial

Provides Cube data access and operations using Xmla.

Definition

Constructors

Initializes a new instance of the XmlaDataProvider class.

C#
public XmlaDataProvider()

Properties

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

C#
public Collection<XmlaAggregateDescription> AggregateDescriptions { get; }

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

C#
public Collection<XmlaGroupDescription> ColumnGroupDescriptions { get; }

Gets or sets the connection settings that are used for establishing connection to the data server.

C#
public XmlaConnectionSettings ConnectionSettings { get; set; }
Property Value:

The connection settings.

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

C#
public Collection<XmlaFilterDescription> FilterDescriptions { get; }

Results

IPivotResults

C#
protected override IPivotResults Results { get; }

Overrides: DataProviderBase.Results

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

C#
public Collection<XmlaGroupDescription> 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)