DomainDataSourceView Class

  • Article

[WCF RIA Services Version 1 Service Pack 2 is compatible with either .NET framework 4 or .NET Framework 4.5, and with either Silverlight 4 or Silverlight 5.]

Provides a collection view for the DomainDataSource.

Inheritance Hierarchy

System.Object
  System.Windows.Controls.DomainDataSourceView

Namespace:  System.Windows.Controls
Assembly:  System.Windows.Controls.DomainServices (in System.Windows.Controls.DomainServices.dll)

Syntax

'Declaration
Public NotInheritable Class DomainDataSourceView _
    Implements ICollectionView, IEnumerable, INotifyCollectionChanged, IEditableCollectionView,  _
    IPagedCollectionView, INotifyPropertyChanged

'Usage
Dim instance As DomainDataSourceView

public sealed class DomainDataSourceView : ICollectionView, 
    IEnumerable, INotifyCollectionChanged, IEditableCollectionView, IPagedCollectionView, INotifyPropertyChanged

public ref class DomainDataSourceView sealed : ICollectionView, 
    IEnumerable, INotifyCollectionChanged, IEditableCollectionView, IPagedCollectionView, INotifyPropertyChanged

[<SealedAttribute>]
type DomainDataSourceView =  
    class
        interface ICollectionView
        interface IEnumerable
        interface INotifyCollectionChanged
        interface IEditableCollectionView
        interface IPagedCollectionView
        interface INotifyPropertyChanged
    end

public final class DomainDataSourceView implements ICollectionView, IEnumerable, INotifyCollectionChanged, IEditableCollectionView, IPagedCollectionView, INotifyPropertyChanged

The DomainDataSourceView type exposes the following members.

Properties

  Name Description
Public property CanAdd Gets a value that indicates whether items can be added to the collection.
Public property CanChangePage Gets a value that indicates whether the PageIndex value can change.
Public property CanRemove Gets a value that indicates whether an item can be removed from the collection.
Public property Count Gets the number of items currently in this view.
Public property CurrentItem Gets the current item in the view.
Public property CurrentPosition Gets the ordinal position of the CurrentItem in the view.
Public property IsEmpty Gets a value that indicates whether the resulting view is empty.
Public property IsPageChanging Gets a value that indicates whether the page index is changing.
Public property Item Gets the item at the specified index.
Public property PageCount Gets the number of the pages in this view.
Public property PageIndex Gets the zero-based index of the current page.
Public property PageSize Gets or sets the number of items to display on a page.
Public property TotalItemCount Gets the total number of items in the view before paging is applied, or -1 if the total number is not known.

Top

Methods

  Name Description
Public method Add Adds the specified item to the collection.
Public method Contains Returns a value that indicates whether a given item belongs to this view.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetItemAt Gets the item at the specified index.
Public method GetType (Inherited from Object.)
Public method IndexOf Gets the ordinal position of the specified item within the view.
Protected method MemberwiseClone (Inherited from Object.)
Public method MoveCurrentTo Sets the specified item to be the CurrentItem in the view.
Public method MoveCurrentToFirst Sets the first item in the view as the CurrentItem.
Public method MoveCurrentToLast Sets the last item in the view as the CurrentItem.
Public method MoveCurrentToNext Sets the item after the CurrentItem in the view as the CurrentItem.
Public method MoveCurrentToPosition Sets the item at the specified index to be the CurrentItem in the view.
Public method MoveCurrentToPrevious Sets the item before the CurrentItem in the view as the CurrentItem.
Public method MoveToFirstPage Sets the first page as the current page.
Public method MoveToLastPage Sets the last page as the current page.
Public method MoveToNextPage Moves to the page after the current page.
Public method MoveToPage Moves to the page at the specified index.
Public method MoveToPreviousPage Moves to the page before the current page.
Public method Remove Removes the specified item from the collection.
Public method RemoveAt Removes the item at the specified position from the collection.
Public method ToString (Inherited from Object.)

Top

Events

  Name Description
Public event CurrentChanged Occurs after the CurrentItem has changed.
Public event CurrentChanging Occurs before the CurrentItem is changed.
Public event PageChanged Occurs after the PageIndex has changed.
Public event PageChanging Occurs before the PageIndex is changed.

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IEditableCollectionView.AddNew Adds a new item to the underlying collection.
Explicit interface implemetationPrivate property IEditableCollectionView.CanAddNew Gets a value that indicates whether a new item can be added to the collection.
Explicit interface implemetationPrivate property IEditableCollectionView.CanCancelEdit Gets a value that indicates whether the collection view can discard pending changes and restore the original values of an edited object.
Explicit interface implemetationPrivate method IEditableCollectionView.CancelEdit Ends the edit transaction and, if possible, restores the original value of the item.
Explicit interface implemetationPrivate method IEditableCollectionView.CancelNew Ends the add transaction and discards the pending new item.
Explicit interface implemetationPrivate property ICollectionView.CanFilter Gets a value that indicates whether this view supports filtering by way of the Filter property.
Explicit interface implemetationPrivate property ICollectionView.CanGroup Gets a value that indicates whether this view supports grouping by way of the GroupDescriptions property.
Explicit interface implemetationPrivate property ICollectionView.CanSort Gets a value that indicates whether this view supports sorting by way of the SortDescriptions property.
Explicit interface implemetationPrivate event INotifyCollectionChanged.CollectionChanged Occurs when the items list of the collection has changed, or the collection is reset.
Explicit interface implemetationPrivate method IEditableCollectionView.CommitEdit Ends the edit transaction and saves the pending changes.
Explicit interface implemetationPrivate method IEditableCollectionView.CommitNew Ends the add transaction and saves the pending new item.
Explicit interface implemetationPrivate property ICollectionView.Culture Gets or sets the cultural information for any operations of the view that may differ by culture, such as sorting.
Explicit interface implemetationPrivate property IEditableCollectionView.CurrentAddItem Gets the item that is being added during the current add transaction.
Explicit interface implemetationPrivate property IEditableCollectionView.CurrentEditItem Gets the item in the collection that is being edited.
Explicit interface implemetationPrivate method ICollectionView.DeferRefresh Enters a defer cycle that you can use to merge changes to the view and delay automatic refresh.
Explicit interface implemetationPrivate method IEditableCollectionView.EditItem Begins an edit transaction on the specified item.
Explicit interface implemetationPrivate property ICollectionView.Filter Gets or sets a callback that is used to determine whether an item is appropriate for inclusion in the view.
Explicit interface implemetationPrivate method IEnumerable.GetEnumerator Returns an enumerator that iterates through a collection.
Explicit interface implemetationPrivate property ICollectionView.GroupDescriptions Gets a collection of GroupDescription objects that describe how the items in the collection are grouped in the view.
Explicit interface implemetationPrivate property ICollectionView.Groups Gets the top-level groups.
Explicit interface implemetationPrivate property IEditableCollectionView.IsAddingNew Gets a value that indicates whether an add transaction is in progress.
Explicit interface implemetationPrivate property ICollectionView.IsCurrentAfterLast Gets a value that indicates whether the CurrentItem of the view is beyond the end of the collection.
Explicit interface implemetationPrivate property ICollectionView.IsCurrentBeforeFirst Gets a value that indicates whether the CurrentItem of the view is beyond the start of the collection.
Explicit interface implemetationPrivate property IEditableCollectionView.IsEditingItem Gets a value that indicates whether an edit transaction is in progress.
Explicit interface implemetationPrivate property IPagedCollectionViewItemCount Gets the number of known items in the view before paging is applied.
Explicit interface implemetationPrivate property IEditableCollectionView.NewItemPlaceholderPosition Gets or sets the position of the new item placeholder in the collection view.
Explicit interface implemetationPrivate event INotifyPropertyChanged.PropertyChanged Occurs when a property value changes.
Explicit interface implemetationPrivate method ICollectionView.Refresh Recreates the view.
Explicit interface implemetationPrivate property ICollectionView.SortDescriptions Gets a collection of SortDescription instances that describe how the items in the collection are sorted in the view.
Explicit interface implemetationPrivate property ICollectionView.SourceCollection Gets the underlying collection.

Top

Remarks

This view supports adding, removing, accessing, and paging the underlying data. For other standard view functions, such as sorting, filtering, and grouping, use the descriptor collections of the DomainDataSource, such as SortDescriptors or GroupDescriptors.

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.

See Also

Reference

System.Windows.Controls Namespace