'Declaration <NullableContextAttribute(1)> <NullableAttribute(0)> Public NotInheritable Class DataGridCollectionView Inherits DataGridCollectionViewBase
'Usage Dim instance As DataGridCollectionView
[NullableContext(1)] [Nullable(0)] public sealed class DataGridCollectionView : DataGridCollectionViewBase
Unlike the BindingListCollectionView class, the DataGridCollectionView class will never touch the underlying data source, meaning that the original sorting and filtering present in the data source will not be modified. When sorting, the DataGridCollectionView class also provides an estimated 20% increase in performance. In addition to the sorting speed, a limited number of "resets" make the DataGridCollectionView class a better choice when performance is of the utmost importance.
A DataGridItemProperty will be created for each property in the underlying data source and can be retrieved through the ItemProperties property of the DataGridCollectionView.
In addition to the native CollectionView filtering, the DataGridCollectionView and DataGridCollectionViewSource classes also support automatic filtering, which provides Excel-like end-user filtering according to the distinct values of each column. Automatic filtering can be enabled by setting the AutoFilterMode property to And or Or (by default, None), indicating whether data items will be filtered according to all or at least one of the filtering criteria defined by each column respectively.
System.Object
System.Windows.Threading.DispatcherObject
System.Windows.Data.CollectionView
Xceed.Wpf.DataGrid.DataGridCollectionViewBase
Xceed.Wpf.DataGrid.DataGridCollectionView
| Name | Description | |
|---|---|---|
 | DataGridCollectionView Constructor | Overloaded. Initializes a new instance of the DataGridCollectionView class. |
| Name | Description | |
|---|---|---|
 | AllowNew | Gets a value indicating whether new items can be added to the collection through the AddNew method. |
| AutoCreateDetailDescriptions | Gets a value indicating whether the detail descriptions are automatically created. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| AutoCreateForeignKeyDescriptions | Gets a value indicating whether the foreign key descriptions are automatically created. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| AutoCreateItemProperties | Gets a value indicating whether the item properties are automatically created. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| AutoFilterMode | Gets or sets a value indicating how automatic filtering of the data items will be performed.  (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| AutoFilterValues | Gets a dictionary that contains a list of the view's DataGridItemProperty objects with their corresponding auto-filter values. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| CanAddNew | Gets a value indicating whether a new item can be added to the collection. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| CanAutoFilter | Gets a value indicating whether the collection view supports automatic filtering. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| CanCancelEdit | Gets a value indicating whether the collection can discard pending changes and restore the original values of an edited object. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| CanFilter | Gets a value indicating whether the view supports filtering. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| CanGroup | Gets a value indicating whether the view supports grouping. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| CanRemove | Gets a value indicating whether an item can be removed from the collection. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| CanSort | Gets a value indicating whether the view can be sorted. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| Comparer | (Inherited from System.Windows.Data.CollectionView) |
| Count | Overridden. Gets the number of items in the view. |
| Culture | Gets or sets the culture to use during sorting. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| CurrentAddItem | Gets the item that is currently being added to the underlying data source. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| CurrentEditItem | Gets the item in the underlying data source that is currently being edited. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| CurrentItem | Gets the view's current item. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| CurrentPosition | Gets the ordinal position of the CurrentItem within the—optionally sorted and filtered—view. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| DetailDescriptions | Gets a collection of DataGridDetailDescription objects that provide information on the details that will be contained in a grid, including sorting, grouping, and child detail descriptions. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| Dispatcher | (Inherited from System.Windows.Threading.DispatcherObject) |
| DistinctValues | Gets a dictionary that contains a list of DataGridItemProperty objects with their corresponding distinct values. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| DistinctValuesConstraint | Gets or sets a value representing the constraint applied to the DistinctValues when automatically filtering data items. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| DistinctValuesUpdateMode | Gets or sets the mode that indicates when distinct values used by auto-filtering should be updated. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| Filter | Gets or sets a callback used to determine if an item is suitable for inclusion in the view (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| FilterCriteriaMode | Gets or sets a value indicating how filters entered into a FilterRow are applied. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| GroupDescriptions | Gets a collection of GroupDescription objects that describe how the items in the collection are grouped in the view. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| Groups | Gets the runtime groups that are created based on the GroupDescriptions. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| IsAddingNew | Gets a value indicating whether an add transaction is in progress. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| IsCurrentAfterLast | Gets a value indicating whether the view's CurrentItem is beyond the end of the collection. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| IsCurrentBeforeFirst | Gets a value indicating whether the view's CurrentItem is beyond the beginning of the collection. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| IsEditingItem | Gets a value indicating whether an item in the underlying data source is being edited. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| IsEmpty | Overridden. Gets a value indicating whether the filtered view is empty. |
| IsInUse | (Inherited from System.Windows.Data.CollectionView) |
| ItemProperties | Gets the DataGridItemProperty objects that determine the characteristics of the items contained in the view. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| ItemType | Gets the type of the items contained in the collection view or added through the SourceItems property. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| NeedsRefresh | Gets a value that indicates whether this view needs to be refreshed. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| ParentDetailDescription | Gets the parent detail description of the collection view. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| SortDescriptions | Gets a collection of SortDescription objects that describe how the items in the collection are sorted in the view. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| SourceCollection | Overridden. Gets the underlying un-filtered collection. |
| SourceItems | Gets the items that are contained in the SourceCollection. |
| StatFunctions | Gets a collection of the statistical functions whose results can be used by various elements throughout a grid. |
| UpdateChangedPropertyStatsOnly | Gets or sets a value indicating whether only statistical functions on property values of the data source object that have changed should be updated, instead of recalculating all the statistical functions as soon as only one property value has changed. |
| Name | Description | |
|---|---|---|
 | AllowsCrossThreadChanges | (Inherited from System.Windows.Data.CollectionView) |
| IsCurrentInSync | (Inherited from System.Windows.Data.CollectionView) |
| IsDynamic | (Inherited from System.Windows.Data.CollectionView) |
| IsRefreshDeferred | (Inherited from System.Windows.Data.CollectionView) |
| UpdatedOutsideDispatcher | (Inherited from System.Windows.Data.CollectionView) |
| Name | Description | |
|---|---|---|
 | AddNew | Adds a new item to the underlying data source. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| CancelEdit | Cancels the edit process. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| CancelNew | Discards the new item added through a call to the AddNew method before it is committed. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| CommitEdit | Commits the modifications made to the item in the underlying data source that is being edited. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| CommitNew | Commits the new item to the underlying data source. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| Contains | Overridden. Returns a value indicating whether the specified item exists in the collection. |
| DeferGroupStatsUpdate | Enables the processing of batch updates to source items (e.g. via a call to ResetItem() in a loop), and waits until all items have been processed before recalculating StatFunctions at group levels. |
| DeferRefresh | Enters a defer cycle that you can use to merge changes to the view and delay automatic refresh. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| DetachFromSourceCollection | (Inherited from System.Windows.Data.CollectionView) |
| EditItem | Edits the specified item in the underlying data source. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| GetDistinctValues | Retrieves the distinct values for the column that has the specified field name. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| GetItemAt | Overridden. Retrieves the item at the specified index in the view. |
| IndexOf | Overridden. Returns the zero-based index of the specified item. |
| MoveCurrentTo | Sets the specified item as the new CurrentItem. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| MoveCurrentToFirst | Sets the first item in the view as the new CurrentItem. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| MoveCurrentToLast | Sets the last item in the view as the new CurrentItem. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| MoveCurrentToNext | Sets the next item in the view as the new CurrentItem. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| MoveCurrentToPosition | Overridden. Sets the item at the specified index as the new CurrentItem. |
| MoveCurrentToPrevious | Sets the previous item in the view as the new CurrentItem. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| PassesFilter | Returns a value indicating whether the specified item in the underlying data source passes the filtering criteria, and is therefore included in the view. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| Refresh | Recreates the view. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| RefreshDistinctValuesForFieldName | Refreshes the distinct values of the passed field name. |
| RefreshUnboundItemProperties | Overloaded. Allows refreshing all values associated to a DataGridUnboundItemProperty on the data object or list passed in parameter without having to refresh the whole DataGridCollectionView. |
| Remove | Removes the specified item from the underlying data source. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| RemoveAt | Overridden. Removes the item at the specified index from the underlying data source. |
| ResetItem | Ensures an item is re-grouped, re-sorted, and re-filtered, and that its associated StatFunction is recalculated. |
| ResetItems | Ensures items are re-grouped, re-sorted, re-filtered, and their associated StatFunction recalculated. |
| Name | Description | |
|---|---|---|
 | AutoFilterValuesChanged | Occurs after the AutoFilterValues of the DataGridItemProperty of a detail level changes. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| BeginningEdit | Raised when the EditItem method has been called to signal that the edit process of an item in the underlying data source is about to begin. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| CancelingEdit | Raised when the CancelEdit method has been called to signal that the edit process of an item in the underlying data source is about to be canceled. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| CancelingNewItem | Raised when the CancelNew method has been called to signal that the insertion process of a new item is about to be canceled. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| CommittingEdit | Raised when the CommitEdit method has been called to signal that modifications made to an item in the underlying data source are about to be committed. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| CommittingNewItem | Raised when the CommitNew method has been called to signal that a new item is about to be committed to the underlying data source. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| CreatingNewItem | Raised when the AddNew method has been called to signal that a new item is about to be created. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| CurrentChanged | (Inherited from System.Windows.Data.CollectionView) |
| CurrentChanging | (Inherited from System.Windows.Data.CollectionView) |
| DistinctValuesRefreshNeeded | Raised when the distinct values need to be refreshed. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| EditBegun | Raised after the BeginningEdit event to signal that the edit process of an item in the underlying data source has begun. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| EditCanceled | Raised after the CancelingEdit event to signal that the edit process of an item in the underlying data source has been canceled. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| EditCommitted | Raised after the CommittingEdit event to signal that the modifications made to an item in the underlying data source have been committed. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| InitializingNewItem | Raised after the CreatingNewItem event to allow the new item to be initialized. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| ItemRemoved | Raised after the RemovingItem event to signal that an item has been removed from the underlying data source. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| NewItemCanceled | Raised after the CancelingNewItem event to signal that the insertion process of a new item has been canceled. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| NewItemCommitted | Raised after the CommittingNewItem event to signal that a new item has been committed to the underlying data source. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| NewItemCreated | Raised after the CreatingNewItem and InitializingNewItem events to signal that a new item has been created. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| RemovingItem | Raised when the Remove or RemoveAt methods have been called to signal that an item is about to be removed from the underlying data source. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewBase) |
| Name | Description | |
|---|---|---|
 | CollectionChanged | (Inherited from System.Windows.Data.CollectionView) |
| PropertyChanged | (Inherited from System.Windows.Data.CollectionView) |
Target Platforms: Windows 11, Windows 10, 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
