ClassLocalFieldDescriptionsProviderBase
A base class for various FieldInfo classes presenting local sources. An implementation of IFieldDescriptionProvider.
Definition
Namespace:Telerik.Pivot.Core.Fields
Assembly:Telerik.Pivot.Core.dll
Syntax:
public abstract class LocalFieldDescriptionsProviderBase : FieldDescriptionProviderBase, IFieldDescriptionProviderInheritance: objectFieldDescriptionProviderBaseLocalFieldDescriptionsProviderBase
Derived Classes:
Implements:
Inherited Members
Constructors
LocalFieldDescriptionsProviderBase()
Declaration
protected LocalFieldDescriptionsProviderBase()Properties
CurrentState
Gets the object which FieldDescriptions are generated.
Declaration
public object CurrentState { get; protected set; }Property Value
EnableHierarchy
Gets or sets a boolean value indicating whether field descriptions will be generated for nested properties of the objects.
Methods
GenerateDescriptionsData()
Retrieves the DescriptionsData for data source.
Declaration
protected abstract IFieldInfoData GenerateDescriptionsData()Returns
DescriptionsData instance.
GetDescriptionsDataAsync(object)
Retrieves information about all available field descriptions. This method does not block the calling thread.
Declaration
[SuppressMessage("Microsoft.Design", "CA1031:DoNotCatchGeneralExceptionTypes", Justification = "Design choice.")]
public override void GetDescriptionsDataAsync(object state)Parameters
state
Overrides
GetFieldDescriptionHierarchy(IEnumerable<IPivotFieldInfo>)
Gets the field description hierarchy.
Declaration
protected virtual ContainerNode GetFieldDescriptionHierarchy(IEnumerable<IPivotFieldInfo> fieldInfos)Parameters
fieldInfos
Collection of IPivotFieldInfo instances.
Returns
OnDescriptionsDataCompleted(GetDescriptionsDataCompletedEventArgs)
Raise GetDescriptionsDataAsyncCompleted event.
Declaration
protected override void OnDescriptionsDataCompleted(GetDescriptionsDataCompletedEventArgs args)Parameters
args
GetDescriptionsDataCompletedEventArgs
The event args used to invoke the event.
Overrides