Home Library Learn Downloads Support Community
Sign in | United States - English | |
0 out of 2 rated this helpful - Rate this topic

BindingListCollectionView Class

.NET Framework 4

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

System.Object
  System.Windows.Threading.DispatcherObject
    System.Windows.Data.CollectionView
      System.Windows.Data.BindingListCollectionView

Namespace:  System.Windows.Data
Assembly:  PresentationFramework (in PresentationFramework.dll)
C#
C++
F#
VB
Copy 
public sealed class BindingListCollectionView : CollectionView, 
	IComparer, IEditableCollectionView, IItemProperties

The BindingListCollectionView type exposes the following members.

  Name Description
Public method BindingListCollectionView Initializes an instance of BindingListCollectionView over the given list.
Top
  Name Description
Public property CanAddNew Gets a value that indicates whether a new item can be added to the collection.
Public property CanCancelEdit Gets a value that indicates whether the collection view can discard pending changes and restore the original values of an edited object.
Public property CanCustomFilter Gets a value that indicates whether the view supports custom filtering.
Public property CanFilter Gets a value that indicates whether the view supports callback-based filtering. (Overrides CollectionView.CanFilter.)
Public property CanGroup Gets a value that indicates whether the view supports grouping. (Overrides CollectionView.CanGroup.)
Public property CanRemove Gets a value that indicates whether an item can be removed from the collection.
Public property CanSort Gets a value that indicates whether the collection supports sorting. (Overrides CollectionView.CanSort.)
Public property Comparer Returns an object that you can use to compare items in the view. (Inherited from CollectionView.)
Public property Count Gets the estimated number of records in the collection. (Overrides CollectionView.Count.)
Public property Culture Gets or sets the culture information to use during sorting. (Inherited from CollectionView.)
Public property CurrentAddItem Gets the item that is being added during the current add transaction.
Public property CurrentEditItem Gets the item in the collection that is being edited.
Public property CurrentItem Gets the current item in the view. (Inherited from CollectionView.)
Public property CurrentPosition Gets the ordinal position of the CurrentItem within the (optionally sorted and filtered) view. (Inherited from CollectionView.)
Public property CustomFilter Gets or sets a custom filter.
Public property Dispatcher Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject.)
Public property Filter Gets or sets a method used to determine if an item is suitable for inclusion in the view. (Inherited from CollectionView.)
Public property GroupBySelector Gets or sets a delegate to select the GroupDescription as a function of the parent group and its level.
Public property GroupDescriptions Gets a collection of GroupDescription objects that describe how the items in the collection are grouped in the view. (Overrides CollectionView.GroupDescriptions.)
Public property Groups Gets the top-level groups. (Overrides CollectionView.Groups.)
Public property IsAddingNew Gets a value that indicates whether an add transaction is in progress.
Public property IsCurrentAfterLast Gets a value that indicates whether the CurrentItem of the view is beyond the end of the collection. (Inherited from CollectionView.)
Public property IsCurrentBeforeFirst Gets a value that indicates whether the CurrentItem of the view is before the beginning of the collection. (Inherited from CollectionView.)
Protected property IsCurrentInSync Gets a value that indicates whether the CurrentItem is at the CurrentPosition. (Inherited from CollectionView.)
Public property IsDataInGroupOrder Gets 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.
Protected property IsDynamic Gets a value that indicates whether the underlying collection provides change notifications. (Inherited from CollectionView.)
Public property IsEditingItem Gets a value that indicates whether an edit transaction is in progress.
Public property IsEmpty Returns a value that indicates whether the resulting (filtered) view is empty. (Overrides CollectionView.IsEmpty.)
Protected property IsRefreshDeferred Gets a value that indicates whether there is an outstanding DeferRefresh in use. (Inherited from CollectionView.)
Public property ItemProperties Gets a collection of objects that describes the properties of the items in the collection.
Public property NeedsRefresh Gets a value that indicates whether the view needs to be refreshed. (Inherited from CollectionView.)
Public property NewItemPlaceholderPosition Gets or sets the position of the new item placeholder in the BindingListCollectionView.
Public property SortDescriptions Gets a collection of SortDescription objects that describes how the items in the collection are sorted in the view. (Overrides CollectionView.SortDescriptions.)
Public property SourceCollection Returns the underlying unfiltered collection. (Inherited from CollectionView.)
Protected property UpdatedOutsideDispatcher Gets a value that indicates whether it has been necessary to update the change log because a CollectionChanged notification has been received on a different thread without first entering the user interface (UI) thread dispatcher. (Inherited from CollectionView.)
Top
  Name Description
Public method AddNew Starts an add transaction and returns the pending new item.
Public method CancelEdit Ends the edit transaction and, if possible, restores the original value to the item.
Public method CancelNew Ends the add transaction and discards the pending new item.
Public method CheckAccess Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Protected method ClearChangeLog Clears any pending changes from the change log. (Inherited from CollectionView.)
Public method CommitEdit Ends the edit transaction and saves the pending changes.
Public method CommitNew Ends the add transaction and saves the pending new item.
Public method Contains Returns a value that indicates whether a given item belongs to the collection view. (Overrides CollectionView.Contains(Object).)
Public method DeferRefresh Enters a defer cycle that you can use to merge changes to the view and delay automatic refresh. (Inherited from CollectionView.)
Public method EditItem Begins an edit transaction of the specified item.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Protected method GetEnumerator Returns an object that you can use to enumerate the items in the view. (Inherited from CollectionView.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetItemAt Retrieves the item at the specified position in the view. (Overrides CollectionView.GetItemAt(Int32).)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IndexOf Returns the index at which the given item belongs in the collection view. (Overrides CollectionView.IndexOf(Object).)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method MoveCurrentTo Sets the specified item to be the CurrentItem in the view. (Inherited from CollectionView.)
Public method MoveCurrentToFirst Sets the first item in the view as the CurrentItem. (Inherited from CollectionView.)
Public method MoveCurrentToLast Sets the last item in the view as the CurrentItem. (Inherited from CollectionView.)
Public method MoveCurrentToNext Sets the item after the CurrentItem in the view as the CurrentItem. (Inherited from CollectionView.)
Public method MoveCurrentToPosition Sets the item at the specified index to be the CurrentItem in the view. (Overrides CollectionView.MoveCurrentToPosition(Int32).)
Public method MoveCurrentToPrevious Sets the item before the CurrentItem in the view as the CurrentItem. (Inherited from CollectionView.)
Protected method OKToChangeCurrent Returns a value that indicates whether the view can change which item is the CurrentItem. (Inherited from CollectionView.)
Protected method OnBeginChangeLogging Called by the base class to notify the derived class that an INotifyCollectionChanged.CollectionChanged event has been posted to the message queue. (Inherited from CollectionView.)
Protected method OnCollectionChanged(NotifyCollectionChangedEventArgs) Raises the CollectionChanged event. (Inherited from CollectionView.)
Protected method OnCollectionChanged(Object, NotifyCollectionChangedEventArgs) Raises the CollectionChanged event. (Inherited from CollectionView.)
Protected method OnCurrentChanged Raises the CurrentChanged event. (Inherited from CollectionView.)
Protected method OnCurrentChanging() Raises a CurrentChanging event that is not cancelable. (Inherited from CollectionView.)
Protected method OnCurrentChanging(CurrentChangingEventArgs) Raises the CurrentChanging event with the specified arguments. (Inherited from CollectionView.)
Protected method OnPropertyChanged Raises the PropertyChanged event using the specified arguments. (Inherited from CollectionView.)
Public method PassesFilter Returns a value that indicates whether the specified item in the underlying collection belongs to the view. (Overrides CollectionView.PassesFilter(Object).)
Protected method ProcessCollectionChanged When overridden in a derived class, processes a single change on the UI thread. (Inherited from CollectionView.)
Public method Refresh Re-creates the view. (Inherited from CollectionView.)
Protected method RefreshOrDefer Refreshes the view or specifies that the view needs to be refreshed when the defer cycle completes. (Inherited from CollectionView.)
Protected method RefreshOverride Re-creates the view. (Inherited from CollectionView.)
Public method Remove Removes the specified item from the collection.
Public method RemoveAt Removes the item at the specified position from the collection.
Protected method SetCurrent(Object, Int32) Sets the specified item and index as the values of the CurrentItem and CurrentPosition properties. (Inherited from CollectionView.)
Protected method SetCurrent(Object, Int32, Int32) Sets the specified item and index as the values of the CurrentItem and CurrentPosition properties. This method can be called from a constructor of a derived class. (Inherited from CollectionView.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Public method VerifyAccess Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject.)
Top
  Name Description
Protected event CollectionChanged Occurs when the view has changed. (Inherited from CollectionView.)
Public event CurrentChanged Occurs after the CurrentItem has changed. (Inherited from CollectionView.)
Public event CurrentChanging Occurs when the CurrentItem is changing. (Inherited from CollectionView.)
Protected event PropertyChanged Occurs when a property value has changed. (Inherited from CollectionView.)
Top
  Name Description
Explicit interface implemetation Private method IComparer.Compare This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code.
Explicit interface implemetation Private method IEnumerable.GetEnumerator Returns an IEnumerator object that you can use to enumerate the items in the view. (Inherited from CollectionView.)
Explicit interface implemetation Private event INotifyCollectionChanged.CollectionChanged Occurs when the view has changed. (Inherited from CollectionView.)
Explicit interface implemetation Private event INotifyPropertyChanged.PropertyChanged Occurs 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, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ