Class RadListView

Partial class containing load-on-demand functionality for the RadListView control.

Inheritance

System.Object

RadView

FormsListViewControlBase

RadListView

Inherited Members

RadView.OnNativeControlLoaded()

RadView.OnNativeControlUnloaded()

RadView.IsDefaultValue(String)

RadView.OnHandlerChanged()

RadView.IsOperational

Namespace: Telerik.Maui.Controls.Compatibility.DataControls

Assembly: Telerik.Maui.Controls.Compatibility.dll

Syntax

public class RadListView : FormsListViewControlBase, IView, IElement, ITransform, ICommandService, IParentElement

Constructors

RadListView()

Initializes a new instance of the RadListView class.

Declaration

public RadListView()

Fields

IsPullToRefreshEnabledProperty

Identifies the IsPullToRefreshEnabled property.

Declaration

public static readonly BindableProperty IsPullToRefreshEnabledProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

ItemSwipeContentTemplateProperty

Identifies the ItemSwipeContentTemplate property.

Declaration

public static readonly BindableProperty ItemSwipeContentTemplateProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

LoadingOnDemandItemTemplateProperty

Identifies the LoadingOnDemandItemTemplate bindable property.

Declaration

public static readonly BindableProperty LoadingOnDemandItemTemplateProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

LoadOnDemandBufferItemsCountProperty

Identifies the LoadOnDemandBufferItemsCount bindable property.

Declaration

public static readonly BindableProperty LoadOnDemandBufferItemsCountProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

LoadOnDemandItemTemplateProperty

Identifies the LoadOnDemandItemTemplate bindable property.

Declaration

public static readonly BindableProperty LoadOnDemandItemTemplateProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

VerticalScrollBarVisibilityProperty

Identifies the VerticalScrollBarVisibility property.

Declaration

public static readonly BindableProperty VerticalScrollBarVisibilityProperty

Field Value

Microsoft.Maui.Controls.BindableProperty

Properties

Commands

Gets the collection with all the custom commands registered with the CommandService. Custom commands have higher priority than the built-in (default) ones.

Declaration

public ObservableCollection<ControlCommandBase<RadListView>> Commands { get; }

Property Value

System.Collections.ObjectModel.ObservableCollection<ControlCommandBase<RadListView>>

DisabledStateOpacity

Gets or sets the opacity applied to the list view when it is disabled.

Declaration

public double DisabledStateOpacity { get; set; }

Property Value

System.Double

The opacity value for disabled state (0.0 to 1.0).

FilterDescriptors

Gets the collection of filter descriptors used to filter the list view items.

Declaration

public ObservableCollection<FilterDescriptorBase> FilterDescriptors { get; }

Property Value

System.Collections.ObjectModel.ObservableCollection<FilterDescriptorBase>

The collection of filter descriptors.

GroupDescriptors

Gets the collection of group descriptors used to group the list view items.

Declaration

public ObservableCollection<GroupDescriptorBase> GroupDescriptors { get; }

Property Value

System.Collections.ObjectModel.ObservableCollection<GroupDescriptorBase>

The collection of group descriptors.

GroupHeaderStyle

Gets or sets the style that defines the appearance of group headers.

Declaration

public ListViewGroupStyle GroupHeaderStyle { get; set; }

Property Value

ListViewGroupStyle

The style to apply to group headers.

GroupHeaderTemplate

Gets or sets the data template used for group headers.

Declaration

public DataTemplate GroupHeaderTemplate { get; set; }

Property Value

Microsoft.Maui.Controls.DataTemplate

The data template for group headers.

IsGroupHeaderSticky

Gets or sets a value indicating whether group headers remain visible when scrolling.

Declaration

public bool IsGroupHeaderSticky { get; set; }

Property Value

System.Boolean

true if group headers are sticky; otherwise, false.

IsItemsReorderEnabled

Gets or sets a value indicating whether items can be reordered by dragging.

Declaration

public bool IsItemsReorderEnabled { get; set; }

Property Value

System.Boolean

true if item reordering is enabled; otherwise, false.

IsItemSwipeEnabled

Gets or sets a value indicating whether items can be swiped to reveal additional content.

Declaration

public bool IsItemSwipeEnabled { get; set; }

Property Value

System.Boolean

true if item swiping is enabled; otherwise, false.

Gets or sets a value indicating whether an async operation for getting more items is currently running, and if it is then a loading indicator is displayed. This property is automatically/internally set when using a ListViewLoadOnDemandCollection. When not using this collection, you must use the LoadOnDemand event, or LoadOnDemand ListViewUserCommand, and must manually update the value of this property. Set to true before running the async call and set to false after adding the items to the ItemsSource.

Declaration

public bool IsLoadOnDemandActive { get; set; }

Property Value

System.Boolean

true if a load-on-demand operation is active; otherwise, false. The default value is false.

IsLoadOnDemandEnabled

Gets or sets a value indicating whether the load-on-demand feature is enabled. This is the ability to load more items, either by pressing a button (Manual) or by scrolling towards the end (Automatic). You can get notifications when more items need to be loaded from the LoadOnDemand event, the LoadOnDemand ListViewUserCommand, or by using a ListViewLoadOnDemandCollection as ItemsSource.

Declaration

public bool IsLoadOnDemandEnabled { get; set; }

Property Value

System.Boolean

true if load-on-demand is enabled; otherwise, false. The default value is false.

IsPullToRefreshActive

Gets or sets a value indicating whether the pull-to-refresh operation is currently active.

Declaration

public bool IsPullToRefreshActive { get; set; }

Property Value

System.Boolean

true if pull-to-refresh is active; otherwise, false.

IsPullToRefreshEnabled

Gets or sets a value indicating whether pull-to-refresh functionality is enabled.

Declaration

public bool IsPullToRefreshEnabled { get; set; }

Property Value

System.Boolean

true if pull-to-refresh is enabled; otherwise, false.

IsSwipingInProgress

Gets a value indicating whether a swipe operation is currently in progress.

Declaration

public bool IsSwipingInProgress { get; }

Property Value

System.Boolean

true if a swipe operation is in progress; otherwise, false.

ItemsSource

Gets or sets the collection of items to display in the list view.

Declaration

public IEnumerable ItemsSource { get; set; }

Property Value

System.Collections.IEnumerable

The items source collection.

ItemStyle

Gets or sets the style that defines the appearance of list view items.

Declaration

public ListViewItemStyle ItemStyle { get; set; }

Property Value

ListViewItemStyle

The style to apply to list view items.

ItemStyleSelector

Gets or sets the style selector that determines which style to apply to individual items.

Declaration

public ListViewStyleSelector ItemStyleSelector { get; set; }

Property Value

ListViewStyleSelector

The style selector for items.

ItemSwipeContentTemplate

Gets or sets the data template used for the swipe content that appears when an item is swiped.

Declaration

public DataTemplate ItemSwipeContentTemplate { get; set; }

Property Value

Microsoft.Maui.Controls.DataTemplate

The data template for item swipe content.

ItemTemplate

Gets or sets the data template used to display individual items.

Declaration

public DataTemplate ItemTemplate { get; set; }

Property Value

Microsoft.Maui.Controls.DataTemplate

The data template for items.

ItemTemplateSelector

Gets or sets the data template selector used to choose templates for individual items.

Declaration

public DataTemplateSelector ItemTemplateSelector { get; set; }

Property Value

Microsoft.Maui.Controls.DataTemplateSelector

The data template selector for items.

LayoutDefinition

Gets or sets the layout definition that determines how items are arranged in the list view.

Declaration

public ListViewLayoutBase LayoutDefinition { get; set; }

Property Value

ListViewLayoutBase

The layout definition for the list view.

LoadingOnDemandItemTemplate

Gets or sets the data template used to display the loading indicator during load-on-demand operations.

Declaration

public DataTemplate LoadingOnDemandItemTemplate { get; set; }

Property Value

Microsoft.Maui.Controls.DataTemplate

A Microsoft.Maui.Controls.DataTemplate that defines the appearance of the loading indicator.

LoadOnDemandBufferItemsCount

Gets or sets the number of items from the end of the list that triggers the load-on-demand operation in automatic mode.

Declaration

public int LoadOnDemandBufferItemsCount { get; set; }

Property Value

System.Int32

An System.Int32 representing the number of buffer items. The default value is 10.

LoadOnDemandItemTemplate

Gets or sets the data template used to display the load-on-demand item when in manual mode.

Declaration

public DataTemplate LoadOnDemandItemTemplate { get; set; }

Property Value

Microsoft.Maui.Controls.DataTemplate

A Microsoft.Maui.Controls.DataTemplate that defines the appearance of the load-on-demand item.

LoadOnDemandMode

Gets or sets a value indicating how the operation for getting more items is triggered - either by a button presented as the last item in the list view (Manual) or by scrolling towards the end (Automatic).

Declaration

public LoadOnDemandMode LoadOnDemandMode { get; set; }

Property Value

LoadOnDemandMode

A LoadOnDemandMode value that determines how load-on-demand is triggered. The default value is Automatic.

PressedItemStyle

Gets or sets the style that defines the appearance of list view items when pressed.

Declaration

public ListViewItemStyle PressedItemStyle { get; set; }

Property Value

ListViewItemStyle

The style to apply to pressed list view items.

ReorderItemStyle

Gets or sets the style that defines the appearance of list view items during reordering.

Declaration

public ListViewItemStyle ReorderItemStyle { get; set; }

Property Value

ListViewItemStyle

The style to apply to items being reordered.

SelectedItem

Gets or sets the selected item.

Declaration

public object SelectedItem { get; set; }

Property Value

System.Object

The selected item.

SelectedItems

Gets the collection of selected items.

Declaration

public ObservableCollection<object> SelectedItems { get; }

Property Value

System.Collections.ObjectModel.ObservableCollection<System.Object>

The collection of selected items as System.Collections.ObjectModel.ObservableCollection<>.

SelectedItemStyle

Gets or sets the style that defines the appearance of selected list view items.

Declaration

public ListViewItemStyle SelectedItemStyle { get; set; }

Property Value

ListViewItemStyle

The style to apply to selected list view items.

SelectionGesture

Gets or sets the gesture used to select items.

Declaration

public SelectionGesture SelectionGesture { get; set; }

Property Value

SelectionGesture

The selection gesture.

SelectionMode

Gets or sets the selection mode.

Declaration

public SelectionMode SelectionMode { get; set; }

Property Value

SelectionMode

The selection mode.

SortDescriptors

Gets the collection of sort descriptors used to sort the list view items.

Declaration

public ObservableCollection<SortDescriptorBase> SortDescriptors { get; }

Property Value

System.Collections.ObjectModel.ObservableCollection<SortDescriptorBase>

The collection of sort descriptors.

SwipeOffset

Gets or sets the swipe offset that determines how far an item can be swiped.

Declaration

public Thickness SwipeOffset { get; set; }

Property Value

Microsoft.Maui.Thickness

The swipe offset thickness.

SwipeThreshold

Gets or sets the threshold that determines when a swipe gesture is recognized.

Declaration

public double SwipeThreshold { get; set; }

Property Value

System.Double

The swipe threshold value.

VerticalScrollBarVisibility

Gets or sets the visibility of the vertical scroll bar.

Declaration

public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }

Property Value

Microsoft.Maui.ScrollBarVisibility

The vertical scroll bar visibility setting.

Methods

EndItemSwipe(Boolean)

Ends the current item swipe operation.

Declaration

public void EndItemSwipe(bool isAnimated = false)

Parameters

System.Boolean isAnimated

A value indicating whether to animate the swipe ending.

EndRefresh(Boolean)

Ends the current pull-to-refresh operation.

Declaration

public void EndRefresh(bool isAnimated = false)

Parameters

System.Boolean isAnimated

A value indicating whether to animate the refresh ending.

GetDataView()

Gets the data view collection associated with this RadListView.

Declaration

public IDataViewCollection GetDataView()

Returns

IDataViewCollection

The data view collection, or null if no renderer supports data view.

OnBindingContextChanged()

Called when the binding context changes.

Declaration

protected override void OnBindingContextChanged()

OnChildPropertyChanged(Object, String)

Notifies that a child element's property has changed.

Declaration

public void OnChildPropertyChanged(object child, string propertyName)

Parameters

System.Object child

The child element whose property changed.

System.String propertyName

The name of the property that changed.

OnItemHold(Object)

Called when an item is held (long pressed).

Declaration

protected virtual void OnItemHold(object item)

Parameters

System.Object item

The item that was held.

OnItemSwipeCompleted(Object, Double)

Called when an item swipe operation has completed.

Declaration

protected virtual void OnItemSwipeCompleted(object item, double offset)

Parameters

System.Object item

The item that was swiped.

System.Double offset

The swipe offset value.

OnItemSwipeStarting(ItemSwipeStartingEventArgs)

Called when an item swipe operation is starting.

Declaration

protected virtual void OnItemSwipeStarting(ItemSwipeStartingEventArgs args)

Parameters

ItemSwipeStartingEventArgs args

The event arguments containing swipe start information.

OnItemSwiping(Object, Double)

Called while an item is being swiped.

Declaration

protected virtual void OnItemSwiping(object item, double offset)

Parameters

System.Object item

The item being swiped.

System.Double offset

The current swipe offset value.

OnItemTap(Object)

Called when an item is tapped.

Declaration

protected virtual void OnItemTap(object item)

Parameters

System.Object item

The item that was tapped.

OnPropertyChanged(String)

Called when a property value changes.

Declaration

protected override void OnPropertyChanged(string propertyName = null)

Parameters

System.String propertyName

Name of the property that changed.

Overrides

RadView.OnPropertyChanged(String)

OnPullToRefreshRequested(PullToRefreshRequestedEventArgs)

Called when a pull-to-refresh operation is requested.

Declaration

protected virtual void OnPullToRefreshRequested(PullToRefreshRequestedEventArgs args)

Parameters

PullToRefreshRequestedEventArgs args

The event arguments containing refresh request information.

OnSelectedItemsCollectionChanged(Object, NotifyCollectionChangedEventArgs)

Called when the selected items collection changes.

Declaration

protected virtual void OnSelectedItemsCollectionChanged(object sender, NotifyCollectionChangedEventArgs e)

Parameters

System.Object sender

The sender.

System.Collections.Specialized.NotifyCollectionChangedEventArgs e

The System.Collections.Specialized.NotifyCollectionChangedEventArgs instance containing the event data.

ScrollItemIntoView(Object)

Scrolls the specified item into view.

Declaration

public void ScrollItemIntoView(object item)

Parameters

System.Object item

The item to scroll into view.

Events

ChildPropertyChanged

Occurs when a child element's property has changed.

Declaration

public event EventHandler<ElementPropertyChangedEventArgs> ChildPropertyChanged

Event Type

System.EventHandler<ElementPropertyChangedEventArgs>

GroupHeaderTapped

Occurs when a group header is tapped.

Declaration

public event EventHandler<GroupHeaderTapEventArgs> GroupHeaderTapped

Event Type

System.EventHandler<GroupHeaderTapEventArgs>

ItemHold

Occurs when an item is held (long pressed).

Declaration

public event EventHandler<ItemHoldEventArgs> ItemHold

Event Type

System.EventHandler<ItemHoldEventArgs>

ItemSwipeCompleted

Occurs when an item swipe operation has completed.

Declaration

public event EventHandler<ItemSwipeCompletedEventArgs> ItemSwipeCompleted

Event Type

System.EventHandler<ItemSwipeCompletedEventArgs>

ItemSwipeStarting

Occurs when an item swipe operation is starting.

Declaration

public event EventHandler<ItemSwipeStartingEventArgs> ItemSwipeStarting

Event Type

System.EventHandler<ItemSwipeStartingEventArgs>

ItemSwiping

Occurs while an item is being swiped.

Declaration

public event EventHandler<ItemSwipingEventArgs> ItemSwiping

Event Type

System.EventHandler<ItemSwipingEventArgs>

ItemTapped

Occurs when an item is tapped.

Declaration

public event EventHandler<ItemTapEventArgs> ItemTapped

Event Type

System.EventHandler<ItemTapEventArgs>

LoadOnDemand

Occurs when more items need to be loaded. When in Manual mode, this event is raised during the click of a button, presented as the last item in the list view. When in Automatic mode, this event is raised while scrolling towards the end. You can use a ListViewLoadOnDemandCollection as an ItemsSource to automatically show loading indicator and load more items asynchronously, or you can manually fetch and add items in this event. If you need to get more items async, you need to set the IsLoadOnDemandActive property to true before running the async call and set to false after adding the items to the ItemsSource. The event is not raised while the value of the IsLoadOnDemandActive property is true.

Declaration

public event EventHandler<EventArgs> LoadOnDemand

Event Type

System.EventHandler<System.EventArgs>

RefreshRequested

Occurs when a pull-to-refresh operation is requested.

Declaration

public event EventHandler<PullToRefreshRequestedEventArgs> RefreshRequested

Event Type

System.EventHandler<PullToRefreshRequestedEventArgs>

ReorderEnded

Occurs when an item reorder operation has ended.

Declaration

public event EventHandler<ReorderEndedEventArgs> ReorderEnded

Event Type

System.EventHandler<ReorderEndedEventArgs>

ReorderStarting

Occurs when an item reorder operation is starting.

Declaration

public event EventHandler<ReorderStartingEventArgs> ReorderStarting

Event Type

System.EventHandler<ReorderStartingEventArgs>

SelectionChanged

Occurs when the selection changes.

Declaration

public event EventHandler<NotifyCollectionChangedEventArgs> SelectionChanged

Event Type

System.EventHandler<System.Collections.Specialized.NotifyCollectionChangedEventArgs>

Extension Methods

AndroidTypeConversionExtensions.ToJavaObject(Object)