Class LocalFieldDescriptionsProviderBase

A base class for various FieldInfo classes presenting local sources. An implementation of IFieldDescriptionProvider.

Inheritance
System.Object
FieldDescriptionProviderBase
LocalFieldDescriptionsProviderBase
LocalDataSourceFieldDescriptionsProvider
Inherited Members
Namespace: Telerik.Pivot.Core.Fields
Assembly: Telerik.Pivot.Core.dll

Syntax

public abstract class LocalFieldDescriptionsProviderBase : FieldDescriptionProviderBase, IFieldDescriptionProvider

Constructors

LocalFieldDescriptionsProviderBase()

Declaration
protected LocalFieldDescriptionsProviderBase()

Properties

CurrentState

Gets the object which FieldDescriptions are generated.

Declaration
public object CurrentState { get; protected set; }
Property Value
System.Object

EnableHierarchy

Gets or sets a boolean value indicating whether field descriptions will be generated for nested properties of the objects.

Declaration
public bool EnableHierarchy { get; set; }
Property Value
System.Boolean

Methods

GenerateDescriptionsData()

Retrieves the DescriptionsData for data source.

Declaration
protected abstract IFieldInfoData GenerateDescriptionsData()
Returns
IFieldInfoData

DescriptionsData instance.

GetDescriptionsDataAsync(Object)

Retrieves information about all available field descriptions. This method does not block the calling thread.

Declaration
public override void GetDescriptionsDataAsync(object state)
Parameters
System.Object state

Overrides

GetFieldDescriptionHierarchy(IEnumerable<IPivotFieldInfo>)

Gets the field description hierarchy.

Declaration
protected virtual ContainerNode GetFieldDescriptionHierarchy(IEnumerable<IPivotFieldInfo> fieldInfos)
Parameters
System.Collections.Generic.IEnumerable<IPivotFieldInfo> fieldInfos

Collection of IPivotFieldInfo instances.
Returns
ContainerNode

OnDescriptionsDataCompleted(GetDescriptionsDataCompletedEventArgs)

Raise GetDescriptionsDataAsyncCompleted event.

Declaration
protected override void OnDescriptionsDataCompleted(GetDescriptionsDataCompletedEventArgs args)
Parameters
GetDescriptionsDataCompletedEventArgs args

The event args used to invoke the event.
Overrides

Extension Methods