• Article

DataServiceCollection<T> Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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

Inheritance Hierarchy

System.Object
  System.Collections.ObjectModel.Collection<T>
    System.Collections.ObjectModel.ObservableCollection<T>
      System.Data.Services.Client.DataServiceCollection<T>

Namespace:  System.Data.Services.Client
Assembly:  System.Data.Services.Client (in System.Data.Services.Client.dll)

Syntax

'Declaration
Public Class DataServiceCollection(Of T) _
    Inherits ObservableCollection(Of T)

public class DataServiceCollection<T> : ObservableCollection<T>

Type Parameters

  • T
    An entity type.

The DataServiceCollection<T> type exposes the following members.

Constructors

  Name Description
Public method DataServiceCollection<T>() Creates a new instance of the DataServiceCollection<T> class with automatic change tracking enabled.
Public method DataServiceCollection<T>(DataServiceContext) Creates a new instance of the DataServiceCollection<T> class that uses the specified DataServiceContext.
Public method DataServiceCollection<T>(IEnumerable<T>) Creates a new instance of the DataServiceCollection<T> class based on query execution.
Public method DataServiceCollection<T>(IEnumerable<T>, TrackingMode) Creates a new instance of the DataServiceCollection<T> class based on query execution and with the specified tracking mode.
Public method DataServiceCollection<T>(DataServiceContext, String, Func<EntityChangedParams, Boolean>, Func<EntityCollectionChangedParams, Boolean>) Creates a new instance of the DataServiceCollection<T> class with the supplied change method delegates and that uses the specified DataServiceContext.
Public method DataServiceCollection<T>(IEnumerable<T>, TrackingMode, String, Func<EntityChangedParams, Boolean>, Func<EntityCollectionChangedParams, Boolean>) Creates a new instance of the DataServiceCollection<T> class a based on query execution and with the supplied change method delegates.
Public method DataServiceCollection<T>(DataServiceContext, IEnumerable<T>, TrackingMode, String, Func<EntityChangedParams, Boolean>, Func<EntityCollectionChangedParams, Boolean>) Creates a new instance of the DataServiceCollection<T> class a based on query execution, with the supplied change method delegates, and that uses the supplied DataServiceContext.

Top

Properties

  Name Description
Public property Continuation Gets a continuation object that is used to return the next set of paged results.
Public property Count Gets the number of elements actually contained in the Collection<T>. (Inherited from Collection<T>.)
Public property Item Gets or sets the element at the specified index. (Inherited from Collection<T>.)
Protected property Items Gets a IList<T> wrapper around the Collection<T>. (Inherited from Collection<T>.)

Top

Methods

  Name Description
Public method Add Adds a new item to the collection.
Public method Clear() Removes all elements from the Collection<T>. (Inherited from Collection<T>.)
Public method Clear(Boolean) Removes all items from the collection, and optionally detaches all the items from the DataServiceContext.
Protected method ClearItems Removes all items from the collection. (Inherited from ObservableCollection<T>.)
Public method Contains Determines whether an element is in the Collection<T>. (Inherited from Collection<T>.)
Public method CopyTo Copies the entire Collection<T> to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from Collection<T>.)
Public method Detach Disables DataServiceContext tracking of all items in the collection.
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
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.)
Public method GetEnumerator Returns an enumerator that iterates through the Collection<T>. (Inherited from Collection<T>.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Public method IndexOf Searches for the specified object and returns the zero-based index of the first occurrence within the entire Collection<T>. (Inherited from Collection<T>.)
Public method Insert Inserts an element into the Collection<T> at the specified index. (Inherited from Collection<T>.)
Protected method InsertItem Adds a specified item to the collection at the specified index. (Overrides ObservableCollection<T>.InsertItem(Int32, T).)
Public method Load(T) Loads a single entity object into the collection.
Public method Load(IEnumerable<T>) Loads a collection of entity objects into the collection.
Public method LoadAsync() Asynchronously loads items into the collection, when it represents the navigation property of an entity.
Public method LoadAsync(IQueryable<T>) Asynchronously loads the collection by executing a DataServiceQuery<TElement>.
Public method LoadNextPartialSetAsync Loads the next page of data into the collection.
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnCollectionChanged Raises the CollectionChanged event with the provided event data. (Inherited from ObservableCollection<T>.)
Protected method OnPropertyChanged Raises the PropertyChanged event with the provided arguments. (Inherited from ObservableCollection<T>.)
Public method Remove Removes the first occurrence of a specific object from the Collection<T>. (Inherited from Collection<T>.)
Public method RemoveAt Removes the element at the specified index of the Collection<T>. (Inherited from Collection<T>.)
Protected method RemoveItem Removes the item at the specified index from the collection. (Inherited from ObservableCollection<T>.)
Protected method SetItem Replaces the item at the specified index. (Inherited from ObservableCollection<T>.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

  Name Description
Public event CollectionChanged Occurs when an item in the collection changes, or the entire collection changes. (Inherited from ObservableCollection<T>.)
Public event LoadCompleted Occurs when an asynchronous load operation completes.
Protected event PropertyChanged Occurs when a property on an individual item in the collection changes. (Inherited from ObservableCollection<T>.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method ICollection.CopyTo Copies the elements of the ICollection to an Array, starting at a particular Array index. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate property ICollection<T>.IsReadOnly Gets a value indicating whether the ICollection<T> is read-only. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate property ICollection.IsSynchronized Gets a value indicating whether access to the ICollection is synchronized (thread safe). (Inherited from Collection<T>.)
Explicit interface implemetationPrivate property ICollection.SyncRoot Gets an object that can be used to synchronize access to the ICollection. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate method IEnumerable.GetEnumerator Returns an enumerator that iterates through a collection. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate method IList.Add Adds an item to the IList. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate method IList.Contains Determines whether the IList contains a specific value. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate method IList.IndexOf Determines the index of a specific item in the IList. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate method IList.Insert Inserts an item into the IList at the specified index. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate property IList.IsFixedSize Gets a value indicating whether the IList has a fixed size. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate property IList.IsReadOnly Gets a value indicating whether the IList is read-only. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate property IList.Item Gets or sets the element at the specified index. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate method IList.Remove Removes the first occurrence of a specific object from the IList. (Inherited from Collection<T>.)
Explicit interface implemetationPrivate event INotifyPropertyChanged.PropertyChanged Infrastructure. Occurs when a property value changes. (Inherited from ObservableCollection<T>.)

Top

Remarks

WCF Data Services provides the DataServiceCollection<T> class to support binding data to Silverlight controls. This class inherits from the ObservableCollection<T> class, which implements the INotifyCollectionChanged interface and is the primary data binding mechanism for Silverlight-based applications.

You can load an ObservableCollection<T> binding collection by using any collection that implements the IEnumerable<T> interface. Items loaded into the binding collection must implement the INotifyPropertyChanged interface.

Version Information

Silverlight

Supported in: 5, 4

Platforms

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

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.