ClassDateTimeGroupDescription
Used for DateTime values to group items, provide well known groups, sort and filter the groups.
Definition
Namespace:Telerik.Pivot.Core
Assembly:Telerik.Pivot.Core.dll
Syntax:
[DataContract]
public sealed class DateTimeGroupDescription : PropertyGroupDescriptionBase, INotifyPropertyChanged, ISupportInitialize, IServiceProvider, IGroupDescription, IDescriptionBase, INamed, IEditableInheritance: objectCloneableSettingsNodeDescriptionBaseGroupDescriptionBaseGroupDescriptionPropertyGroupDescriptionBaseDateTimeGroupDescription
Implements:
Inherited Members
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
[DataMember]
public DateTimeStep Step { get; set; }Property Value
Methods
CloneOverride(Cloneable)
Makes the instance a clone (deep copy) of the specified Cloneable.
Declaration
protected override void CloneOverride(Cloneable source)Parameters
source
The object to clone.
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
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>)
Returns all possible group keys for this instance.
Declaration
[SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity", Justification = "We need to check all the DateTimeSteps ")]
protected override IEnumerable<object> GetAllNames(IEnumerable<object> uniqueNames, IEnumerable<object> parentGroupNames)Parameters
uniqueNames
Enumeration of all unique group keys that were discovered after grouping.
parentGroupNames
Enumeration of all parent groups.
Returns
Returns all possible group keys for this instance.
Overrides
GetUniqueName()
Returns the member name for this description.
GroupNameFromItem(object, int)
Names a group that would contain the item.
DayGroup.
MonthGroup.
QuarterGroup.
YearGroup.
Declaration
[SuppressMessage("Microsoft.Naming", "CA2204:Literals should be spelled correctly", MessageId = "DateTime", Justification = "It is a common type.")]
[SuppressMessage("Microsoft.Naming", "CA2204:Literals should be spelled correctly", MessageId = "DateTimeOffset", Justification = "It is a common type.")]
protected override object GroupNameFromItem(object item, int level)Parameters
item
The item to group.
level
The level of grouping for this GroupDescription.
Returns
A name for the group that would contain the item.
Overrides