ComponentOne Basic Library for UWP
C1.UWP Assembly / C1.Xaml Namespace / C1CollectionView Class
Properties Methods Events


In This Topic
    C1CollectionView Class Members
    In This Topic

    The following tables list the members exposed by C1CollectionView.

    Public Constructors
     NameDescription
    Public ConstructorC1CollectionView ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyCanAddNewGets a value indicating whether a new item can be added to the underlying collection using the AddNew method.  
    Public PropertyCanCancelEditGets a value indicating whether the view can roll back the current edit transaction started by the EditItem method and restore original values of an editing item.  
    Public PropertyCanChangePage  
    Public PropertyCanFilterGets a value that indicates whether this view supports filtering via the Filter property.  
    Public PropertyCanGroupGets a value that indicates whether the view supports grouping.  
    Public PropertyCanRemoveGets a value indicating whether an item can be removed from the underlying collection.  
    Public PropertyCanSortGets a value that indicates whether the view supports local sorting.  
    Public PropertyCollectionGroupsGets a collection of the top-level groups that is constructed based in the GroupDescriptions property. The objects in the collection are instances of the CollectionViewGroup class that implements the Windows.UI.Xaml.Data.ICollectionViewGroup interface.  
    Public PropertyCountGets the number of items in the view.  
    Public PropertyCultureGets or sets the culture information to use during sorting.  
    Public PropertyCurrentAddItemGets the item that is being added during the current add transaction started by the AddNew method.  
    Public PropertyCurrentEditItemGets the item that is being edited during the current edit transaction started by the EditItem method.  
    Public PropertyCurrentItemGets the current item in the view.  
    Public PropertyCurrentPositionGets the index of the current item in the view.  
    Public PropertyCustomSortGets or sets a custom object that implements IComparer to sort items in the view, as an alternative to sort conditions represented by the ViewSortDescriptions property.  
    Public PropertyFilterGets or sets a callback used to determine if an item is suitable for inclusion in the view.  
    Public PropertyGroupDescriptionsGets a collection of GroupDescription derived objects that describes how the items in the collection are grouped in the view. Usually objects of the PropertyGroupDescription class are used to specify grouping conditions.  
    Public PropertyHasMoreItemsReturns true if additional unloaded items remain in the view; otherwise, false.  
    Public PropertyIsAddingNewGets a value indicating whether an add transaction started by the AddNew method is in progress.  
    Public PropertyIsCurrentAfterLastGets a value that indicates whether the CurrentItem of the view is beyond the end of the collection.  
    Public PropertyIsCurrentBeforeFirstGets a value that indicates whether the CurrentItem of the view is beyond the beginning of the collection.  
    Public PropertyIsEditingItemGets a value indicating whether an edit transaction started by the EditItem method is in progress.  
    Public PropertyIsEmpty  
    Public PropertyIsPageChanging  
    Public PropertyIsReadOnlyGets a value indicating whether the view is read-only.  
    Public PropertyItemGets or sets the item at the specified view index.  
    Public PropertyItemCount  
    Public PropertyPageCount  
    Public PropertyPageIndex  
    Public PropertyPageSize  
    Public PropertySortDescriptionsGets a collection of SortDescription objects that describe how the items in the collection are sorted in the view.  
    Public PropertySourceCollectionGets or sets the underlying collection which this C1CollectionView represents.  
    Public PropertyTotalItemCount  
    Top
    Protected Properties
     NameDescription
    Protected PropertySyncRoot  
    Top
    Public Methods
     NameDescription
    Public MethodAddAdds an item to the underlying collection.  
    Public MethodAddNewStarts the transaction of adding a new item to the underlying collection, which should be committed with the CommitNew method or rolled back with the CancelNew method.  
    Public MethodApplyFullTextFilterApply full text filter correspond with input parameters  
    Public MethodCancelEditRolls back the current edit transaction started by the EditItem method.  
    Public MethodCancelNewRolls back the current add transaction started by the AddNew method.  
    Public MethodClearRemoves all items from the underlying collection.  
    Public MethodCommitEditCommits the current edit transaction started by the EditItem method.  
    Public MethodCommitNewCommits the current add transaction started by the AddNew method.  
    Public MethodContainsGets a value indicating whether the specified item belongs to the view. This method returns false if item belongs to the underlying collection but filtered out by the view due to specified Filter.  
    Public MethodCopyToCopies the items of the view to an array, starting at a particular array index.  
    Public MethodDeferRefreshEnters a defer cycle that you can use to merge changes to the view and delay automatic refresh.  
    Public MethodEditItemBegins an edit transaction on the specified item.  
    Public MethodIndexOfReturns the index at which the specified item is located in the view.  
    Public MethodInsertInserts an item to the underlying collection at the specified index. If view is sorted or filtered, the item is added to the end of the underlying collection.  
    Public MethodLoadMoreItemsAsyncInitializes incremental loading from the view.  
    Public MethodMoveCurrentToSets the specified item to be the CurrentItem in the view.  
    Public MethodMoveCurrentToFirstSets the first item in the view as the CurrentItem.  
    Public MethodMoveCurrentToLastSets the last item in the view as the CurrentItem.  
    Public MethodMoveCurrentToNextSets the item after the CurrentItem in the view as the CurrentItem.  
    Public MethodMoveCurrentToPositionSets the item at the specified view index to be the CurrentItem in the view.  
    Public MethodMoveCurrentToPreviousSets the item before the CurrentItem in the view as the CurrentItem.  
    Public MethodMoveToFirstPage  
    Public MethodMoveToLastPage  
    Public MethodMoveToNextPage  
    Public MethodMoveToPage  
    Public MethodMoveToPreviousPage  
    Public MethodPassesFilterReturns a value indicating whether the specified item satisfies the filter conditions defined in the Filter property.  
    Public MethodRefreshCauses the view item set refresh.  
    Public MethodRemoveRemoves the first occurrence of a specific item from the underlying collection.  
    Public MethodRemoveAtRemoves the item at the specified view index from the underlying collection.  
    Top
    Protected Methods
     NameDescription
    Protected MethodOnSourceCollectionChanged  
    Protected MethodProcessCollectionChanged  
    Protected MethodRefreshOrDefer  
    Protected MethodRefreshOverride  
    Top
    Public Events
     NameDescription
    Public EventCurrentChangedThe event is triggered after the current item has been changed.  
    Public EventCurrentChangingThe event is triggered before the current item is changing, and allows to cancel the move to another item.  
    Public EventPageChanged  
    Public EventPageChanging  
    Public EventPropertyChangedThis event occurs when a property value has changed.  
    Public EventVectorChangedOccurs after the view item set has changed, due to applied transformations or changes happened in the underlying collection.  
    Top
    See Also

    Reference

    C1CollectionView Class
    C1.Xaml Namespace