Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

ObservableCollection<T> Class

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

Namespace:  System.Collections.ObjectModel
Assembly:  System.Windows (in System.Windows.dll)

public class ObservableCollection<T> : Collection<T>, 
	INotifyCollectionChanged, INotifyPropertyChanged

Type Parameters

T

The type of items in the collection.

The ObservableCollection<T> type exposes the following members.

  NameDescription
Public methodSupported by Silverlight for Windows PhoneObservableCollection<T>()Initializes a new, empty instance of the ObservableCollection<T> class.
Public methodSupported by Silverlight for Windows PhoneObservableCollection<T>(IEnumerable<T>)Initializes a new instance of the ObservableCollection<T> class and populates it with items copied from the specified collection.
Public methodSupported by Silverlight for Windows PhoneObservableCollection<T>(List<T>)Initializes a new instance of the ObservableCollection<T> class and populates it with items copied from the specified list.
Top

  NameDescription
Public propertySupported by Silverlight for Windows PhoneCountGets the number of elements actually contained in the Collection<T>. (Inherited from Collection<T>.)
Public propertySupported by Silverlight for Windows PhoneItemGets or sets the element at the specified index. (Inherited from Collection<T>.)
Protected propertySupported by Silverlight for Windows PhoneItemsGets a IList<T> wrapper around the Collection<T>. (Inherited from Collection<T>.)
Top

  NameDescription
Public methodSupported by Silverlight for Windows PhoneAddAdds an object to the end of the Collection<T>. (Inherited from Collection<T>.)
Public methodSupported by Silverlight for Windows PhoneClearRemoves all elements from the Collection<T>. (Inherited from Collection<T>.)
Protected methodSupported by Silverlight for Windows PhoneClearItemsRemoves all items from the collection. (Overrides Collection<T>.ClearItems().)
Public methodSupported by Silverlight for Windows PhoneContainsDetermines whether an element is in the Collection<T>. (Inherited from Collection<T>.)
Public methodSupported by Silverlight for Windows PhoneCopyToCopies the entire Collection<T> to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from Collection<T>.)
Public methodSupported by Silverlight for Windows PhoneEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneFinalizeAllows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneGetEnumeratorReturns an enumerator that iterates through the Collection<T>. (Inherited from Collection<T>.)
Public methodSupported by Silverlight for Windows PhoneGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Silverlight for Windows PhoneIndexOfSearches for the specified object and returns the zero-based index of the first occurrence within the entire Collection<T>. (Inherited from Collection<T>.)
Public methodSupported by Silverlight for Windows PhoneInsertInserts an element into the Collection<T> at the specified index. (Inherited from Collection<T>.)
Protected methodSupported by Silverlight for Windows PhoneInsertItemInserts an item into the collection at the specified index. (Overrides Collection<T>.InsertItem(Int32, T).)
Protected methodSupported by Silverlight for Windows PhoneMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows PhoneOnCollectionChangedRaises the CollectionChanged event with the provided event data.
Protected methodSupported by Silverlight for Windows PhoneOnPropertyChangedRaises the PropertyChanged event with the provided arguments.
Public methodSupported by Silverlight for Windows PhoneRemoveRemoves the first occurrence of a specific object from the Collection<T>. (Inherited from Collection<T>.)
Public methodSupported by Silverlight for Windows PhoneRemoveAtRemoves the element at the specified index of the Collection<T>. (Inherited from Collection<T>.)
Protected methodSupported by Silverlight for Windows PhoneRemoveItemRemoves the item at the specified index from the collection. (Overrides Collection<T>.RemoveItem(Int32).)
Protected methodSupported by Silverlight for Windows PhoneSetItemReplaces the item at the specified index. (Overrides Collection<T>.SetItem(Int32, T).)
Public methodSupported by Silverlight for Windows PhoneToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventSupported by Silverlight for Windows PhoneCollectionChangedOccurs when an item in the collection changes, or the entire collection changes.
Protected eventSupported by Silverlight for Windows PhonePropertyChangedOccurs when a property on an individual item in the collection changes.
Top

  NameDescription
Explicit interface implemetationPrivate methodSupported by Silverlight for Windows PhoneICollection.CopyToCopies the elements of the ICollection to an Array, starting at a particular Array index. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertySupported by Silverlight for Windows PhoneICollection<T>.IsReadOnlyGets a value indicating whether the ICollection<T> is read-only. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertySupported by Silverlight for Windows PhoneICollection.IsSynchronizedGets a value indicating whether access to the ICollection is synchronized (thread safe). (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertySupported by Silverlight for Windows PhoneICollection.SyncRootGets an object that can be used to synchronize access to the ICollection. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodSupported by Silverlight for Windows PhoneIEnumerable.GetEnumeratorReturns an enumerator that iterates through a collection. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodSupported by Silverlight for Windows PhoneIList.AddAdds an item to the IList. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodSupported by Silverlight for Windows PhoneIList.ContainsDetermines whether the IList contains a specific value. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodSupported by Silverlight for Windows PhoneIList.IndexOfDetermines the index of a specific item in the IList. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodSupported by Silverlight for Windows PhoneIList.InsertInserts an item into the IList at the specified index. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertySupported by Silverlight for Windows PhoneIList.IsFixedSizeGets a value indicating whether the IList has a fixed size. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertySupported by Silverlight for Windows PhoneIList.IsReadOnlyGets a value indicating whether the IList is read-only. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate propertySupported by Silverlight for Windows PhoneIList.ItemGets or sets the element at the specified index. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate methodSupported by Silverlight for Windows PhoneIList.RemoveRemoves the first occurrence of a specific object from the IList. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate eventINotifyPropertyChanged.PropertyChangedInfrastructure. Occurs when a property value changes.
Top

You can enumerate over any collection that implements the IEnumerable interface, and this is sufficient for one-time data binding in Silverlight. However, to set up dynamic bindings so that insertions or deletions in the collection can update the UI automatically, the collection must implement the INotifyCollectionChanged interface. This interface exposes the CollectionChanged event, an event that should be raised whenever the underlying collection changes.

Silverlight provides the ObservableCollection<T> class, which is a base class data collection that implements the INotifyCollectionChanged interface, as well as the INotifyPropertyChanged interface. It also has the expected collection support, defined by deriving from the Collection<T> class.

For an example, see How to: Bind to Hierarchical Data and Create a Master/Details View.

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

Show:
© 2014 Microsoft