Class

RadListView

Initializes a new instance of the RadListView class.

Declaration

public RadListView()

Identifies the DisabledStateOpacity property.

Declaration

public static readonly BindableProperty DisabledStateOpacityProperty

Field Value

Identifies the FilterDescriptors property.

Declaration

public static readonly BindableProperty FilterDescriptorsProperty

Field Value

Identifies the FooterTemplate property.

Declaration

public static readonly BindableProperty FooterTemplateProperty

Field Value

Identifies the GroupDescriptors property.

Declaration

public static readonly BindableProperty GroupDescriptorsProperty

Field Value

Identifies the GroupHeaderStyle property.

Declaration

public static readonly BindableProperty GroupHeaderStyleProperty

Field Value

Identifies the GroupHeaderTemplate property.

Declaration

public static readonly BindableProperty GroupHeaderTemplateProperty

Field Value

Identifies the HeaderTemplate property.

Declaration

public static readonly BindableProperty HeaderTemplateProperty

Field Value

Identifies the IsGroupHeaderSticky property.

Declaration

public static readonly BindableProperty IsGroupHeaderStickyProperty

Field Value

Identifies the IsItemSwipeEnabled property.

Declaration

public static readonly BindableProperty IsItemSwipeEnabledProperty

Field Value

Identifies the IsItemsReorderEnabled property.

Declaration

public static readonly BindableProperty IsItemsReorderEnabledProperty

Field Value

Identifies the IsLoadOnDemandActive bindable property.

Declaration

public static readonly BindableProperty IsLoadOnDemandActiveProperty

Field Value

Identifies the IsLoadOnDemandEnabled bindable property.

Declaration

public static readonly BindableProperty IsLoadOnDemandEnabledProperty

Field Value

Identifies the IsPullToRefreshActive property.

Declaration

public static readonly BindableProperty IsPullToRefreshActiveProperty

Field Value

Identifies the IsPullToRefreshEnabled property.

Declaration

public static readonly BindableProperty IsPullToRefreshEnabledProperty

Field Value

Identifies the ItemStyle property.

Declaration

public static readonly BindableProperty ItemStyleProperty

Field Value

Identifies the ItemStyleSelector property.

Declaration

public static readonly BindableProperty ItemStyleSelectorProperty

Field Value

Identifies the ItemSwipeContentTemplate property.

Declaration

public static readonly BindableProperty ItemSwipeContentTemplateProperty

Field Value

Identifies the ItemTemplate property.

Declaration

public static readonly BindableProperty ItemTemplateProperty

Field Value

Identifies the ItemTemplateSelector property.

Declaration

public static readonly BindableProperty ItemTemplateSelectorProperty

Field Value

Identifies the ItemsSource property.

Declaration

public static readonly BindableProperty ItemsSourceProperty

Field Value

Identifies the LayoutDefinition property.

Declaration

public static readonly BindableProperty LayoutDefinitionProperty

Field Value

Identifies the LoadOnDemandBufferItemsCount bindable property.

Declaration

public static readonly BindableProperty LoadOnDemandBufferItemsCountProperty

Field Value

Identifies the LoadOnDemandItemTemplate bindable property.

Declaration

public static readonly BindableProperty LoadOnDemandItemTemplateProperty

Field Value

Identifies the LoadOnDemandMode bindable property.

Declaration

public static readonly BindableProperty LoadOnDemandModeProperty

Field Value

Identifies the LoadingOnDemandItemTemplate bindable property.

Declaration

public static readonly BindableProperty LoadingOnDemandItemTemplateProperty

Field Value

Identifies the PressedItemStyle property.

Declaration

public static readonly BindableProperty PressedItemStyleProperty

Field Value

Identifies the ReorderItemStyle property.

Declaration

public static readonly BindableProperty ReorderItemStyleProperty

Field Value

Identifies the SelectedItem bindable property.

Declaration

public static readonly BindableProperty SelectedItemProperty

Field Value

Identifies the SelectedItemStyle property.

Declaration

public static readonly BindableProperty SelectedItemStyleProperty

Field Value

Identifies the SelectedItems bindable property.

Declaration

public static readonly BindableProperty SelectedItemsProperty

Field Value

Identifies the SelectionGesture bindable property.

Declaration

public static readonly BindableProperty SelectionGestureProperty

Field Value

Identifies the SelectionMode bindable property.

Declaration

public static readonly BindableProperty SelectionModeProperty

Field Value

Identifies the SortDescriptors property.

Declaration

public static readonly BindableProperty SortDescriptorsProperty

Field Value

Identifies the SwipeOffset property.

Declaration

public static readonly BindableProperty SwipeOffsetProperty

Field Value

Identifies the SwipeThreshold property.

Declaration

public static readonly BindableProperty SwipeThresholdProperty

Field Value

Identifies the VerticalScrollBarVisibility property.

Declaration

public static readonly BindableProperty VerticalScrollBarVisibilityProperty

Field Value

Gets or sets a value indicating whether source change notifications should be sent.

Declaration

public bool shouldNotifySourceChange

Field Value

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

Declaration

public CommandService CommandService { get; }

Property Value

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

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

Declaration

public double DisabledStateOpacity { get; set; }

Property Value

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

Declaration

public ObservableCollection<FilterDescriptorBase> FilterDescriptors { get; }

Property Value

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

Declaration

public DataTemplate FooterTemplate { get; set; }

Property Value

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

Declaration

public ObservableCollection<GroupDescriptorBase> GroupDescriptors { get; }

Property Value

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

Declaration

public ListViewGroupStyle GroupHeaderStyle { get; set; }

Property Value

Gets or sets the data template used for group headers.

Declaration

public DataTemplate GroupHeaderTemplate { get; set; }

Property Value

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

Declaration

public DataTemplate HeaderTemplate { get; set; }

Property Value

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

Declaration

public bool IsGroupHeaderSticky { get; set; }

Property Value

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

Declaration

public bool IsItemSwipeEnabled { get; set; }

Property Value

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

Declaration

public bool IsItemsReorderEnabled { get; set; }

Property Value

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

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

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

Declaration

public bool IsPullToRefreshActive { get; set; }

Property Value

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

Declaration

public bool IsPullToRefreshEnabled { get; set; }

Property Value

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

Declaration

public bool IsSwipingInProgress { get; }

Property Value

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

Declaration

public ListViewItemStyle ItemStyle { get; set; }

Property Value

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

Declaration

public ListViewStyleSelector ItemStyleSelector { get; set; }

Property Value

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

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

Declaration

public DataTemplate ItemTemplate { get; set; }

Property Value

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

Declaration

public DataTemplateSelector ItemTemplateSelector { get; set; }

Property Value

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

Declaration

public IEnumerable ItemsSource { get; set; }

Property Value

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

Declaration

public ListViewLayoutBase LayoutDefinition { get; set; }

Property Value

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

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

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

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

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

Declaration

public ListViewItemStyle PressedItemStyle { get; set; }

Property Value

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

Declaration

public ListViewItemStyle ReorderItemStyle { get; set; }

Property Value

Gets or sets the selected item.

Declaration

public object SelectedItem { get; set; }

Property Value

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

Declaration

public ListViewItemStyle SelectedItemStyle { get; set; }

Property Value

Gets the collection of selected items.

Declaration

public ObservableCollection<object> SelectedItems { get; }

Property Value

Gets or sets the gesture used to select items.

Declaration

public SelectionGesture SelectionGesture { get; set; }

Property Value

Gets or sets the selection mode.

Declaration

public SelectionMode SelectionMode { get; set; }

Property Value

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

Declaration

public ObservableCollection<SortDescriptorBase> SortDescriptors { get; }

Property Value

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

Declaration

public Thickness SwipeOffset { get; set; }

Property Value

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

Declaration

public double SwipeThreshold { get; set; }

Property Value

Gets or sets the visibility of the vertical scroll bar.

Declaration

public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }

Property Value

Ends the current item swipe operation.

Declaration

public void EndItemSwipe(bool isAnimated = false)

Parameters

Ends the current pull-to-refresh operation.

Declaration

public void EndRefresh(bool isAnimated = false)

Parameters

Gets the data view collection associated with this RadListView.

Declaration

public IDataViewCollection GetDataView()

Returns

Called when the binding context changes.

Declaration

protected override void OnBindingContextChanged()

Notifies that a child element's property has changed.

Declaration

public void OnChildPropertyChanged(object child, string propertyName)

Parameters

Called when an item is held (long pressed).

Declaration

protected virtual void OnItemHold(object item)

Parameters

Called when an item swipe operation has completed.

Declaration

protected virtual void OnItemSwipeCompleted(object item, double offset)

Parameters

Called when an item swipe operation is starting.

Declaration

protected virtual void OnItemSwipeStarting(ItemSwipeStartingEventArgs args)

Parameters

Called while an item is being swiped.

Declaration

protected virtual void OnItemSwiping(object item, double offset)

Parameters

Called when an item is tapped.

Declaration

protected virtual void OnItemTap(object item)

Parameters

Called when a property value changes.

Declaration

protected override void OnPropertyChanged(string propertyName = null)

Parameters

Overrides RadView.OnPropertyChanged(string)

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

Declaration

protected virtual void OnPullToRefreshRequested(PullToRefreshRequestedEventArgs args)

Parameters

Called when the selected items collection changes.

Declaration

protected virtual void OnSelectedItemsCollectionChanged(object sender, NotifyCollectionChangedEventArgs e)

Parameters

Scrolls the specified item into view.

Declaration

public void ScrollItemIntoView(object item)

Parameters

Occurs when a child element's property has changed.

Declaration

public event EventHandler<ElementPropertyChangedEventArgs> ChildPropertyChanged

Event Value

Occurs when a group header is tapped.

Declaration

public event EventHandler<GroupHeaderTapEventArgs> GroupHeaderTapped

Event Value

Occurs when an item is held (long pressed).

Declaration

public event EventHandler<ItemHoldEventArgs> ItemHold

Event Value

Occurs when an item swipe operation has completed.

Declaration

public event EventHandler<ItemSwipeCompletedEventArgs> ItemSwipeCompleted

Event Value

Occurs when an item swipe operation is starting.

Declaration

public event EventHandler<ItemSwipeStartingEventArgs> ItemSwipeStarting

Event Value

Occurs while an item is being swiped.

Declaration

public event EventHandler<ItemSwipingEventArgs> ItemSwiping

Event Value

Occurs when an item is tapped.

Declaration

public event EventHandler<ItemTapEventArgs> ItemTapped

Event Value

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 Value

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

Declaration

public event EventHandler<PullToRefreshRequestedEventArgs> RefreshRequested

Event Value

Occurs when an item reorder operation has ended.

Declaration

public event EventHandler<ReorderEndedEventArgs> ReorderEnded

Event Value

Occurs when an item reorder operation is starting.

Declaration

public event EventHandler<ReorderStartingEventArgs> ReorderStarting

Event Value

Occurs when the selection changes.

Declaration

public event EventHandler<NotifyCollectionChangedEventArgs> SelectionChanged

Event Value