Class
PropertyGroupDescriptionBase

Base class used to group items, provide well known groups, sort and filter the groups for a LocalDataSourceProvider based on the item's PropertyName value.

Definition

Namespace:Telerik.Pivot.Core

Assembly:Telerik.Pivot.Core.dll

Syntax:

cs-api-definition
[DataContract]
public abstract class PropertyGroupDescriptionBase : GroupDescription, INotifyPropertyChanged, ISupportInitialize, IServiceProvider, IGroupDescription, IDescriptionBase, INamed, IEditable

Inheritance: objectCloneableSettingsNodeDescriptionBaseGroupDescriptionBaseGroupDescriptionPropertyGroupDescriptionBase

Derived Classes: DateTimeGroupDescriptionDoubleGroupDescriptionPropertyGroupDescription

Implements: IDescriptionBaseIEditableIGroupDescriptionINamedINotifyPropertyChangedIServiceProviderISupportInitialize

Inherited Members GroupDescription.ShowGroupsWithNoDataGroupDescription.AutoShowSubTotalsGroupDescription.GroupFilterGroupDescriptionBase.GroupComparerGroupDescriptionBase.SortOrderDescriptionBase.DisplayNameDescriptionBase.CustomNameSettingsNode.NotifyServicesChanged()SettingsNode.NotifySettingsChanged(SettingsChangedEventArgs)SettingsNode.OnSettingsChanged(SettingsChangedEventArgs)SettingsNode.BeginEdit()SettingsNode.BeginInit()SettingsNode.EndInit()SettingsNode.GetService(Type)SettingsNode.OnPropertyChanged(string)SettingsNode.RemoveSettingsChild(SettingsNode)SettingsNode.AddSettingsChild(SettingsNode)SettingsNode.GetServiceOverride(Type)SettingsNode.OnEnteredEditScope()SettingsNode.OnExitingEditScope()SettingsNode.ParentSettingsNode.SettingsChangedSettingsNode.ServicesChangedSettingsNode.PropertyChangedCloneable.Clone()Cloneable.CreateInstanceCore()

Constructors

PropertyGroupDescriptionBase()

Declaration

cs-api-definition
protected PropertyGroupDescriptionBase()

Properties

CalculatedItems

Gets the collection of calculated items that are used to initialize a group with a set of subgroups and summarized value.

Declaration

cs-api-definition
[DataMember]
public Collection<CalculatedItem> CalculatedItems { get; }

Property Value

Collection<CalculatedItem>

Culture

Gets the CultureInfo from the LocalDataSourceProvider.

Declaration

cs-api-definition
protected CultureInfo Culture { get; }

Property Value

CultureInfo

PropertyName

Gets or sets a value identifying a property on the grouped items.

Declaration

cs-api-definition
[DataMember]
public string PropertyName { get; set; }

Property Value

string

Methods

CloneCore(Cloneable)

Makes the instance a clone (deep copy) of the specified Cloneable.

Declaration

cs-api-definition
protected override sealed void CloneCore(Cloneable source)

Parameters

source

Cloneable

The object to clone.

Overrides GroupDescription.CloneCore(Cloneable)

Remarks

Notes to Inheritors If you derive from Cloneable, you may need to override this method to copy all properties. It is essential that all implementations call the base implementation of this method (if you don't call base you should manually copy all needed properties including base properties).

CloneOverride(Cloneable)

Makes the instance a clone (deep copy) of the specified Cloneable.

Declaration

cs-api-definition
protected abstract void CloneOverride(Cloneable source)

Parameters

source

Cloneable

The object to clone.

Remarks

Notes to Inheritors If you derive from Cloneable, you need to override this method to copy all properties. It is essential that all implementations call the base implementation of this method (if you don't call base you should manually copy all needed properties including base properties).

GetAllNames(IEnumerable<object>, IEnumerable<object>)

Returns all possible group keys for this instance.

Declaration

cs-api-definition
protected override IEnumerable<object> GetAllNames(IEnumerable<object> uniqueNames, IEnumerable<object> parentGroupNames)

Parameters

uniqueNames

IEnumerable<object>

Enumeration of all unique group keys that were discovered after grouping.

parentGroupNames

IEnumerable<object>

Enumeration of all parent groups.

Returns

IEnumerable<object>

Returns all possible group keys for this instance.

Overrides GroupDescription.GetAllNames(IEnumerable<object>, IEnumerable<object>)

GetDisplayName()

Gets the display-friendly name.

Declaration

cs-api-definition
protected override string GetDisplayName()

Returns

string

A string name.

Overrides DescriptionBase.GetDisplayName()

GetUniqueName()

Returns the member name for this description.

Declaration

cs-api-definition
public override string GetUniqueName()

Returns

string

Overrides DescriptionBase.GetUniqueName()

GroupNameFromItem(object, int)

Return a name for group that would contain the item.

Declaration

cs-api-definition
protected virtual object GroupNameFromItem(object item, int level)

Parameters

item

object

The item to group.

level

int

The level of grouping for this GroupDescription.

Returns

object

A name for the group that would contain the item.