DataGridCollectionViewSource Class

In This Topic

Represents the XAML proxy of the DataGridCollectionView class and exposes the most commonly used members of the DataGridCollectionView class.

Syntax

Visual Basic
C#

'Declaration
 
<TypeDescriptionProviderAttribute(MS.Internal.ComponentModel.DependencyObjectProvider)>
<NameScopePropertyAttribute("NameScope", System.Windows.NameScope)>
Public NotInheritable Class DataGridCollectionViewSource 
   Inherits DataGridCollectionViewSourceBase

'Usage
 
Dim instance As DataGridCollectionViewSource

[TypeDescriptionProvider(MS.Internal.ComponentModel.DependencyObjectProvider)]
[NameScopeProperty("NameScope", System.Windows.NameScope)]
public sealed class DataGridCollectionViewSource : DataGridCollectionViewSourceBase

Remarks

The DataGridCollectionViewSource class is not a view but rather the XAML representation of the DataGridCollectionView class, which has a View property to retrieve the underlying DataGridCollectionView, and a Source property by which the underlying data source can be retrieved.

Like the standard CollectionViewSource, the DataGridCollectionViewSource allows data items to be grouped using either the default PropertyGroupDescription or the DataGridGroupDescription (recommended) and adding them to the GroupDescriptions property. Data items can also be sorted by adding the standard SortDescription structures to the SortDescriptions property, or filtered using the Filter event.

The ItemProperties collection contains a list of DataGridItemProperty objects that can be added or removed and that contain information relative to their corresponding item (you could consider these items to be the columns that will end up in a grid).

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.

Inheritance Hierarchy

System.Object
   System.Windows.Threading.DispatcherObject
      System.Windows.DependencyObject
         System.Windows.Data.CollectionViewSource
            Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase
               Xceed.Wpf.DataGrid.DataGridCollectionViewSource

Public Constructors

	Name	Description
	DataGridCollectionViewSource Constructor

Top

Public Properties

	Name	Description
	AutoCreateDetailDescriptions	Gets a value indicating whether the detail descriptions are automatically created. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
	AutoCreateForeignKeyDescriptions	Gets a value indicating whether the foreign key descriptions are automatically created. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
	AutoCreateItemProperties	Gets a value indicating whether the item properties are automatically created. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
	AutoFilterMode	Gets or sets a value indicating how automatic filtering of the data items will be performed. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
	CanChangeLiveFiltering	(Inherited from System.Windows.Data.CollectionViewSource)
	CanChangeLiveGrouping	(Inherited from System.Windows.Data.CollectionViewSource)
	CanChangeLiveSorting	(Inherited from System.Windows.Data.CollectionViewSource)
	CollectionViewType	(Inherited from System.Windows.Data.CollectionViewSource)
	Culture	Gets or sets the culture that is used for grouping and sorting operations. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
	DefaultCalculateDistinctValues	Get or sets the default value of the CalculateDistinctValues property when a DataGridItemProperty has not explicitly set its value. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
	DependencyObjectType	(Inherited from System.Windows.DependencyObject)
	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.DataGridCollectionViewSourceBase)
	Dispatcher	(Inherited from System.Windows.Threading.DispatcherObject)
	DistinctValuesConstraint	Gets or sets a value representing the constraint applied to the distinct values when automatically filtering data items. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
	DistinctValuesUpdateMode	Gets or sets the mode that indicates when distinct values used by auto-filtering should be updated. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
	FilterCriteriaMode	Gets or sets a value indicating how filters entered into a FilterRow are applied. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
	GroupDescriptions	Gets or sets a collection GroupDescription objects that describe how the items contained in the collection are grouped in the view. (Inherited from System.Windows.Data.CollectionViewSource)
	IsLiveFiltering	(Inherited from System.Windows.Data.CollectionViewSource)
	IsLiveFilteringRequested	(Inherited from System.Windows.Data.CollectionViewSource)
	IsLiveGrouping	(Inherited from System.Windows.Data.CollectionViewSource)
	IsLiveGroupingRequested	(Inherited from System.Windows.Data.CollectionViewSource)
	IsLiveSorting	(Inherited from System.Windows.Data.CollectionViewSource)
	IsLiveSortingRequested	(Inherited from System.Windows.Data.CollectionViewSource)
	IsSealed	(Inherited from System.Windows.DependencyObject)
	ItemProperties	Gets a collection of DataGridItemProperty objects, which represent the items that are contained in the underlying collection. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
	ItemType	Gets the type of the items contained in the collection or added through the SourceItems property. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
	LiveFilteringProperties	(Inherited from System.Windows.Data.CollectionViewSource)
	LiveGroupingProperties	(Inherited from System.Windows.Data.CollectionViewSource)
	LiveSortingProperties	(Inherited from System.Windows.Data.CollectionViewSource)
	SortDescriptions	Gets or sets a collection of SortDescription objects that describe how the items in the collection are sorted in the view. (Inherited from System.Windows.Data.CollectionViewSource)
	Source	Gets or sets the collection from which the view is created. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
	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.
	View	Gets the view that is currently associated with the DataGridCollectionViewSource.Gets the DataGridCollectionView that is currently associated with this instance of the DataGridCollectionViewSource. (Inherited from System.Windows.Data.CollectionViewSource)

Top

Public Methods

	Name	Description
	ClearValue	Overloaded. (Inherited from System.Windows.DependencyObject)
	CoerceValue	(Inherited from System.Windows.DependencyObject)
	DeferRefresh	Enters a defer cycle that can be used to merge changes to the view and delay automatic refresh. (Inherited from System.Windows.Data.CollectionViewSource)
	Equals	(Inherited from System.Windows.DependencyObject)
	GetHashCode	(Inherited from System.Windows.DependencyObject)
	GetLocalValueEnumerator	(Inherited from System.Windows.DependencyObject)
	GetValue	(Inherited from System.Windows.DependencyObject)
	InvalidateProperty	(Inherited from System.Windows.DependencyObject)
	ReadLocalValue	(Inherited from System.Windows.DependencyObject)
	SetCurrentValue	(Inherited from System.Windows.DependencyObject)
	SetValue	Overloaded. (Inherited from System.Windows.DependencyObject)

Top

Protected Methods

	Name	Description
	OnCollectionViewTypeChanged	Overridden. Raised when the CollectionViewType property is changed.
	OnPropertyChanged	(Inherited from System.Windows.DependencyObject)
	OnSourceChanged	(Inherited from System.Windows.Data.CollectionViewSource)
	ReceiveWeakEvent	(Inherited from System.Windows.Data.CollectionViewSource)
	ShouldSerializeProperty	(Inherited from System.Windows.DependencyObject)

Top

Extension Methods

	Name	Description
	ShowDialog	Overloaded.

Top

Public Events

	Name	Description
	AutoFilterValuesChanged	Occurs after the AutoFilterValues of the DataGridItemProperty of a detail level changes. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
	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.DataGridCollectionViewSourceBase)
	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.DataGridCollectionViewSourceBase)
	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.DataGridCollectionViewSourceBase)
	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.DataGridCollectionViewSourceBase)
	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.DataGridCollectionViewSourceBase)
	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.DataGridCollectionViewSourceBase)
	DistinctValuesRefreshNeeded	Raised when the distinct values need to be refreshed. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
	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.DataGridCollectionViewSourceBase)
	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.DataGridCollectionViewSourceBase)
	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.DataGridCollectionViewSourceBase)
	Filter	Provides filtering logic. (Inherited from System.Windows.Data.CollectionViewSource)
	InitializingNewItem	Raised after the CreatingNewItem event to allow the new item to be initialized. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
	ItemRemoved	Raised after the RemovingItem event to signal that an item has been removed from the underlying data source. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
	NewItemCanceled	Raised after the CancelingNewItem event to signal that the insertion process of a new item has been canceled. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
	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.DataGridCollectionViewSourceBase)
	NewItemCreated	Raised after the CreatingNewItem and InitializingNewItem events to signal that a new item has been created. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
	RemovingItem	Raised when the Remove ora href="Xceed.Wpf.DataGrid~Xceed.Wpf.DataGrid.DataGridCollectionViewBase~RemoveAt.html">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.DataGridCollectionViewSourceBase)

Top

Requirements

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

Reference

DataGridCollectionViewSource Members
Xceed.Wpf.DataGrid Namespace

DataGrid Fundamentals

DataGridCollectionView Class
Providing Data

Send Feedback

Business Suite

Ultimate Suite

Reference

DataGrid Fundamentals