BindingList<T>.ApplySortCore Method

Reference

Definition

Namespace:: System.ComponentModel

Assemblies:: netstandard.dll, System.ComponentModel.TypeConverter.dll

Assembly:: System.ComponentModel.TypeConverter.dll

Assembly:: System.dll

Assembly:: netstandard.dll

Source:: BindingList.cs

Source:: BindingList.cs

Source:: BindingList.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Sorts the items if overridden in a derived class; otherwise, throws a NotSupportedException.

protected:
 virtual void ApplySortCore(System::ComponentModel::PropertyDescriptor ^ prop, System::ComponentModel::ListSortDirection direction);

protected virtual void ApplySortCore(System.ComponentModel.PropertyDescriptor prop, System.ComponentModel.ListSortDirection direction);

abstract member ApplySortCore : System.ComponentModel.PropertyDescriptor * System.ComponentModel.ListSortDirection -> unit
override this.ApplySortCore : System.ComponentModel.PropertyDescriptor * System.ComponentModel.ListSortDirection -> unit

Protected Overridable Sub ApplySortCore (prop As PropertyDescriptor, direction As ListSortDirection)

Parameters

prop: PropertyDescriptor

A PropertyDescriptor that specifies the property to sort on.

direction: ListSortDirection

One of the ListSortDirection values.

Exceptions

NotSupportedException

Method is not overridden in a derived class.

Remarks

The BindingList<T> class does not provide a base implementation of sorting, so ApplySortCore always throws a NotSupportedException by default. To enable sorting, derive from BindingList<T> and perform the following tasks:

Override ApplySortCore and implement sorting, raising the ListChanged event when sorting is complete.
Override RemoveSortCore and implement sort removal.
Override SupportsSortingCore and set SupportsSortingCore to true.

In addition, you may want to implement the supplemental SortDirectionCore and SortPropertyCore sorting properties.

Applies to

Product	Versions
.NET	Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework	2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard	2.0, 2.1

Share via