DXCollectionView Members
A collection view.Constructors
| Name | Description |
|---|---|
| DXCollectionView() | Initializes a new instance of the DXCollectionView class. |
Fields
| Name | Description |
|---|---|
| AllowCascadeUpdateProperty static | Identifies the AllowCascadeUpdate bindable property. |
| AllowDragDropItemsProperty static | Identifies the AllowDragDropItems bindable property. |
| AllowDragDropSortedItemsProperty static | Identifies the AllowDragDropSortedItems bindable property. |
| AllowGroupCollapseProperty static | Identifies the AllowGroupCollapse bindable property. |
| AllowLiveDataShapingProperty static | Identifies the AllowLiveDataShaping bindable property. |
| AutoExpandAllGroupsProperty static | Identifies the AutoExpandAllGroups bindable property. |
| DisplayFormatProperty static | Identifies the DisplayFormat bindable property. |
| DisplayMemberProperty static | Identifies the DisplayMember bindable property. |
| FilterExpressionProperty static | Identifies the FilterExpression bindable property. |
| FilterStringProperty static | Identifies the FilterString bindable property. |
| GroupDescriptionProperty static | Identifies the GroupDescription bindable property. |
| GroupHeaderSizeProperty static | Identifies the GroupHeaderSize bindable property. |
| GroupHeaderTemplateProperty static | Identifies the GroupHeaderTemplate bindable property. |
| GroupItemAppearanceProperty static | Identifies the GroupItemAppearance bindable property. |
| IndicatorColorProperty static | Identifies the IndicatorColor bindable property. |
| InvalidItemHandle | An invalid item handle. This value is returned when trying to access an item that does not exist in the collection view. |
| IsLoadMoreEnabledProperty static | Identifies the IsLoadMoreEnabled bindable property. |
| IsPullToRefreshEnabledProperty static | Identifies the IsPullToRefreshEnabled bindable property. |
| IsRefreshingProperty static | Identifies the IsRefreshing bindable property. |
| IsScrollBarVisibleProperty static | Identifies the IsScrollBarVisible bindable property. |
| ItemAppearanceProperty static | Identifies the ItemAppearance bindable property. |
| ItemSizeProperty static | Identifies the ItemSize bindable property. |
| ItemSpacingProperty static | Identifies the ItemSpacing bindable property. |
| ItemsSourceProperty static | Identifies the ItemsSource bindable property. |
| ItemTemplateProperty static | Identifies the ItemTemplate bindable property. |
| LoadMoreCommandProperty static | Identifies the LoadMoreCommand bindable property. |
| MinGroupHeaderSizeProperty static | Identifies the MinGroupHeaderSize bindable property. |
| MinItemSizeProperty static | Identifies the MinItemSize bindable property. |
| OrientationProperty static | Identifies the Orientation bindable property. |
| PullToRefreshCommandProperty static | Identifies the PullToRefreshCommand bindable property. |
| ReduceSizeToContentProperty static | Identifies the ReduceSizeToContent bindable property. |
| SelectedItemAppearanceProperty static | Identifies the SelectedItemAppearance bindable property. |
| SelectedItemProperty static | Identifies the SelectedItem bindable property. |
| SelectedItemsProperty static | Identifies the SelectedItems bindable property. |
| SelectedItemTemplateProperty static | Identifies the SelectedItemTemplate bindable property. |
| SelectionModeProperty static | Identifies the SelectionMode bindable property. |
| TapCommandProperty static | Identifies the TapCommand bindable property. |
Properties
| Name | Description |
|---|---|
| ActualAppearance | Gets the common appearance settings that are applied to the current DXCollectionView. |
| AllowCascadeUpdate | Gets or sets whether the CollectionView performs deferred data loading while a user scrolls items. This is a bindable property. |
| AllowDragDropItems | Gets or sets whether users can drag items within the view. This is a bindable property. |
| AllowDragDropSortedItems | Gets or sets whether users can drag items that are sorted or grouped. This is a bindable property. |
| AllowGroupCollapse | Gets or sets whether users can collapse and expand groups of items. This is a bindable property. |
| AllowLiveDataShaping |
Gets or sets whether DXCollectionView refreshes itself if the data source notifies the control of a value change. The control re-shapes its data: changes sort order, re-applies filter conditions, and carries out other necessary updates. This functionality is available for item source objects that implement the INotifyPropertyChanged interface. This is a bindable property.
|
| AutoExpandAllGroups | Gets or sets whether users can expand all the DXCollectionView‘s groups. This is a bindable property. |
| DisplayFormat | Gets or sets the pattern used to format list items. This is a bindable property. |
| DisplayMember | Gets or sets the name of the data source’s field whose values are displayed as list items. This is a bindable property. |
| FilterExpression | Gets or sets the DXCollectionView‘s filter expression. This is a bindable property. |
| FilterString | Gets or sets the CollectionView’s filter expression string. This is a bindable property. |
| GroupCount | Gets the number of data item groups in a CollectionView. |
| GroupDescription | Gets or sets how to group data items in the view. This is a bindable property. |
| GroupHeaderSize | Gets or sets a group header’s height (for the vertical orientation of the view) or width (for the horizontal orientation). This is a bindable property. |
| GroupHeaderTemplate | Gets or sets the template that defines the appearance of group headers. This is a bindable property. |
| GroupItemAppearance | Gets or sets the appearance settings that are applied to the current DXCollectionView‘s group items. This is a bindable property. |
| IndicatorColor | Gets or sets the color of the load-more (iOS and Android) and pull-to-refresh (iOS only) indicators. This is a bindable property. |
| IsInitialized | Gets whether the DXCollectionView‘s instance is initialized. |
| IsLoadMoreEnabled | Gets or sets whether the load-more functionality is enabled in the CollectionView. This is a bindable property. |
| IsPullToRefreshEnabled | Gets or sets whether the pull-to-refresh functionality is enabled in the CollectionView. |
| IsRefreshing | Allows you to hide the refresh or load indicator that the collection view displays when executing the pull-to-refresh or load-more operation. This is a bindable property. |
| IsScrollBarVisible | Gets or sets whether the scrollbar is displayed in the view. This is a bindable property. |
| ItemAppearance | Gets or sets the appearance settings that are applied to the current DXCollectionView‘s items. This is a bindable property. |
| ItemSize | Gets or sets a data item’s height (for vertical orientation of the view) or width (for horizontal orientation). This is a bindable property. |
| ItemSpacing | Gets or sets the distance between DXCollectionView‘s items. This is a bindable property. |
| ItemsSource | Gets or sets the CollectionView’s data source. This is a bindable property. |
| ItemTemplate | Gets or sets the template that defines the appearance of list items. This is a bindable property. |
| LoadMoreCommand | Gets or sets the command executed when a user scrolls to the last item in the CollectionView to load new data items. This is a bindable property. |
| MinGroupHeaderSize | Gets or sets a group header’s minimum height (for the vertical orientation of the view) or width (for the horizontal orientation). This is a bindable property. |
| MinItemSize | Gets or sets a data item’s minimum height (vertical orientation) or width (horizontal orientation). This is a bindable property. |
| Orientation | Gets or sets the orientation of the CollectionView. This is a bindable property. |
| PullToRefreshCommand | Gets or sets the command executed when a user pulls the CollectionView down to request content update. This is a bindable property. |
| ReduceSizeToContent | |
| SelectedItem | Gets or sets the selected item when the SelectionMode property is set to Single. This is a bindable property. |
| SelectedItemAppearance | Gets or sets the appearance settings that are applied to the current DXCollectionView‘s selected items. This is a bindable property. |
| SelectedItems | Gets or sets selected items when the SelectionMode property is set to Multiple. This is a bindable property. |
| SelectedItemTemplate | Gets or sets the template that defines the appearance of an item selected in the view. This is a bindable property. |
| SelectionMode | Gets or sets whether and how many items can be selected in the view. This is a bindable property. |
| SortDescriptions | Specifies how to sort data items in the view. |
| TapCommand | Gets or sets the command executed when a user taps the DXCollectionView. This is a bindable property. |
| VisibleItemCount | Gets the total number of items displayed in the view. |
Methods
| Name | Description |
|---|---|
| BeginUpdate() | Locks the DXCollectionView to prevent its visual updates until the EndUpdate method is called. |
| CollapseAllGroups(Boolean) | Collapses all groups of items. |
| CollapseGroup(Int32, Boolean) | Collapses the specified group of items. |
| DeleteItem(Int32) | Deletes the specified item by its handle. |
| EndUpdate() | Unlocks the DXCollectionView after the BeginUpdate method call and forces an immediate visual update. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| ExpandAllGroups(Boolean) | Expands all groups of items. |
| ExpandGroup(Int32, Boolean) | Expands the specified group of items. |
| FindItemHandle(Object) | Returns the handle of the collection view item that correspond to the specified data source object. |
| FindItemHandle(Predicate<Object>) | Returns the handle of the first item that matches the specified criteria. |
| GetChildItemCount(Int32) | Returns the number of data items in the group. |
| GetChildItemHandle(Int32, Int32) | Returns the handle of the item at the specified position within the specified group. |
| GetGroupDisplayText(Int32) | Returns the text displayed in the specified group header. |
| GetGroupValue(Int32) | Returns the data value for which the group is created. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetItem(Int32) | Returns an object that specifies a record in the CollectionView’s underlying data source. |
| GetItemBySourceIndex(Int32) | Returns the data source object by its index. |
| GetItemHandle(Int32) | Returns the handle of an item by its index in the data source. |
| GetItemHandleByVisibleIndex(Int32) | Returns the handle of the item by its visible index. |
| GetItemSourceIndex(Int32) | Returns the source index of the item by its handle. |
| GetItemVisibleIndex(Int32) | Returns the visible index of the item by its handle. |
| GetParentItemHandle(Int32) | |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| Initialize() | Initializes the DXCollectionView from XAML. |
| IsGroupCollapsed(Int32) | Indicates whether the specified group of items is collapsed. |
| IsGroupHeader(Int32) | Checks whether the specified item is a group header. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| MoveItem(Int32, Int32, Action, Boolean) | |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| RefreshData() | Updates the collection view’s data. |
| RefreshItem(Int32) | Refreshes the collection view item with the specified handle. |
| ScrollTo(Int32) | Scrolls the view to make the specified item visible. |
| ToString() | Returns a string that represents the current object. Inherited from Object. |
Events
| Name | Description |
|---|---|
| CompleteItemDragDrop | Occurs after a drag-and-drop operation is completed. |
| DragItem | Occurs when a user taps and holds an item to drag it. |
| DragItemOver | Occurs each time an item is dragged over another item. |
| DropItem | Occurs when a user drops an item. |
| GroupCollapsed | Occurs after a group of items has been collapsed. |
| GroupCollapsing | Occurs before a group of items is collapsed. |
| GroupExpanded | Occurs after a group of items has been expanded. |
| GroupExpanding | Occurs before a group of items is expanded. |
| LoadMore | Occurs when a user scrolls to the last item in the CollectionView to load new data items. |
| PullToRefresh | Occurs when a user pulls the CollectionView down to refresh its content. |
| SelectionChanged | Occurs when the item selection is changed. |
| Tap | Occurs when a user taps the view. |
See Also