Export (0) Print
Expand All

BindingListCollectionView Class

Represents the CollectionView for collections that implement IBindingList, such as Microsoft ActiveX Data Objects (ADO) data views.

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

public sealed class BindingListCollectionView : CollectionView, 
	IComparer, IEditableCollectionView, ICollectionViewLiveShaping, IItemProperties

The BindingListCollectionView type exposes the following members.

  NameDescription
Public methodBindingListCollectionViewInitializes an instance of BindingListCollectionView over the given list.
Top

  NameDescription
Public propertyCanAddNewGets a value that indicates whether a new item can be added to the collection.
Public propertyCanCancelEditGets a value that indicates whether the collection view can discard pending changes and restore the original values of an edited object.
Public propertyCanChangeLiveFilteringGets a value that indicates whether this view supports turning filtering data in real time on or off.
Public propertyCanChangeLiveGroupingGets a value that indicates whether this view supports turning grouping data in real time on or off.
Public propertyCanChangeLiveSortingGets a value that indicates whether this view supports turning sorting data in real time on or off.
Public propertyCanCustomFilterGets a value that indicates whether the view supports custom filtering.
Public propertyCanFilterGets a value that indicates whether the view supports callback-based filtering. (Overrides CollectionView.CanFilter.)
Public propertyCanGroupGets a value that indicates whether the view supports grouping. (Overrides CollectionView.CanGroup.)
Public propertyCanRemoveGets a value that indicates whether an item can be removed from the collection.
Public propertyCanSortGets a value that indicates whether the collection supports sorting. (Overrides CollectionView.CanSort.)
Public propertyComparerReturns an object that you can use to compare items in the view. (Inherited from CollectionView.)
Public propertyCountGets the estimated number of records in the collection. (Overrides CollectionView.Count.)
Public propertyCultureGets or sets the culture information to use during sorting. (Inherited from CollectionView.)
Public propertyCurrentAddItemGets the item that is being added during the current add transaction.
Public propertyCurrentEditItemGets the item in the collection that is being edited.
Public propertyCurrentItemGets the current item in the view. (Inherited from CollectionView.)
Public propertyCurrentPositionGets the ordinal position of the CurrentItem within the (optionally sorted and filtered) view. (Inherited from CollectionView.)
Public propertyCustomFilterGets or sets a custom filter.
Public propertyDispatcherGets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public propertyFilterGets or sets a method used to determine if an item is suitable for inclusion in the view. (Inherited from CollectionView.)
Public propertyGroupBySelectorGets or sets a delegate to select the GroupDescription as a function of the parent group and its level.
Public propertyGroupDescriptionsGets a collection of GroupDescription objects that describe how the items in the collection are grouped in the view. (Overrides CollectionView.GroupDescriptions.)
Public propertyGroupsGets the top-level groups. (Overrides CollectionView.Groups.)
Public propertyIsAddingNewGets a value that indicates whether an add transaction is in progress.
Public propertyIsCurrentAfterLastGets a value that indicates whether the CurrentItem of the view is beyond the end of the collection. (Inherited from CollectionView.)
Public propertyIsCurrentBeforeFirstGets a value that indicates whether the CurrentItem of the view is before the beginning of the collection. (Inherited from CollectionView.)
Public propertyIsDataInGroupOrderGets or sets a value that indicates whether the list of items (after applying the sort and filters, if any) is already in the correct order for grouping.
Public propertyIsEditingItemGets a value that indicates whether an edit transaction is in progress.
Public propertyIsEmptyReturns a value that indicates whether the resulting (filtered) view is empty. (Overrides CollectionView.IsEmpty.)
Public propertyIsInUseGets a value that indicates whether any object is subscribing to the events of this CollectionView. (Inherited from CollectionView.)
Public propertyIsLiveFilteringGets or sets a value that indicates whether filtering data in real time is enabled.
Public propertyIsLiveGroupingGets or sets a value that indicates whether grouping data in real time is enabled.
Public propertyIsLiveSortingGets or sets a value that indicates whether sorting data in real time is enabled.
Public propertyItemPropertiesGets a collection of objects that describes the properties of the items in the collection.
Public propertyLiveFilteringPropertiesGets a collection of strings that specify the properties that participate in filtering data in real time.
Public propertyLiveGroupingPropertiesGets a collection of strings that specify the properties that participate in grouping data in real time.
Public propertyLiveSortingPropertiesGets a collection of strings that specify the properties that participate in sorting data in real time.
Public propertyNeedsRefreshGets a value that indicates whether the view needs to be refreshed. (Inherited from CollectionView.)
Public propertyNewItemPlaceholderPositionGets or sets the position of the new item placeholder in the BindingListCollectionView.
Public propertySortDescriptionsGets a collection of SortDescription objects that describes how the items in the collection are sorted in the view. (Overrides CollectionView.SortDescriptions.)
Public propertySourceCollectionReturns the underlying unfiltered collection. (Inherited from CollectionView.)
Top

  NameDescription
Public methodAddNewStarts an add transaction and returns the pending new item.
Public methodCancelEditEnds the edit transaction and, if possible, restores the original value to the item.
Public methodCancelNewEnds the add transaction and discards the pending new item.
Public methodCheckAccessDetermines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Public methodCommitEditEnds the edit transaction and saves the pending changes.
Public methodCommitNewEnds the add transaction and saves the pending new item.
Public methodContainsReturns a value that indicates whether a given item belongs to the collection view. (Overrides CollectionView.Contains(Object).)
Public methodDeferRefreshEnters a defer cycle that you can use to merge changes to the view and delay automatic refresh. (Inherited from CollectionView.)
Public methodDetachFromSourceCollectionDetaches the underlying collection from this collection view to enable the collection view to be garbage collected. (Overrides CollectionView.DetachFromSourceCollection().)
Public methodEditItemBegins an edit transaction of the specified item.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetItemAtRetrieves the item at the specified position in the view. (Overrides CollectionView.GetItemAt(Int32).)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodIndexOfReturns the index at which the given item belongs in the collection view. (Overrides CollectionView.IndexOf(Object).)
Public methodMoveCurrentToSets the specified item to be the CurrentItem in the view. (Inherited from CollectionView.)
Public methodMoveCurrentToFirstSets the first item in the view as the CurrentItem. (Inherited from CollectionView.)
Public methodMoveCurrentToLastSets the last item in the view as the CurrentItem. (Inherited from CollectionView.)
Public methodMoveCurrentToNextSets the item after the CurrentItem in the view as the CurrentItem. (Inherited from CollectionView.)
Public methodMoveCurrentToPositionSets the item at the specified index to be the CurrentItem in the view. (Overrides CollectionView.MoveCurrentToPosition(Int32).)
Public methodMoveCurrentToPreviousSets the item before the CurrentItem in the view as the CurrentItem. (Inherited from CollectionView.)
Public methodPassesFilterReturns a value that indicates whether the specified item in the underlying collection belongs to the view. (Overrides CollectionView.PassesFilter(Object).)
Public methodRefreshRe-creates the view. (Inherited from CollectionView.)
Public methodRemoveRemoves the specified item from the collection.
Public methodRemoveAtRemoves the item at the specified position from the collection.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Public methodVerifyAccessEnforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Top

  NameDescription
Public eventCurrentChangedOccurs after the CurrentItem has changed. (Inherited from CollectionView.)
Public eventCurrentChangingOccurs when the CurrentItem is changing. (Inherited from CollectionView.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIComparer.CompareThis member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code.
Explicit interface implemetationPrivate methodIEnumerable.GetEnumeratorReturns an IEnumerator object that you can use to enumerate the items in the view. (Inherited from CollectionView.)
Explicit interface implemetationPrivate eventINotifyCollectionChanged.CollectionChangedOccurs when the view has changed. (Inherited from CollectionView.)
Explicit interface implemetationPrivate eventINotifyPropertyChanged.PropertyChangedOccurs when a property value changes. (Inherited from CollectionView.)
Top

All collections have a default CollectionView. For collections that implement IBindingListView or IBindingList, the default collection view is BindingListCollectionView. Specifically, IBindingList is required for BindingListCollectionView, and IBindingListView is an optional interface that gives additional sorting and filtering support.

If you have multiple BindingListCollectionView objects and the underlying source is a DataTable or a DataView, the view objects do not sort or filter independently. For example, if you have two BindingListCollectionView objects associated with the same DataTable and you perform sorting on one of the views, the order of items in the other view can be affected. This is because BindingListCollectionView objects use the underlying IBindingList for sorting and filtering functionalities.

For more information about collection views, see Data Binding Overview.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

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