System.Collections.ObjectModel.ObservableCollection<T> Class

Represents a dynamic data collection that provides notifications when items get added, removed, or when the whole list is refreshed.

See Also: ObservableCollection<T> Members

Syntax

[System.Runtime.CompilerServices.TypeForwardedFrom("WindowsBase, Version=3.0.0.0, PublicKeyToken=31bf3856ad364e35")]
public class ObservableCollection<T> : Collection<T>, System.Collections.Specialized.INotifyCollectionChanged, System.ComponentModel.INotifyPropertyChanged

Type Parameters

T
Documentation for this section has not yet been entered.

Remarks

In many cases the data that you work with is a collection of objects. For example, a common scenario in data binding is to use an System.Windows.Controls.ItemsControl such as a System.Windows.Controls.ListBox, System.Windows.Controls.ListView, or System.Windows.Controls.TreeView to display a collection of records.

You can enumerate over any collection that implements the IEnumerable interface. However, to set up dynamic bindings so that insertions or deletions in the collection update the TLA2#tla_ui automatically, the collection must implement the System.Collections.Specialized.INotifyCollectionChanged interface. This interface exposes the System.Collections.Specialized.INotifyCollectionChanged.CollectionChanged event, an event that should be raised whenever the underlying collection changes.

TLA2#tla_winclient provides the System.Collections.ObjectModel.ObservableCollection`1 class, which is a built-in implementation of a data collection that implements the System.Collections.Specialized.INotifyCollectionChanged interface.

Before implementing your own collection, consider using System.Collections.ObjectModel.ObservableCollection`1 or one of the existing collection classes, such as List`1, System.Collections.ObjectModel.Collection`1, and System.ComponentModel.BindingList`1, among many others. If you have an advanced scenario and want to implement your own collection, consider using IList, which provides a non-generic collection of objects that can be individually accessed by index. Implementing IList provides the best performance with the data binding engine.

Note:

To fully support transferring data values from binding source objects to binding targets, each object in your collection that supports bindable properties must implement an appropriate property changed notification mechanism such as the System.ComponentModel.INotifyPropertyChanged interface.

For more information, see "Binding to Collections" in Data Binding Overview.

Notes on XAML Usage

System.Collections.ObjectModel.ObservableCollection`1 can be used as a XAML object element in TLA#tla_winclient, in versions 3.0 and 3.5. However, the usage has substantial limitations.

A more straightforward way to use System.Collections.ObjectModel.ObservableCollection`1 capabilities from XAML in an application is to declare your own non-generic custom collection class that derives from System.Collections.ObjectModel.ObservableCollection`1, and constrains it to a specific type. Then map the assembly that contains this class, and reference it as an object element in your XAML.

XAML Text Usage

See Remarks.

Requirements

Namespace: System.Collections.ObjectModel
Assembly: System (in System.dll)
Assembly Versions: 4.0.0.0