Xceed Logo
Shop
Xceed Toolkit Plus for WPF v5.1 Documentation
Xceed.Wpf.DataGrid.Toolkit Assembly / Xceed.Wpf.DataGrid Namespace / DataGridCollectionViewSource Class
Members


In This Topic
    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
    '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
     NameDescription
    Public ConstructorDataGridCollectionViewSource Constructor  
    Top
    Public Properties
     NameDescription
    Public PropertyAutoCreateForeignKeyDescriptionsGets a value indicating whether the foreign key descriptions are automatically created. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public PropertyAutoCreateItemProperties (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public PropertyCanChangeLiveFiltering (Inherited from System.Windows.Data.CollectionViewSource)
    Public PropertyCanChangeLiveGrouping (Inherited from System.Windows.Data.CollectionViewSource)
    Public PropertyCanChangeLiveSorting (Inherited from System.Windows.Data.CollectionViewSource)
    Public PropertyCollectionViewType (Inherited from System.Windows.Data.CollectionViewSource)
    Public PropertyCultureGets or sets the culture that is used for grouping and sorting operations. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public PropertyDefaultCalculateDistinctValuesGet or sets the default value of the CalculateDistinctValues property when a DataGridItemProperty has not explicitly set its value. This feature is available only in the Professional Edition (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public PropertyDependencyObjectType (Inherited from System.Windows.DependencyObject)
    Public PropertyDispatcher (Inherited from System.Windows.Threading.DispatcherObject)
    Public PropertyDistinctValuesConstraintGets or sets a value representing the constraint applied to the distinct values when automatically filtering data items. This feature is available only in the Professional Edition (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public PropertyDistinctValuesUpdateMode

    Gets or sets the mode that indicates when distinct values used by auto-filtering should be updated.

    (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public PropertyGroupDescriptionsGets 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)
    Public PropertyIsLiveFiltering (Inherited from System.Windows.Data.CollectionViewSource)
    Public PropertyIsLiveFilteringRequested (Inherited from System.Windows.Data.CollectionViewSource)
    Public PropertyIsLiveGrouping (Inherited from System.Windows.Data.CollectionViewSource)
    Public PropertyIsLiveGroupingRequested (Inherited from System.Windows.Data.CollectionViewSource)
    Public PropertyIsLiveSorting (Inherited from System.Windows.Data.CollectionViewSource)
    Public PropertyIsLiveSortingRequested (Inherited from System.Windows.Data.CollectionViewSource)
    Public PropertyIsSealed (Inherited from System.Windows.DependencyObject)
    Public PropertyItemPropertiesGets a collection of DataGridItemProperty objects, which represent the items that are contained in the underlying collection. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public PropertyItemTypeGets the type of the items contained in the collection or added through the SourceItems property. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public PropertyLiveFilteringProperties (Inherited from System.Windows.Data.CollectionViewSource)
    Public PropertyLiveGroupingProperties (Inherited from System.Windows.Data.CollectionViewSource)
    Public PropertyLiveSortingProperties (Inherited from System.Windows.Data.CollectionViewSource)
    Public PropertySortDescriptionsGets 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)
    Public PropertySourceGets or sets the collection from which the view is created. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public PropertyViewGets 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
     NameDescription
    Public MethodClearValueOverloaded.  (Inherited from System.Windows.DependencyObject)
    Public MethodCoerceValue (Inherited from System.Windows.DependencyObject)
    Public MethodDeferRefreshEnters a defer cycle that can be used to merge changes to the view and delay automatic refresh. (Inherited from System.Windows.Data.CollectionViewSource)
    Public MethodEquals (Inherited from System.Windows.DependencyObject)
    Public MethodGetHashCode (Inherited from System.Windows.DependencyObject)
    Public MethodGetLocalValueEnumerator (Inherited from System.Windows.DependencyObject)
    Public MethodGetValue (Inherited from System.Windows.DependencyObject)
    Public MethodInvalidateProperty (Inherited from System.Windows.DependencyObject)
    Public MethodReadLocalValue (Inherited from System.Windows.DependencyObject)
    Public MethodSetCurrentValue (Inherited from System.Windows.DependencyObject)
    Public MethodSetValueOverloaded.  (Inherited from System.Windows.DependencyObject)
    Top
    Protected Methods
     NameDescription
    Protected MethodOnCollectionViewTypeChangedOverridden. Raised when the CollectionViewType property is changed.  
    Protected MethodOnPropertyChanged (Inherited from System.Windows.DependencyObject)
    Protected MethodOnSourceChanged (Inherited from System.Windows.Data.CollectionViewSource)
    Protected MethodReceiveWeakEvent (Inherited from System.Windows.Data.CollectionViewSource)
    Protected Internal MethodShouldSerializeProperty (Inherited from System.Windows.DependencyObject)
    Top
    Public Events
     NameDescription
    Public EventBeginningEdit (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public EventCancelingEdit (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public EventCancelingNewItem (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public EventCommittingEdit (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public EventCommittingNewItem (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public EventCreatingNewItem (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public EventDistinctValuesRefreshNeededRaised when the distinct values need to be refreshed. (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public EventEditBegun (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public EventEditCanceled (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public EventEditCommitted (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public EventFilterProvides filtering logic. (Inherited from System.Windows.Data.CollectionViewSource)
    Public EventInitializingNewItem (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public EventItemRemoved (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public EventNewItemCanceled (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public EventNewItemCommitted (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public EventNewItemCreated (Inherited from Xceed.Wpf.DataGrid.DataGridCollectionViewSourceBase)
    Public EventRemovingItem (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

    See Also

    Reference

    DataGridCollectionViewSource Members
    Xceed.Wpf.DataGrid Namespace

    DataGrid Fundamentals

    DataGridCollectionView Class
    Providing Data

    Send Feedback