Class RadListView

Inheritance
System.Object
RadView
FormsListViewControlBase
RadListView
Inherited Members
Namespace: Telerik.XamarinForms.DataControls
Assembly: Telerik.XamarinForms.DataControls.dll

Syntax

public class RadListView : FormsListViewControlBase, INotifyNativeControlLoaded, ICommandService, IParentElement

Constructors

RadListView()

Declaration
public RadListView()

Fields

DisabledStateOpacityProperty

Declaration
public static readonly BindableProperty DisabledStateOpacityProperty
Field Value
Xamarin.Forms.BindableProperty

FilterDescriptorsProperty

Declaration
public static readonly BindableProperty FilterDescriptorsProperty
Field Value
Xamarin.Forms.BindableProperty

FooterTemplateProperty

Identifies the property.

Declaration
public static readonly BindableProperty FooterTemplateProperty
Field Value
Xamarin.Forms.BindableProperty

GroupDescriptorsProperty

Declaration
public static readonly BindableProperty GroupDescriptorsProperty
Field Value
Xamarin.Forms.BindableProperty

GroupHeaderStyleProperty

Declaration
public static readonly BindableProperty GroupHeaderStyleProperty
Field Value
Xamarin.Forms.BindableProperty

GroupHeaderTemplateProperty

Declaration
public static readonly BindableProperty GroupHeaderTemplateProperty
Field Value
Xamarin.Forms.BindableProperty

HeaderTemplateProperty

Identifies the property.

Declaration
public static readonly BindableProperty HeaderTemplateProperty
Field Value
Xamarin.Forms.BindableProperty

IsGroupHeaderStickyProperty

Declaration
public static readonly BindableProperty IsGroupHeaderStickyProperty
Field Value
Xamarin.Forms.BindableProperty

IsItemsReorderEnabledProperty

Declaration
public static readonly BindableProperty IsItemsReorderEnabledProperty
Field Value
Xamarin.Forms.BindableProperty

IsItemSwipeEnabledProperty

Declaration
public static readonly BindableProperty IsItemSwipeEnabledProperty
Field Value
Xamarin.Forms.BindableProperty

IsLoadOnDemandActiveProperty

Declaration
public static readonly BindableProperty IsLoadOnDemandActiveProperty
Field Value
Xamarin.Forms.BindableProperty

IsLoadOnDemandEnabledProperty

Declaration
public static readonly BindableProperty IsLoadOnDemandEnabledProperty
Field Value
Xamarin.Forms.BindableProperty

IsPullToRefreshActiveProperty

Declaration
public static readonly BindableProperty IsPullToRefreshActiveProperty
Field Value
Xamarin.Forms.BindableProperty

IsPullToRefreshEnabledProperty

Declaration
public static readonly BindableProperty IsPullToRefreshEnabledProperty
Field Value
Xamarin.Forms.BindableProperty

ItemsSourceProperty

Declaration
public static readonly BindableProperty ItemsSourceProperty
Field Value
Xamarin.Forms.BindableProperty

ItemStyleProperty

Declaration
public static readonly BindableProperty ItemStyleProperty
Field Value
Xamarin.Forms.BindableProperty

ItemStyleSelectorProperty

Declaration
public static readonly BindableProperty ItemStyleSelectorProperty
Field Value
Xamarin.Forms.BindableProperty

ItemSwipeContentTemplateProperty

Declaration
public static readonly BindableProperty ItemSwipeContentTemplateProperty
Field Value
Xamarin.Forms.BindableProperty

ItemTemplateProperty

Declaration
public static readonly BindableProperty ItemTemplateProperty
Field Value
Xamarin.Forms.BindableProperty

ItemTemplateSelectorProperty

Declaration
public static readonly BindableProperty ItemTemplateSelectorProperty
Field Value
Xamarin.Forms.BindableProperty

LayoutDefinitionProperty

Declaration
public static readonly BindableProperty LayoutDefinitionProperty
Field Value
Xamarin.Forms.BindableProperty

LoadingOnDemandItemTemplateProperty

Declaration
public static readonly BindableProperty LoadingOnDemandItemTemplateProperty
Field Value
Xamarin.Forms.BindableProperty

LoadOnDemandBufferItemsCountProperty

Declaration
public static readonly BindableProperty LoadOnDemandBufferItemsCountProperty
Field Value
Xamarin.Forms.BindableProperty

LoadOnDemandItemTemplateProperty

Declaration
public static readonly BindableProperty LoadOnDemandItemTemplateProperty
Field Value
Xamarin.Forms.BindableProperty

LoadOnDemandModeProperty

Declaration
public static readonly BindableProperty LoadOnDemandModeProperty
Field Value
Xamarin.Forms.BindableProperty

PressedItemStyleProperty

Declaration
public static readonly BindableProperty PressedItemStyleProperty
Field Value
Xamarin.Forms.BindableProperty

ReorderItemStyleProperty

Declaration
public static readonly BindableProperty ReorderItemStyleProperty
Field Value
Xamarin.Forms.BindableProperty

SelectedItemProperty

Declaration
public static readonly BindableProperty SelectedItemProperty
Field Value
Xamarin.Forms.BindableProperty

SelectedItemsProperty

Declaration
public static readonly BindableProperty SelectedItemsProperty
Field Value
Xamarin.Forms.BindableProperty

SelectedItemStyleProperty

Declaration
public static readonly BindableProperty SelectedItemStyleProperty
Field Value
Xamarin.Forms.BindableProperty

SelectionGestureProperty

Declaration
public static readonly BindableProperty SelectionGestureProperty
Field Value
Xamarin.Forms.BindableProperty

SelectionModeProperty

Declaration
public static readonly BindableProperty SelectionModeProperty
Field Value
Xamarin.Forms.BindableProperty

shouldNotifySourceChange

Declaration
public bool shouldNotifySourceChange
Field Value
System.Boolean

SortDescriptorsProperty

Declaration
public static readonly BindableProperty SortDescriptorsProperty
Field Value
Xamarin.Forms.BindableProperty

SwipeOffsetProperty

Declaration
public static readonly BindableProperty SwipeOffsetProperty
Field Value
Xamarin.Forms.BindableProperty

SwipeThresholdProperty

Declaration
public static readonly BindableProperty SwipeThresholdProperty
Field Value
Xamarin.Forms.BindableProperty

VerticalScrollBarVisibilityProperty

Declaration
public static readonly BindableProperty VerticalScrollBarVisibilityProperty
Field Value
Xamarin.Forms.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>>

CommandService

Gets the CommandService instance that manages the commanding behavior of this instance.

Declaration
public CommandService CommandService { get; }
Property Value
CommandService

DisabledStateOpacity

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

FilterDescriptors

Declaration
public ObservableCollection<FilterDescriptorBase> FilterDescriptors { get; }
Property Value
System.Collections.ObjectModel.ObservableCollection<FilterDescriptorBase>

FooterTemplate

Specifies a Xamarin.Forms.DataTemplate to be displayed as a footer after all items.

Declaration
public DataTemplate FooterTemplate { get; set; }
Property Value
Xamarin.Forms.DataTemplate

GroupDescriptors

Declaration
public ObservableCollection<GroupDescriptorBase> GroupDescriptors { get; }
Property Value
System.Collections.ObjectModel.ObservableCollection<GroupDescriptorBase>

GroupHeaderStyle

Declaration
public ListViewGroupStyle GroupHeaderStyle { get; set; }
Property Value
ListViewGroupStyle

GroupHeaderTemplate

Declaration
public DataTemplate GroupHeaderTemplate { get; set; }
Property Value
Xamarin.Forms.DataTemplate

HeaderTemplate

Specifies a Xamarin.Forms.DataTemplate to be displayed as a header before all items.

Declaration
public DataTemplate HeaderTemplate { get; set; }
Property Value
Xamarin.Forms.DataTemplate

IsGroupHeaderSticky

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

IsItemsReorderEnabled

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

IsItemSwipeEnabled

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

IsLoadOnDemandActive

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

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

IsPullToRefreshActive

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

IsPullToRefreshEnabled

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

IsSwipingInProgress

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

ItemsSource

Declaration
public IEnumerable ItemsSource { get; set; }
Property Value
System.Collections.IEnumerable

ItemStyle

Declaration
public ListViewItemStyle ItemStyle { get; set; }
Property Value
ListViewItemStyle

ItemStyleSelector

Declaration
public ListViewStyleSelector ItemStyleSelector { get; set; }
Property Value
ListViewStyleSelector

ItemSwipeContentTemplate

Declaration
public DataTemplate ItemSwipeContentTemplate { get; set; }
Property Value
Xamarin.Forms.DataTemplate

ItemTemplate

Declaration
public DataTemplate ItemTemplate { get; set; }
Property Value
Xamarin.Forms.DataTemplate

ItemTemplateSelector

Declaration
public DataTemplateSelector ItemTemplateSelector { get; set; }
Property Value
Xamarin.Forms.DataTemplateSelector

LayoutDefinition

Declaration
public ListViewLayoutBase LayoutDefinition { get; set; }
Property Value
ListViewLayoutBase

LoadingOnDemandItemTemplate

Declaration
public DataTemplate LoadingOnDemandItemTemplate { get; set; }
Property Value
Xamarin.Forms.DataTemplate

LoadOnDemandBufferItemsCount

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

LoadOnDemandItemTemplate

Declaration
public DataTemplate LoadOnDemandItemTemplate { get; set; }
Property Value
Xamarin.Forms.DataTemplate

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

PressedItemStyle

Declaration
public ListViewItemStyle PressedItemStyle { get; set; }
Property Value
ListViewItemStyle

ReorderItemStyle

Declaration
public ListViewItemStyle ReorderItemStyle { get; set; }
Property Value
ListViewItemStyle

SelectedItem

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

SelectedItems

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

SelectedItemStyle

Declaration
public ListViewItemStyle SelectedItemStyle { get; set; }
Property Value
ListViewItemStyle

SelectionGesture

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

SelectionMode

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

SortDescriptors

Declaration
public ObservableCollection<SortDescriptorBase> SortDescriptors { get; }
Property Value
System.Collections.ObjectModel.ObservableCollection<SortDescriptorBase>

SwipeOffset

Declaration
public Thickness SwipeOffset { get; set; }
Property Value
Xamarin.Forms.Thickness

SwipeThreshold

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

VerticalScrollBarVisibility

Declaration
public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }
Property Value
Xamarin.Forms.ScrollBarVisibility

Methods

EndItemSwipe(Boolean)

Declaration
public void EndItemSwipe(bool isAnimated = false)
Parameters
System.Boolean isAnimated

EndRefresh(Boolean)

Declaration
public void EndRefresh(bool isAnimated = false)
Parameters
System.Boolean isAnimated

GetDataView()

Declaration
public IDataViewCollection GetDataView()
Returns
IDataViewCollection

OnBindingContextChanged()

Declaration
protected override void OnBindingContextChanged()

OnChildPropertyChanged(Object, String)

Declaration
public void OnChildPropertyChanged(object child, string propertyName)
Parameters
System.Object child

System.String propertyName

OnItemHold(Object)

Declaration
protected virtual void OnItemHold(object item)
Parameters
System.Object item

OnItemSwipeCompleted(Object, Double)

Declaration
protected virtual void OnItemSwipeCompleted(object item, double offset)
Parameters
System.Object item

System.Double offset

OnItemSwipeStarting(ItemSwipeStartingEventArgs)

Declaration
protected virtual void OnItemSwipeStarting(ItemSwipeStartingEventArgs args)
Parameters
ItemSwipeStartingEventArgs args

OnItemSwiping(Object, Double)

Declaration
protected virtual void OnItemSwiping(object item, double offset)
Parameters
System.Object item

System.Double offset

OnItemTap(Object)

Declaration
protected virtual void OnItemTap(object item)
Parameters
System.Object item

OnPropertyChanged(String)

Declaration
protected override void OnPropertyChanged(string propertyName = null)
Parameters
System.String propertyName

OnPullToRefreshRequested(PullToRefreshRequestedEventArgs)

Declaration
protected virtual void OnPullToRefreshRequested(PullToRefreshRequestedEventArgs args)
Parameters
PullToRefreshRequestedEventArgs args

OnSelectedItemsCollectionChanged(Object, NotifyCollectionChangedEventArgs)

Declaration
protected virtual void OnSelectedItemsCollectionChanged(object sender, NotifyCollectionChangedEventArgs e)
Parameters
System.Object sender

System.Collections.Specialized.NotifyCollectionChangedEventArgs e

ScrollItemIntoView(Object)

Declaration
public void ScrollItemIntoView(object item)
Parameters
System.Object item

Events

ChildPropertyChanged

Declaration
public event EventHandler<ElementPropertyChangedEventArgs> ChildPropertyChanged
Event Type
System.EventHandler<ElementPropertyChangedEventArgs>

GroupHeaderTapped

Declaration
public event EventHandler<GroupHeaderTapEventArgs> GroupHeaderTapped
Event Type
System.EventHandler<GroupHeaderTapEventArgs>

ItemHold

Declaration
public event EventHandler<ItemHoldEventArgs> ItemHold
Event Type
System.EventHandler<ItemHoldEventArgs>

ItemSwipeCompleted

Declaration
public event EventHandler<ItemSwipeCompletedEventArgs> ItemSwipeCompleted
Event Type
System.EventHandler<ItemSwipeCompletedEventArgs>

ItemSwipeStarting

Declaration
public event EventHandler<ItemSwipeStartingEventArgs> ItemSwipeStarting
Event Type
System.EventHandler<ItemSwipeStartingEventArgs>

ItemSwiping

Declaration
public event EventHandler<ItemSwipingEventArgs> ItemSwiping
Event Type
System.EventHandler<ItemSwipingEventArgs>

ItemTapped

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

Declaration
public event EventHandler<PullToRefreshRequestedEventArgs> RefreshRequested
Event Type
System.EventHandler<PullToRefreshRequestedEventArgs>

ReorderEnded

Declaration
public event EventHandler<ReorderEndedEventArgs> ReorderEnded
Event Type
System.EventHandler<ReorderEndedEventArgs>

ReorderStarting

Declaration
public event EventHandler<ReorderStartingEventArgs> ReorderStarting
Event Type
System.EventHandler<ReorderStartingEventArgs>

SelectionChanged

Declaration
public event EventHandler<NotifyCollectionChangedEventArgs> SelectionChanged
Event Type
System.EventHandler<System.Collections.Specialized.NotifyCollectionChangedEventArgs>