Documentation

Class RadCollectionView

Represents a control that can be used to present a collection of items.

Inheritance
System.Object
RadLayout
RadCollectionView
Inherited Members
Namespace: Telerik.Maui.Controls
Assembly: Telerik.Maui.Controls.dll

Syntax

public class RadCollectionView : RadLayout, ICollectionView, ISelector

Constructors

RadCollectionView()

Initializes a new instance of the RadCollectionView class.

Declaration
public RadCollectionView()

Fields

AutomaticLoadOnDemandTemplateProperty

Identifies the AutomaticLoadOnDemandTemplate dependency property.

Declaration
public static readonly BindableProperty AutomaticLoadOnDemandTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

DisplayMemberPathProperty

Identifies the DisplayMemberPath dependency property.

Declaration
public static readonly BindableProperty DisplayMemberPathProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

DragDropBehaviorProperty

Identifies the DragDropBehavior dependency property.

Declaration
public static readonly BindableProperty DragDropBehaviorProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

DragVisualTemplateProperty

Identifies the DragVisualTemplate dependency property.

Declaration
public static readonly BindableProperty DragVisualTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

DropIndicatorTemplateProperty

Identifies the DropIndicatorTemplate dependency property.

Declaration
public static readonly BindableProperty DropIndicatorTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

EmptyContentDisplayModeProperty

Identifies the EmptyContentDisplayMode property.

Declaration
public static readonly BindableProperty EmptyContentDisplayModeProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

EmptyContentTemplateProperty

Identifies the EmptyContentTemplate property.

Declaration
public static readonly BindableProperty EmptyContentTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

EndItemSwipeCommandProperty

Identifies the EndItemSwipeCommand dependency property.

Declaration
public static readonly BindableProperty EndItemSwipeCommandProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

EndSwipeLengthProperty

Identifies the EndSwipeLength dependency property.

Declaration
public static readonly BindableProperty EndSwipeLengthProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

EndSwipeTemplateProperty

Identifies the EndSwipeTemplate dependency property.

Declaration
public static readonly BindableProperty EndSwipeTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

FilterDescriptorsProperty

Identifies the FilterDescriptors dependency property.

Declaration
public static readonly BindableProperty FilterDescriptorsProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

FooterTemplateProperty

Identifies the FooterTemplate property.

Declaration
public static readonly BindableProperty FooterTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

GroupDescriptorsProperty

Identifies the GroupDescriptors dependency property.

Declaration
public static readonly BindableProperty GroupDescriptorsProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

GroupHeaderTemplateProperty

Identifies the GroupHeaderTemplate dependency property.

Declaration
public static readonly BindableProperty GroupHeaderTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

GroupTapCommandProperty

Identifies the GroupTapCommand property.

Declaration
public static readonly BindableProperty GroupTapCommandProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

GroupViewStyleProperty

Identifies the GroupViewStyleProperty dependency property.

Declaration
public static readonly BindableProperty GroupViewStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

GroupViewStyleSelectorProperty

Identifies the GroupViewStyleSelectorProperty dependency property.

Declaration
public static readonly BindableProperty GroupViewStyleSelectorProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

HeaderTemplateProperty

Identifies the HeaderTemplate property.

Declaration
public static readonly BindableProperty HeaderTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

HorizontalScrollBarVisibilityProperty

Identifies the HorizontalScrollBarVisibility property.

Declaration
public static readonly BindableProperty HorizontalScrollBarVisibilityProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

IsDragDropEnabledProperty

Identifies the IsDragDropEnabled dependency property.

Declaration
public static readonly BindableProperty IsDragDropEnabledProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

IsItemSwipeEnabledProperty

Identifies the IsItemSwipeEnabled dependency property.

Declaration
public static readonly BindableProperty IsItemSwipeEnabledProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

IsLoadOnDemandActiveProperty

Identifies the IsLoadOnDemandActive dependency property.

Declaration
public static readonly BindableProperty IsLoadOnDemandActiveProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

IsLoadOnDemandEnabledProperty

Identifies the IsLoadOnDemandEnabled dependency property.

Declaration
public static readonly BindableProperty IsLoadOnDemandEnabledProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ItemsLayoutProperty

Identifies the ItemsLayout dependency property.

Declaration
public static readonly BindableProperty ItemsLayoutProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ItemsSourceProperty

Identifies the ItemsSource dependency property.

Declaration
public static readonly BindableProperty ItemsSourceProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ItemTapCommandProperty

Identifies the ItemTapCommand property.

Declaration
public static readonly BindableProperty ItemTapCommandProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ItemTemplateProperty

Identifies the ItemTemplate dependency property.

Declaration
public static readonly BindableProperty ItemTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ItemViewStyleProperty

Identifies the ItemViewStyleProperty dependency property.

Declaration
public static readonly BindableProperty ItemViewStyleProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ItemViewStyleSelectorProperty

Identifies the ItemViewStyleSelector dependency property.

Declaration
public static readonly BindableProperty ItemViewStyleSelectorProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

LoadOnDemandBufferItemsCountProperty

Identifies the LoadOnDemandBufferItemsCount dependency property.

Declaration
public static readonly BindableProperty LoadOnDemandBufferItemsCountProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

LoadOnDemandCommandProperty

Identifies the LoadOnDemandCommand dependency property.

Declaration
public static readonly BindableProperty LoadOnDemandCommandProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

LoadOnDemandModeProperty

Identifies the LoadOnDemandMode dependency property.

Declaration
public static readonly BindableProperty LoadOnDemandModeProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

ManualLoadOnDemandTemplateProperty

Identifies the ManualLoadOnDemandTemplate dependency property.

Declaration
public static readonly BindableProperty ManualLoadOnDemandTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SelectedIndexProperty

Identifies the SelectedIndex dependency property.

Declaration
public static readonly BindableProperty SelectedIndexProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SelectedItemProperty

Identifies the SelectedItem dependency property.

Declaration
public static readonly BindableProperty SelectedItemProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SelectedItemsProperty

Identifies the SelectedItems property.

Declaration
public static readonly BindableProperty SelectedItemsProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SelectionModeProperty

Identifies the SelectionMode dependency property.

Declaration
public static readonly BindableProperty SelectionModeProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SortDescriptorsProperty

Identifies the SortDescriptors dependency property.

Declaration
public static readonly BindableProperty SortDescriptorsProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

StartSwipeLengthProperty

Identifies the StartSwipeLength dependency property.

Declaration
public static readonly BindableProperty StartSwipeLengthProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

StartSwipeTemplateProperty

Identifies the StartSwipeTemplate dependency property.

Declaration
public static readonly BindableProperty StartSwipeTemplateProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SwipeCompletedCommandProperty

Identifies the SwipeCompletedCommand dependency property.

Declaration
public static readonly BindableProperty SwipeCompletedCommandProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SwipeStartingCommandProperty

Identifies the SwipeStartingCommand dependency property.

Declaration
public static readonly BindableProperty SwipeStartingCommandProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SwipeThresholdProperty

Identifies the SwipeThreshold dependency property.

Declaration
public static readonly BindableProperty SwipeThresholdProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

SwipingCommandProperty

Identifies the SwipingCommand dependency property.

Declaration
public static readonly BindableProperty SwipingCommandProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

VerticalScrollBarVisibilityProperty

Identifies the VerticalScrollBarVisibility property.

Declaration
public static readonly BindableProperty VerticalScrollBarVisibilityProperty
Field Value
Microsoft.Maui.Controls.BindableProperty

Properties

AutomaticLoadOnDemandTemplate

Gets or sets the template of the view visualized for Automatic loading.

Declaration
public DataTemplate AutomaticLoadOnDemandTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplate

DisplayMemberPath

Gets or sets a path to a value on the source object to serve as the visual representation of the object.

Declaration
public string DisplayMemberPath { get; set; }
Property Value
System.String

DragDropBehavior

Gets or sets the drag and drop behavior of RadCollectionViewItemView. By using it the default drag and drop logic can be modified.

Declaration
public CollectionViewDragDropBehavior DragDropBehavior { get; set; }
Property Value
CollectionViewDragDropBehavior

DragVisualTemplate

Gets or sets the template that presents the drag visual of the dragged RadCollectionViewItemView.

Declaration
public DataTemplate DragVisualTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplate

DropIndicatorTemplate

Gets or sets the template of the indicator that is shown between the RadCollectionViewItemView during drag and drop.

Declaration
public DataTemplate DropIndicatorTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplate

EmptyContentDisplayMode

Gets or sets a value that specifies when the EmptyContentTemplate will be displayed.

Declaration
public EmptyContentDisplayMode EmptyContentDisplayMode { get; set; }
Property Value
EmptyContentDisplayMode

EmptyContentTemplate

Gets or sets the Microsoft.Maui.Controls.DataTemplate that defines the content of the view which is shown when there are no items.

Declaration
public DataTemplate EmptyContentTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplate

EndItemSwipeCommand

Gets the System.Windows.Input.ICommand that can bring the item that is swiped to its original position.

Declaration
public ICommand EndItemSwipeCommand { get; }
Property Value
System.Windows.Input.ICommand

EndSwipeLength

Gets or sets the length that the end swiped item has once the swipe is completed and until the swipe gets closed.

Declaration
public double EndSwipeLength { get; set; }
Property Value
System.Double

EndSwipeTemplate

Gets or sets the Microsoft.Maui.Controls.DataTemplate that is visualzied when swipe is performed to right in vertical orientation or down in horizontal orientation.

Declaration
public DataTemplate EndSwipeTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplate

FilterDescriptors

Gets the collection of FilterDescriptorBase objects that defines the current filtering within this instance.

Declaration
public FilterDescriptorCollection FilterDescriptors { get; }
Property Value
FilterDescriptorCollection

FooterTemplate

Gets or sets the Microsoft.Maui.Controls.DataTemplate that will be displayed at the end of the list of items.

Declaration
public DataTemplate FooterTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplate

GroupDescriptors

Gets the collection of GroupDescriptorBase objects that defines the current grouping within this instance. Multiple group descriptors define multiple group levels.

Declaration
public GroupDescriptorCollection GroupDescriptors { get; }
Property Value
GroupDescriptorCollection

GroupHeaderTemplate

Gets or sets the the template of the group headers or a custom logic for choosing a template used to display each header.

Declaration
public DataTemplate GroupHeaderTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplate

GroupTapCommand

Gets or sets the command that is executed when RadCollectionViewGroupView is tapped.

Declaration
public ICommand GroupTapCommand { get; set; }
Property Value
System.Windows.Input.ICommand

GroupViewStyle

Gets or sets the Microsoft.Maui.Controls.Style that is applied to the container element generated for each group.

Declaration
public Style GroupViewStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

GroupViewStyleSelector

Gets or sets custom style-selection logic for a style that can be applied to each generated group container element.

Declaration
public IStyleSelector GroupViewStyleSelector { get; set; }
Property Value
IStyleSelector

HeaderTemplate

Gets or sets the Microsoft.Maui.Controls.DataTemplate that will be displayed at the start of the list of items.

Declaration
public DataTemplate HeaderTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplate

HorizontalScrollBarVisibility

Gets or sets the Microsoft.Maui.ScrollBarVisibility of the horizontal scroll bar.

Declaration
public ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }
Property Value
Microsoft.Maui.ScrollBarVisibility

IsDragDropEnabled

Gets or sets a value indicating whether drag and drop is enabled.

Declaration
public bool IsDragDropEnabled { get; set; }
Property Value
System.Boolean

IsItemSwipeEnabled

Gets or sets a value indicating whether the items of the list can be swiped.

Declaration
public bool IsItemSwipeEnabled { get; set; }
Property Value
System.Boolean

IsLoadOnDemandActive

Declaration
public bool IsLoadOnDemandActive { get; set; }
Property Value
System.Boolean

IsLoadOnDemandEnabled

Declaration
public bool IsLoadOnDemandEnabled { get; set; }
Property Value
System.Boolean

ItemsLayout

Gets or sets the layout that the items will be presented in.

Declaration
public CollectionViewLayoutBase ItemsLayout { get; set; }
Property Value
CollectionViewLayoutBase

ItemsSource

Gets or sets a collection used to generate the content of the RadCollectionView.

Declaration
public object ItemsSource { get; set; }
Property Value
System.Object

ItemTapCommand

Gets or sets the command that is executed when RadCollectionViewItemView is tapped.

Declaration
public ICommand ItemTapCommand { get; set; }
Property Value
System.Windows.Input.ICommand

ItemTemplate

Gets or sets the the template of the items or a custom logic for choosing a template used to display each item.

Declaration
public DataTemplate ItemTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplate

ItemViewStyle

Gets or sets the Microsoft.Maui.Controls.Style that is applied to the container element generated for each item.

Declaration
public Style ItemViewStyle { get; set; }
Property Value
Microsoft.Maui.Controls.Style

ItemViewStyleSelector

Gets or sets custom style-selection logic for a style that can be applied to each generated container element.

Declaration
public IStyleSelector ItemViewStyleSelector { get; set; }
Property Value
IStyleSelector

LoadOnDemandBufferItemsCount

Gets or sets the incremental loading buffer items count that indicates at which point the additional items will start loading This property works in a combination with the Automatic.

Declaration
public int LoadOnDemandBufferItemsCount { get; set; }
Property Value
System.Int32

LoadOnDemandCommand

Gets or set the System.Windows.Input.ICommand that is invoked when load-on-demand is performed. When in Manual mode, the command is invoked during the click of a button, presented as the last item in the CollectionView. When in Automatic mode, this command is invoked while scrolling towards the end.

Declaration
public ICommand LoadOnDemandCommand { get; set; }
Property Value
System.Windows.Input.ICommand

LoadOnDemandMode

Gets or sets a value indicating how the operation for loading more items is triggered - either by a Button (Manual) or by scrolling towards end (Automatic).

Declaration
public LoadOnDemandMode LoadOnDemandMode { get; set; }
Property Value
LoadOnDemandMode

ManualLoadOnDemandTemplate

Gets or sets the template of the view visualized for Manual loading.

Declaration
public DataTemplate ManualLoadOnDemandTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplate

SelectedIndex

Gets or sets the SelectedIndex.

Declaration
public int SelectedIndex { get; set; }
Property Value
System.Int32

SelectedItem

Gets the item which is currently selected.

Declaration
public object SelectedItem { get; set; }
Property Value
System.Object

SelectedItems

Gets the collection of currently selected items.

Declaration
public ObservableCollection<object> SelectedItems { get; }
Property Value
System.Collections.ObjectModel.ObservableCollection<System.Object>

SelectionMode

Gets or sets the SelectionMode. This is a dependency property.

Declaration
public CollectionViewSelectionMode SelectionMode { get; set; }
Property Value
CollectionViewSelectionMode

SortDescriptors

Gets the collection of SortDescriptorBase objects that defines the current sorting within this instance. Multiple sort descriptors define a sorting operation by multiple keys.

Declaration
public SortDescriptorCollection SortDescriptors { get; }
Property Value
SortDescriptorCollection

StartSwipeLength

Gets or sets the length that the start swiped item has once the swipe is completed and until the swipe gets closed.

Declaration
public double StartSwipeLength { get; set; }
Property Value
System.Double

StartSwipeTemplate

Gets or sets the Microsoft.Maui.Controls.DataTemplate that is visualzied when swipe is performed to left in vertical orientation or up in horizontal orientation.

Declaration
public DataTemplate StartSwipeTemplate { get; set; }
Property Value
Microsoft.Maui.Controls.DataTemplate

SwipeCompletedCommand

Gets or sets the System.Windows.Input.ICommand that gets invoked swiping of an item is completed.

Declaration
public ICommand SwipeCompletedCommand { get; set; }
Property Value
System.Windows.Input.ICommand

SwipeStartingCommand

Gets or sets the System.Windows.Input.ICommand that gets invoked when item is about to be swiped.

Declaration
public ICommand SwipeStartingCommand { get; set; }
Property Value
System.Windows.Input.ICommand

SwipeThreshold

Gets or sets the length (in pixels) of the swipe gesture that is required to trigger the feature.

Declaration
public double SwipeThreshold { get; set; }
Property Value
System.Double

SwipingCommand

Gets or sets the System.Windows.Input.ICommand that gets invoked item is currently swiping.

Declaration
public ICommand SwipingCommand { get; set; }
Property Value
System.Windows.Input.ICommand

VerticalScrollBarVisibility

Gets or sets the Microsoft.Maui.ScrollBarVisibility of the vertical scroll bar.

Declaration
public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }
Property Value
Microsoft.Maui.ScrollBarVisibility

Methods

EndItemSwipe(Boolean, Action)

Brings item that is swiped to its original position.

Declaration
public void EndItemSwipe(bool animate = true, Action animationFinished = null)
Parameters
System.Boolean animate

Whether the swipe back should be animated or not.
System.Action animationFinished

Action that is invoked when the animation for end of item swipe is finished.

GetDataView()

Gets the IDataViewCollection instance that can be used to traverse and/or manipulate the data after all the Sort, Group and Filter operations are applied.

Declaration
public IDataViewCollection GetDataView()
Returns
IDataViewCollection

OnBindingContextChanged()

Invoked whenever the binding context of the control changes.

Declaration
protected override void OnBindingContextChanged()

OnHandlerChanged()

Declaration
protected override void OnHandlerChanged()

ScrollItemIntoView(Object, Boolean)

Attempts to bring the specified data item into view asynchronously.

Declaration
public void ScrollItemIntoView(object item, bool animate = true)
Parameters
System.Object item

The data item to scroll to.
System.Boolean animate

Whether to use scroll animation or not.

Events

GroupTapped

Occurs when the user taps on RadCollectionViewGroupView.

Declaration
public event EventHandler<RadTappedEventArgs<GroupContext>> GroupTapped
Event Type
System.EventHandler<RadTappedEventArgs<GroupContext>>

GroupTapping

Occurs when tap is currently performing on RadCollectionViewGroupView.

Declaration
public event EventHandler<RadTappingEventArgs<GroupContext>> GroupTapping
Event Type
System.EventHandler<RadTappingEventArgs<GroupContext>>

ItemTapped

Occurs when the user taps on RadCollectionViewItemView.

Declaration
public event EventHandler<RadTappedEventArgs<object>> ItemTapped
Event Type
System.EventHandler<RadTappedEventArgs<System.Object>>

LoadOnDemand

Declaration
public event EventHandler<EventArgs> LoadOnDemand
Event Type
System.EventHandler<System.EventArgs>

Scrolled

Occurs when RadCollectionView is scrolled.

Declaration
public event EventHandler<ScrolledEventArgs> Scrolled
Event Type
System.EventHandler<Microsoft.Maui.Controls.ScrolledEventArgs>

SelectionChanged

Invoked selection is performed.

Declaration
public event EventHandler<RadSelectionChangedEventArgs> SelectionChanged
Event Type
System.EventHandler<RadSelectionChangedEventArgs>

SwipeCompleted

Occurs when swiping of an item is completed.

Declaration
public event EventHandler<CollectionViewSwipeCompletedEventArgs> SwipeCompleted
Event Type
System.EventHandler<CollectionViewSwipeCompletedEventArgs>

SwipeStarting

Occurs when item is about to be swiped.

Declaration
public event EventHandler<CollectionViewSwipeStartingEventArgs> SwipeStarting
Event Type
System.EventHandler<CollectionViewSwipeStartingEventArgs>

Swiping

Occurs when item is currently swiping.

Declaration
public event EventHandler<CollectionViewSwipingEventArgs> Swiping
Event Type
System.EventHandler<CollectionViewSwipingEventArgs>

Extension Methods