New to Telerik UI for WinForms? Start a free 30-day trial

GroupDescription

Class

Used to group items, provide well known groups, sort and filter the groups.

Definition

Namespace:Telerik.Pivot.Core

Assembly:Telerik.WinControls.PivotGrid.dll

Syntax:

[DataContract]
public abstract class GroupDescription : GroupDescriptionBase, INotifyPropertyChanged, ISupportInitialize, IServiceProvider, IGroupDescription, IDescriptionBase, INamed, IEditable

Inheritance: objectCloneableSettingsNodeDescriptionBaseGroupDescriptionBaseGroupDescription...

Derived Classes: OlapGroupDescriptionBasePropertyGroupDescriptionBaseQueryableGroupDescription

Implements: IDescriptionBaseIEditableIGroupDescriptionINamedINotifyPropertyChangedIServiceProviderISupportInitialize...

Inherited Members GroupDescriptionBase.GroupComparerGroupDescriptionBase.SortOrderDescriptionBase.GetDisplayName()DescriptionBase.GetUniqueName()DescriptionBase.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

GroupDescription()

protected GroupDescription()

Gets or sets value that indicates whether the subtotals for the GroupDescription should be displayed when possible or not. The default value is true - the subtotals are displayed when possible (depending on the subtotals position properties of RadPivotGrid).

[DataMember]
public bool AutoShowSubTotals { get; set; }

GroupFilter

Gets a GroupFilter implementation for this instance that would be used to filter the groups.

[DataMember]
public GroupFilter GroupFilter { get; set; }

ShowGroupsWithNoData

bool

Gets or sets value that indicates whether well known groups should be created even if there are no items for them.

Grouping by days may require groups for the empty days in the current month. Grouping by persons may require groups all persons even if they do not contain any items within the current context.

[DataMember]
public bool ShowGroupsWithNoData { get; set; }

Methods

CloneCore(Cloneable)

Creates a deep copy of this group description by copying core properties including sort order and group comparer. This method ensures that cloned instances maintain their grouping and sorting configuration independently.

protected override void CloneCore(Cloneable source)

Parameters:sourceCloneable

The source group description to clone from.

Overrides: GroupDescriptionBase.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).

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

Returns all possible group keys for this instance.

protected virtual IEnumerable<object> GetAllNames(IEnumerable<object> uniqueNames, IEnumerable<object> parentGroupNames)

Parameters:uniqueNamesIEnumerable<object>

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

parentGroupNamesIEnumerable<object>

Enumeration of all parent groups.

Returns:

IEnumerable<object>

Returns all possible group keys for this instance.