Class GroupDescription

Provides a base class for defining how to divide the items in a collection into groups.

Inheritance

System.Object

GroupDescription

PropertyGroupDescription

Implements

System.ComponentModel.INotifyPropertyChanged

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: System.ComponentModel

Assembly: OpenSilver.dll

Syntax

public abstract class GroupDescription : INotifyPropertyChanged

Constructors

GroupDescription()

Initializes a new instance of the GroupDescription class.

Declaration

protected GroupDescription()

Properties

CustomSort

Gets or sets a custom comparer that sorts groups using an object that implements System.Collections.IComparer.

Declaration

public IComparer CustomSort { get; set; }

Property Value

Type	Description
System.Collections.IComparer	A custom comparer that sorts groups using an object that implements System.Collections.IComparer.

GroupNames

Gets the collection of group names.

Declaration

public ObservableCollection<object> GroupNames { get; }

Property Value

Type	Description
System.Collections.ObjectModel.ObservableCollection<System.Object>	The collection of group names.

SortDescriptions

Gets the collection of sort criteria in which to sort the groups.

Declaration

public SortDescriptionCollection SortDescriptions { get; }

Property Value

Type	Description
SortDescriptionCollection	The collection of sort criteria in which to sort the groups.

Methods

GroupNameFromItem(Object, Int32, CultureInfo)

Returns the group name or names for the specified item.

Declaration

public abstract object GroupNameFromItem(object item, int level, CultureInfo culture)

Parameters

Type	Name	Description
System.Object	item	The item to return the group name for.
System.Int32	level	The level of the group within the grouping hierarchy.
System.Globalization.CultureInfo	culture	The culture information that affects grouping.

Returns

Type	Description
System.Object	An object that represents the group name or names.

NamesMatch(Object, Object)

Indicates whether the specified item belongs in the specified group.

Declaration

public virtual bool NamesMatch(object groupName, object itemName)

Parameters

Type	Name	Description
System.Object	groupName	The name of the group to check.
System.Object	itemName	The name of the item to check.

Returns

Type	Description
System.Boolean	true if the item belongs in the group; otherwise, false.

OnPropertyChanged(PropertyChangedEventArgs)

Raises the PropertyChanged event.

Declaration

protected virtual void OnPropertyChanged(PropertyChangedEventArgs e)

Parameters

Type	Name	Description
System.ComponentModel.PropertyChangedEventArgs	e	The event data.

Events

PropertyChanged

Occurs when a property value has changed.

Declaration

protected virtual event PropertyChangedEventHandler PropertyChanged

Event Type

Type	Description
System.ComponentModel.PropertyChangedEventHandler

Explicit Interface Implementations

INotifyPropertyChanged.PropertyChanged

This event is raised when a property of the group description has changed.

Declaration

event PropertyChangedEventHandler INotifyPropertyChanged.PropertyChanged

Returns

Type	Description
System.ComponentModel.PropertyChangedEventHandler

Implements

System.ComponentModel.INotifyPropertyChanged