Class DateTimeGroupDescription

Used for System.DateTime values to group items, provide well known groups, sort and filter the groups.

Inheritance
System.Object
Cloneable
SettingsNode
DescriptionBase
GroupDescriptionBase
GroupDescription
PropertyGroupDescriptionBase
DateTimeGroupDescription
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Pivot.Core
Assembly: Telerik.WinControls.PivotGrid.dll

Syntax

public sealed class DateTimeGroupDescription : PropertyGroupDescriptionBase, INotifyPropertyChanged, ISupportInitialize, IObservableServiceProvider, IServiceProvider, IGroupDescription, IDescriptionBase, ISortableGroupDescription, INamed, IEditable, IDescriptionsReferencing, IGrandTotalSupport, IInitializeDescription, ILabelGroupFilterHost, IValueGroupFilterHost, IGroupsCountFilterHost, IGroupsPercentFilterHost, IGroupsSumFilterHost, ICanShowEmptyGroups, IFilteringDescription, IDistinctValuesDescription, IConditionFactory, IFilterOperatorsProvider

Constructors

DateTimeGroupDescription()

Initializes a new instance of the DateTimeGroupDescription class.

Declaration
public DateTimeGroupDescription()

Properties

Step

Gets or sets the step of the grouping. Items will be put in an IGroup with a Name based on the DateTimeStep. DayGroup. MonthGroup. QuarterGroup. YearGroup. WeekGroup. HourGroup - not auto generated by default. MinuteGroup - not auto generated by default. SecondGroup - not auto generated by default.

Declaration
public DateTimeStep Step { get; set; }
Property Value
DateTimeStep

Methods

CloneOverride(Cloneable)

When overridden in derived classes, performs type-specific cloning operations for the derived class properties. This method is called by CloneCore(Cloneable) after base properties have been copied.

Declaration
protected override void CloneOverride(Cloneable source)
Parameters
Cloneable source

The source object to clone from.
Overrides
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).

CreateInstanceCore()

When implemented in a derived class, creates a new instance of the Cloneable derived class.

Declaration
protected override Cloneable CreateInstanceCore()
Returns
Cloneable

New instance for cloning.
Overrides
Remarks

Do not call this method directly (except when calling base in an implementation). This method is called internally by the Clone() method whenever a new instance of the Cloneable is created. Notes to Inheritors. Every Cloneable derived class must implement this method. A typical implementation is to simply call the default constructor and return the result.

GetAllNames(IEnumerable<Object>, IEnumerable<Object>)

Gets all possible group names by combining unique names from the data with calculated items. This method merges the actual data group names with any defined calculated items to provide a complete list of available groups.

Declaration
protected override IEnumerable<object> GetAllNames(IEnumerable<object> uniqueNames, IEnumerable<object> parentGroupNames)
Parameters
System.Collections.Generic.IEnumerable<System.Object> uniqueNames

The unique group names found in the actual data.
System.Collections.Generic.IEnumerable<System.Object> parentGroupNames

The parent group names in the hierarchy.
Returns
System.Collections.Generic.IEnumerable<System.Object>

A combined enumerable of unique names and calculated items.
Overrides

GetUniqueName()

Gets the unique name for this group description, which is the property name used for grouping. This unique name is used to identify and distinguish this group description from others.

Declaration
public override string GetUniqueName()
Returns
System.String

The property name that serves as the unique identifier for this group description.
Overrides

GroupNameFromItem(Object, Int32)

Names a group that would contain the item. DayGroup. MonthGroup. QuarterGroup. YearGroup.

Declaration
protected override object GroupNameFromItem(object item, int level)
Parameters
System.Object item

The item to group.
System.Int32 level

The level of grouping for this GroupDescription.
Returns
System.Object

A name for the group that would contain the item.
Overrides

Extension Methods