ICollectionViewLiveShaping Interface

.NET Framework (current version)
 

Defines properties that enables sorting, grouping, and filtering on a CollectionView in real time.

Namespace:   System.ComponentModel
Assembly:  WindowsBase (in WindowsBase.dll)

public interface ICollectionViewLiveShaping

NameDescription
System_CAPS_pubpropertyCanChangeLiveFiltering

Gets a value that indicates whether the collection view supports turning filtering data in real time on or off.

System_CAPS_pubpropertyCanChangeLiveGrouping

Gets a value that indicates whether the collection view supports turning grouping data in real time on or off.

System_CAPS_pubpropertyCanChangeLiveSorting

Gets a value that indicates whether the collection view supports turning sorting data in real time on or off.

System_CAPS_pubpropertyIsLiveFiltering

Gets or sets a value that indicates whether filtering data in real time is enabled.

System_CAPS_pubpropertyIsLiveGrouping

Gets or sets a value that indicates whether grouping data in real time is enabled.

System_CAPS_pubpropertyIsLiveSorting

Gets or sets a value that indicates whether sorting in real time is enabled.

System_CAPS_pubpropertyLiveFilteringProperties

Gets a collection of strings that specify the properties that participate in filtering data in real time.

System_CAPS_pubpropertyLiveGroupingProperties

Gets a collection of strings that specify the properties that participate in grouping data in real time.

System_CAPS_pubpropertyLiveSortingProperties

Gets a collection of strings that specify the properties that participate in sorting data in real time.

When live sorting, grouping, or filtering is enabled, a CollectionView will rearrange the position of data in the CollectionView when the data is modified. For example, suppose that an application uses a DataGrid to list stocks in a stock market and the stocks are sorted by stock value. If live sorting is enabled on the stocks' CollectionView, a stock's position in the DataGrid moves when the value of the stock becomes greater or less than another stock's value.

The ListCollectionView, BindingListCollectionView, and ItemCollection classes implement the ICollectionViewLiveShaping interface. The CollectionViewSource class also implements the properties defined by ICollectionViewLiveShaping to enable setting the properties in XAML.

Implement this interface on your custom CollectionView to support sorting, grouping, and filtering data in real time. Your CollectionView can implement the sorting, grouping, and filtering operations itself, or you can delegate one or more of them to another object, such as the underlying collection. If you delegate the shaping operations, the CollectionView might not have control over whether live shaping is enabled. Your CollectionView must accept the behavior of the object to which it delegates. In this case, set the appropriate CanChange* properties to false. If your CollectionView knows whether the delegate object supports live shaping, it can set the appropriate IsLive* properties to the known value. Otherwise, the CollectionView should set the IsLive* properties to null.

.NET Framework
Available since 4.5
Return to top
Show: