Class

QueryableCollectionView

Initializes a new instance of the QueryableCollectionView class.

Declaration

public QueryableCollectionView(IEnumerable source)

Parameters

Initializes a new instance of the QueryableCollectionView class.

Declaration

public QueryableCollectionView(IEnumerable sourceCollection, Type itemType)

Parameters

Exceptions

Gets a value that indicates whether a new item can be added to the collection.

Declaration

public virtual bool CanAddNew { get; }

Property Value

Gets a value that indicates whether a specified object can be added to the collection.

Declaration

public virtual bool CanAddNewItem { get; }

Property Value

Gets a value that indicates whether the editing of an item can be canceled.

Declaration

public virtual bool CanCancelEdit { get; }

Property Value

Gets a value that indicates whether the PageIndex value can change.

Declaration

public virtual bool CanChangePage { get; }

Property Value

Implements IPagedCollectionView.CanChangePage

Gets a value that indicates whether this view supports filtering via the FilterDescriptors property.

Declaration

public virtual bool CanFilter { get; }

Property Value

Gets a value that indicates whether this view supports grouping via the GroupDescriptors property.

Declaration

public virtual bool CanGroup { get; }

Property Value

Gets a value that indicates whether an item can be removed from the collection.

Declaration

public virtual bool CanRemove { get; }

Property Value

Gets a value that indicates whether this view supports sorting via the SortDescriptors property.

Declaration

public virtual bool CanSort { get; }

Property Value

Gets the number of records in the view after grouping, filtering, sorting, and paging.

Declaration

public int Count { get; }

Property Value

Gets or sets the cultural info for any operations of the view that may differ by culture, such as sorting.

Declaration

public virtual CultureInfo Culture { get; set; }

Property Value

Gets the item that is being added during the current add transaction.

Declaration

public virtual object CurrentAddItem { get; }

Property Value

Gets the item in the collection that is being edited.

Declaration

public virtual object CurrentEditItem { get; }

Property Value

Declaration

public virtual object CurrentItem { get; }

Property Value

Declaration

public virtual int CurrentPosition { get; }

Property Value

Gets or sets a callback used to determine if an item is suitable for inclusion in the view.

Declaration

public virtual Predicate<object> Filter { get; set; }

Property Value

Exceptions

Gets the filter descriptors used for filtering operations.

Declaration

public virtual CompositeFilterDescriptorCollection FilterDescriptors { get; }

Property Value

Implements IQueryableCollectionView.FilterDescriptors

Gets the underlying collection.

Declaration

protected ObservableCollection<GroupDescription> GroupDescriptions { get; }

Property Value

Gets the group descriptors used for grouping operations.

Declaration

public virtual GroupDescriptorCollection GroupDescriptors { get; }

Property Value

Implements IQueryableCollectionView.GroupDescriptors

Gets the top-level groups.

Declaration

public ReadOnlyObservableCollection<object> Groups { get; }

Property Value

Protected accessor to private count.

Declaration

protected virtual int InternalCount { get; }

Property Value

Gets the list created from resulting query after applying filtering, sorting, grouping and paging.

Declaration

protected virtual IList InternalList { get; }

Property Value

Gets a value that indicates whether an add transaction is in progress.

Declaration

public virtual bool IsAddingNew { get; }

Property Value

Declaration

public virtual bool IsCurrentAfterLast { get; }

Property Value

Declaration

public virtual bool IsCurrentBeforeFirst { get; }

Property Value

Gets a value that indicates whether an edit transaction is in progress.

Declaration

public virtual bool IsEditingItem { get; }

Property Value

Returns a value that indicates whether the resulting view is empty.

Declaration

public bool IsEmpty { get; }

Property Value

Gets a value indicating whether this instance is grouped.

Declaration

public virtual bool IsGrouped { get; }

Property Value

Gets a value that indicates whether this view is loading data.

Declaration

public virtual bool IsLoading { get; protected set; }

Property Value

Gets a value that indicates whether a page index change is in process.

Declaration

public bool IsPageChanging { get; protected set; }

Property Value

Implements IPagedCollectionView.IsPageChanging

Gets a value indicating whether this instance has pages or not.

Declaration

protected virtual bool IsPaged { get; }

Property Value

Gets the minimum number of items known to be in the source collection.

Declaration

public virtual int ItemCount { get; }

Property Value

Implements IPagedCollectionView.ItemCount

Gets a collection of objects that describes the properties of the items in the collection.

Declaration

public ReadOnlyCollection<ItemPropertyInfo> ItemProperties { get; }

Property Value

Gets a dictionary of objects that describes the properties of the items in the collection by property name.

Declaration

public Dictionary<string, ItemPropertyInfo> ItemPropertiesByPropertyName { get; }

Property Value

Gets or sets the type used for all internal data engine operations.

Declaration

public Type ItemType { get; set; }

Property Value

Gets a value that indicates whether this view needs to be refreshed.

Declaration

public bool NeedsRefresh { get; set; }

Property Value

Gets or sets the position of the new item placeholder in the collection.

Declaration

public virtual NewItemPlaceholderPosition NewItemPlaceholderPosition { get; set; }

Property Value

Gets the zero-based index of the current page.

Declaration

public int PageIndex { get; protected set; }

Property Value

Implements IPagedCollectionView.PageIndex

Gets or sets the number of items to display on a page.

Declaration

public int PageSize { get; set; }

Property Value

Implements IPagedCollectionView.PageSize

Used to hold "old" currency info when DataLoadMode is Asynchronous and we need to refresh the currency after the load is complete. This field is not supposed to be used directly from your code.

Declaration

protected QueryableCollectionView.CurrencyRefreshInfo PendingCurrencyRefresh { get; set; }

Property Value

Returns the queryable collection, constructed from SourceCollection.

Declaration

public virtual IQueryable QueryableSourceCollection { get; }

Property Value

Gets a value indicating whether should initialize group proxy.

Declaration

protected virtual bool ShouldInitializeGroupProxy { get; }

Property Value

Gets a value indicating whether this instance should RefreshOrDefer when PageSize changes.

Declaration

protected virtual bool ShouldRefreshOrDeferOnPageSizeChange { get; }

Property Value

Gets or set a value that indicates whether IEditableObject methods are automatically invoked by QueryableCollectionView.

Declaration

public bool ShouldRespectIEditableObject { get; set; }

Property Value

Gets the underlying collection.

Declaration

protected SortDescriptionCollection SortDescriptions { get; }

Property Value

Gets the sort descriptors used for sorting operations.

Declaration

public virtual SortDescriptorCollection SortDescriptors { get; }

Property Value

Implements IQueryableCollectionView.SortDescriptors

Returns the underlying collection.

Declaration

public IEnumerable SourceCollection { get; }

Property Value

Gets the total number of items in the source collection, or -1 if the total number is unknown.

Declaration

public virtual int TotalItemCount { get; protected set; }

Property Value

Implements IPagedCollectionView.TotalItemCount

Adds a new item to the collection.

Declaration

public virtual object AddNew()

Returns

Exceptions

Adds the new item to the collection.

Declaration

public void AddNew(object newItem)

Parameters

Exceptions

Adds the specified object to the collection.

Declaration

public virtual object AddNewItem(object newItem)

Parameters

Returns

Applies SelectDescriptors over the specified queryable.

Declaration

protected virtual IQueryable ApplySelectDescriptors(IQueryable queryable)

Parameters

Returns

Ends the edit transaction and discards any pending changes to the item.

Declaration

public virtual void CancelEdit()

Exceptions

Ends the add transaction and discards the pending new item.

Declaration

public virtual void CancelNew()

Ends the edit transaction and saves the pending changes.

Declaration

public virtual void CommitEdit()

Ends the add transaction and saves the pending new item.

Declaration

public virtual void CommitNew()

Completes the page move.

Declaration

protected virtual void CompletePageMove(int newPageIndex)

Parameters

Constructs a new item.

Declaration

protected virtual object ConstructNewItem()

Returns

Returns a value that indicates whether a given item belongs to this collection view.

Declaration

public bool Contains(object item)

Parameters

Returns

Called when internal list needs to be created.

Declaration

protected virtual void CreateInternalList()

Returns IQueryable with applied filtering, sorting, grouping and paging.

Declaration

protected virtual IQueryable CreateView()

Returns

Enters a defer cycle that you can use to merge changes to the view and delay automatic refresh.

Declaration

public IDisposable DeferRefresh()

Returns

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

Declaration

public void Dispose()

Implements IDisposable.Dispose()

Unsubscribes form collection changed events.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Begins an edit transaction of the specified item.

Declaration

public virtual void EditItem(object item)

Parameters

Gets the count of items depending on the page and/or grouped state.

Declaration

protected virtual int GetEffectiveItemCount()

Returns

Declaration

public virtual IEnumerator GetEnumerator()

Returns

Implements IEnumerable.GetEnumerator()

Called when internal list is required.

Declaration

protected IList GetInternalList()

Returns

Retrieves the item at the specified zero-based index in the view.

Declaration

public virtual object GetItemAt(int index)

Parameters

Returns

Exceptions

Gets the paging determinative item count.

Declaration

protected virtual int GetPagingDeterminativeItemCount()

Returns

Returns the zero-based index at which the specified item is located.

Declaration

public virtual int IndexOf(object item)

Parameters

Returns

Initializes the currency on refresh.

Declaration

protected void InitializeCurrencyOnRefresh(QueryableCollectionView.CurrencyRefreshInfo currencyRefreshInfo)

Parameters

Called when the current item should be initialized.

Declaration

protected void InitializeCurrentItem()

Called when internal list should be initialized.

Declaration

protected virtual void InitializeInternalList(IQueryable view)

Parameters

Invalidates the paging and refreshes the view.

Declaration

protected virtual void InvalidatePagingAndRefresh()

Invalidates the paging determinative item count.

Declaration

protected virtual void InvalidatePagingDeterminativeItemCount()

Declaration

public bool MoveCurrentTo(object item)

Parameters

Returns

Declaration

public bool MoveCurrentToFirst()

Returns

Declaration

public bool MoveCurrentToLast()

Returns

Declaration

public bool MoveCurrentToNext()

Returns

Sets the item at the specified index to be the CurrentItem in the view.

Declaration

public bool MoveCurrentToPosition(int position)

Parameters

Returns

Exceptions

Declaration

public bool MoveCurrentToPrevious()

Returns

Sets the first page as the current page.

Declaration

public bool MoveToFirstPage()

Returns

Implements IPagedCollectionView.MoveToFirstPage()

Sets the last page as the current page.

Declaration

public bool MoveToLastPage()

Returns

Implements IPagedCollectionView.MoveToLastPage()

Moves to the page after the current page.

Declaration

public bool MoveToNextPage()

Returns

Implements IPagedCollectionView.MoveToNextPage()

Requests a page move to the page at the specified index.

Declaration

public bool MoveToPage(int pageIndex)

Parameters

Returns

Implements IPagedCollectionView.MoveToPage(int)

Requests a page move to the page at the specified index.

Declaration

protected virtual bool MoveToPageCore(int index)

Parameters

Returns

Moves to the page before the current page.

Declaration

public bool MoveToPreviousPage()

Returns

Implements IPagedCollectionView.MoveToPreviousPage()

Raises the CollectionChanged event.

Declaration

protected virtual void OnCollectionChanged(NotifyCollectionChangedEventArgs args)

Parameters

Raises the CurrentChanged event.

Declaration

protected virtual void OnCurrentChanged(EventArgs args)

Parameters

Raise a non-cancelable CurrentChanging event This is called when CurrentItem is affected by a CollectionChange (Remove or Refresh).

Declaration

protected void OnCurrentChanging()

Raises the CurrentChanging event.

Declaration

protected virtual void OnCurrentChanging(CurrentChangingEventArgs args)

Parameters

Called when anything in the filter descriptors changes.

Declaration

[SuppressMessage("Microsoft.Design", "CA1031:DoNotCatchGeneralExceptionTypes")]
protected virtual void OnFilterDescriptorsChanged()

Invoked when the FilterDescriptors collection changes.

Declaration

protected virtual void OnFilterDescriptorsCollectionChanged(object sender, NotifyCollectionChangedEventArgs e)

Parameters

Invoked when the FilterDescriptors item changes.

Declaration

protected virtual void OnFilterDescriptorsItemChanged(object sender, ItemChangedEventArgs<IFilterDescriptor> e)

Parameters

Invoked when the FilterDescriptors logical operator changes.

Declaration

protected virtual void OnFilterDescriptorsLogicalOperatorChanged()

Invoked when the collection changes.

Declaration

protected virtual void OnGroupDescriptorsCollectionChanged(object sender, NotifyCollectionChangedEventArgs e)

Parameters

Invoked when the GroupDescriptors item changes.

Declaration

protected virtual void OnGroupDescriptorsItemChanged(object sender, ItemChangedEventArgs<IGroupDescriptor> e)

Parameters

Called when internal list is created.

Declaration

protected void OnInternalListCreated()

Raises the PropertyChanged event.

Declaration

protected virtual void OnPropertyChanged(PropertyChangedEventArgs e)

Parameters

Raises the PropertyChanged event.

Declaration

protected void OnPropertyChanged(string propertyName)

Parameters

Invoked when the instance should be refreshed.

Declaration

protected virtual void OnRefresh()

Invoked when the SortDescriptors collection changes.

Declaration

protected virtual void OnSortDescriptorsCollectionChanged(object sender, NotifyCollectionChangedEventArgs e)

Parameters

Invoked when the SortDescriptors item changes.

Declaration

protected virtual void OnSortDescriptorsItemChanged(object sender, ItemChangedEventArgs<ISortDescriptor> e)

Parameters

Called when internal list should be populated.

Declaration

protected virtual void PopulateInternalList(IQueryable view)

Parameters

Raises the PageChanged event.

Declaration

protected void RaisePageChanged()

Declaration

public void Refresh()

Refreshes the groups according to the item and the respective action.

Declaration

protected void RefreshGroupsOnItemAction(object item, ItemAction action)

Parameters

Refreshes the view according to the item and the respective action.

Declaration

protected virtual void RefreshOnItemAction(object item, ItemAction action)

Parameters

Refreshes the view according to the item and the respective action when there is no paging involved.

Declaration

protected void RefreshOnItemActionWithoutPaging(object item, ItemAction action)

Parameters

Re-create the view over the associated IList.

Declaration

protected virtual void RefreshOverride()

Re-create the view over the associated IList.

Declaration

protected void RefreshOverrideCore()

Removes the specified item from the collection.

Declaration

public virtual void Remove(object item)

Parameters

Removes the item at the specified position from the collection.

Declaration

public virtual void RemoveAt(int index)

Parameters

Sets the CurrentItem and CurrentPosition.

Declaration

protected void SetCurrent(object newItem, int newPosition)

Parameters

Sets the CurrentPosition to the given newPosition .

Declaration

protected void SetCurrentPosition(int newPosition)

Parameters

Called when internal list should be set.

Declaration

protected void SetInternalList(IList list)

Parameters

Sorts the specified queryable.

Declaration

protected IQueryable Sort(IQueryable queryable)

Parameters

Returns

Called when the count of the items should be updated.

Declaration

protected void UpdateItemCount()

Called when the count of all items should be updated.

Declaration

protected virtual void UpdateTotalItemCount()

Declaration

public event NotifyCollectionChangedEventHandler CollectionChanged

Event Value

Implements INotifyCollectionChanged.CollectionChanged

Declaration

public event EventHandler CurrentChanged

Event Value

Declaration

public event CurrentChangingEventHandler CurrentChanging

Event Value

This is for internal use only and is not intended to be used directly from your code.

Declaration

public event EventHandler<NotifyGroupCollectionChangedEventArgs> GroupCollectionChanged

Event Value

Occurs when the PageIndex has changed.

Declaration

public event EventHandler<EventArgs> PageChanged

Event Value

Implements IPagedCollectionView.PageChanged

Occurs when the PageIndex is changing.

Declaration

public event EventHandler<PageChangingEventArgs> PageChanging

Event Value

Implements IPagedCollectionView.PageChanging

Declaration

public event PropertyChangedEventHandler PropertyChanged

Event Value

Implements INotifyPropertyChanged.PropertyChanged