CollectionViewSource Class
[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]
The XAML proxy of a collection view class.
Inheritance Hierarchy
System..::.Object
System.Windows..::.DependencyObject
System.Windows.Data..::.CollectionViewSource
Namespace: System.Windows.Data
Assembly: System.Windows (in System.Windows.dll)
XMLNS for XAML: Not mapped to an xmlns.
Syntax
Public Class CollectionViewSource _
Inherits DependencyObject _
Implements ISupportInitialize
public class CollectionViewSource : DependencyObject,
ISupportInitialize
<CollectionViewSource .../>
The CollectionViewSource type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
CollectionViewSource | Initializes a new instance of the CollectionViewSource class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Culture | Gets or sets the cultural information for any operations of the view that might differ by culture, such as sorting. |
|
Dispatcher | Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.) |
|
GroupDescriptions | Gets a collection of GroupDescription objects that describe how items in the collection are grouped in the view. |
|
SortDescriptions | Gets a collection of SortDescription objects that describe how the items in the collection are sorted in the view. |
|
Source | Gets or sets the collection object from which to create this view. |
|
View | Gets the view object that is currently associated with this instance of CollectionViewSource. |
Top
Methods
| Name | Description | |
|---|---|---|
|
CheckAccess | Determines whether the calling thread has access to this object. (Inherited from DependencyObject.) |
|
ClearValue | Clears the local value of a dependency property. (Inherited from DependencyObject.) |
|
DeferRefresh | Enters a defer cycle that you can use to merge changes to the view and delay automatic refresh. |
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
.gif "Protected method") |
Finalize | Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
|
GetAnimationBaseValue | Returns any base value established for a Windows Phone dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.) |
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
GetValue | Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.) |
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
OnCollectionViewTypeChanged | Invoked when the collection view type changes. |
|
OnSourceChanged | Invoked when the Source property changes. |
|
ReadLocalValue | Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.) |
|
SetValue | Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.) |
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
Filter | Provides filtering logic. |
Top
Fields
| Name | Description | |
|---|---|---|
.gif "Public field") .gif "Static member") |
SourceProperty | Identifies the Source dependency property. |
|
ViewProperty | Identifies the View dependency property. |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
ISupportInitialize..::.BeginInit | Signals the object that initialization is starting. |
|
ISupportInitialize..::.EndInit | Signals the object that initialization is complete. |
Top
Remarks
CollectionViewSource is a proxy for a class that implements ICollectionView. CollectionViewSource enables XAML code to set the commonly used ICollectionView properties, passing these settings to the underlying view. CollectionViewSource has a View property that holds the actual view and a Source property that holds the source collection. The view is generated automatically unless the source collection implements ICollectionViewFactory, in which case the view is retrieved through the CreateView method.
You can think of a collection view as the layer on top of the binding source collection that allows you to navigate and display the collection based on sort, filter, and grouping queries, all without having to manipulate the underlying source collection itself. If the source collection implements the INotifyCollectionChanged interface, the changes raised by the CollectionChanged event are propagated to the views.
Because views do not change the underlying source collections, each source collection can have multiple views associated with it. For example, you may have a collection of Task objects. With the use of views, you can display that same data in different ways. For example, on the left side of your page you may want to show tasks sorted by priority, and on the right side, grouped by area.
Examples
The following code example demonstrates the use of this class in XAML to apply sorting to a data source. The data is also defined in XAML to enable you to see the effects of the CollectionViewSource in the interface designer in Visual Studio 2010.
Version Information
Windows Phone OS
Supported in: 8.1, 8.0, 7.1, 7.0
Platforms
Windows Phone
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.