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

Defines the fields and display format used to build one level of a collection view's grouping hierarchy.

Definition

Namespace:Telerik.WinControls.Data

Assembly:Telerik.WinControls.dll

Syntax:

C#
public class GroupDescriptor : INotifyPropertyChanged

Inheritance: objectGroupDescriptor

Derived Classes: GridGroupByExpressionTreeMapGroupDescriptor

Implements: INotifyPropertyChanged

Constructors

Initializes an empty grouping descriptor with the default group-row format.

C#
public GroupDescriptor()

Initializes one grouping level from the specified group-name descriptors.

C#
public GroupDescriptor(params SortDescriptor[] sortDescriptions)
Parameters:sortDescriptionsSortDescriptor[]

The fields and sort directions that form the group key at this level.

Initializes a grouping descriptor from an expression and a group-row format.

C#
public GroupDescriptor(string expression, string format)
Parameters:expressionstring

The expression assigned to the descriptor's group names.

formatstring

The format used by group-row summaries; null is stored as an empty string.

Initializes a grouping descriptor from an expression that identifies its group fields.

C#
public GroupDescriptor(string expression)
Parameters:expressionstring

The expression assigned to the descriptor's group names.

Properties

Gets the collection of aggregate strings associated with this grouping level.

C#
[Browsable(false)]
public StringCollection Aggregates { get; }
Property Value:

The aggregates.

Gets or sets the expression.

C#
[Browsable(true)]
public virtual string Expression { get; set; }
Property Value:

The expression.

Gets or sets the format.

C#
public string Format { get; set; }
Property Value:

The format.

Gets the group names.

C#
[Browsable(true)]
public SortDescriptorCollection GroupNames { get; }
Property Value:

The group names.

Gets the collection that currently owns this descriptor.

C#
[Browsable(false)]
public GroupDescriptorCollection Owner { get; }

The collection assigns this reference when the descriptor is added and clears it when removed.

Methods

Raises the PropertyChanged event

C#
protected virtual void OnPropertyChanged(PropertyChangedEventArgs e)
Parameters:ePropertyChangedEventArgs

A PropertyChangedEventArgs instance containing event data.

Raises the PropertyChanged event

C#
protected void OnPropertyChanged(string propertyName)
Parameters:propertyNamestring

The name of the property

Returns a string that represents this instance.

C#
public override string ToString()
Returns:

string

A string that represents this instance.

Overrides: object.ToString()

Events

Occurs when the format, expression, or group-name collection changes.

C#
public event PropertyChangedEventHandler PropertyChanged

Implements: INotifyPropertyChanged.PropertyChanged