PropertyGroupDescription Class

July 28, 2014

Describes the grouping of items by using a property name as the criteria.

System.Object
  System.ComponentModel.GroupDescription
    System.Windows.Data.PropertyGroupDescription

Namespace:  System.Windows.Data
Assembly:  System.Windows (in System.Windows.dll)

'Declaration
Public Class PropertyGroupDescription _
	Inherits GroupDescription

The PropertyGroupDescription type exposes the following members.

  NameDescription
Public methodPropertyGroupDescriptionInitializes a new instance of the PropertyGroupDescription class.
Public methodPropertyGroupDescription(String)Initializes a new instance of the PropertyGroupDescription class with the specified property name.
Public methodPropertyGroupDescription(String, IValueConverter)Initializes a new instance of the PropertyGroupDescription class with the specified property name and converter.
Public methodPropertyGroupDescription(String, IValueConverter, StringComparison)Initializes a new instance of the PropertyGroupDescription class with the specified property name, converter, and string comparison.
Top

  NameDescription
Public propertyConverterGets or sets a converter to apply to the property value or the item to produce the final value that is used to determine which group(s) an item belongs to.
Public propertyGroupNamesGets the collection of group names. (Inherited from GroupDescription.)
Public propertyPropertyNameGets or sets the name of the property that is used to determine which group(s) an item belongs to.
Public propertyStringComparisonGets or sets a StringComparison value that specifies the comparison between the value of an item (as determined by PropertyName and Converter) and the name of a group.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodGroupNameFromItemReturns the group name(s) for the specified item. (Overrides GroupDescription.GroupNameFromItem(Object, Int32, CultureInfo).)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodNamesMatchReturns a value that indicates whether the group name and the item name match, which indicates that the item belongs to the group. (Overrides GroupDescription.NamesMatch(Object, Object).)
Protected methodOnPropertyChangedRaises the PropertyChanged event. (Inherited from GroupDescription.)
Public methodShouldSerializeGroupNamesIndicates whether the group names should be serialized. (Inherited from GroupDescription.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Protected eventPropertyChangedOccurs when a property value has changed. (Inherited from GroupDescription.)
Top

  NameDescription
Explicit interface implemetationPrivate eventINotifyPropertyChanged.PropertyChangedFor a description of this member, see PropertyChanged. (Inherited from GroupDescription.)
Top

Views support the functionality of grouping, which allows the user to partition the collection in the collection view into logical groups. The groups can be explicit, where the user supplies a list of groups, or implicit, where the groups are generated dynamically depending on the data.

PropertyGroupDescription allows you to create implicit groups based on a property value. To generate groups based on a property, set the PropertyName property. To change the value that is eventually used for grouping before the groups are generated, use the Converter property to supply a value converter. For example, you might want to group items based on the first letter of a name. If the PropertyName property is not set, the item itself is passed to the value converter. The converter can return a collection, which indicates the items can appear in more than one group.

You can also use the StringComparison property to define how string comparison should occur.

Windows Phone OS

Supported in: 8.1, 8.0, 7.1

Windows Phone

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Show:
© 2014 Microsoft