Class

RadListView

Initializes a new instance of the RadListView class.

Declaration

public RadListView()

Identifies the CurrentItem dependency property.

Declaration

public static readonly DependencyProperty CurrentItemProperty

Field Value

Identifies the DisabledStateOpacity dependency property.

Declaration

public static readonly DependencyProperty DisabledStateOpacityProperty

Field Value

Identifies the EmptyContentDisplayMode dependency property.

Declaration

public static readonly DependencyProperty EmptyContentDisplayModeProperty

Field Value

Identifies the EmptyContent dependency property.

Declaration

public static readonly DependencyProperty EmptyContentProperty

Field Value

Identifies the EnsureCurrentItemIntoView dependency property.

Declaration

public static readonly DependencyProperty EnsureCurrentItemIntoViewProperty

Field Value

Identifies the GroupHeaderStyleSelector dependency property.

Declaration

public static readonly DependencyProperty GroupHeaderDisplayModeProperty

Field Value

Identifies the GroupHeaderStyle dependency property.

Declaration

public static readonly DependencyProperty GroupHeaderStyleProperty

Field Value

Identifies the GroupHeaderStyleSelector dependency property.

Declaration

public static readonly DependencyProperty GroupHeaderStyleSelectorProperty

Field Value

Identifies the GroupHeaderTemplate dependency property.

Declaration

public static readonly DependencyProperty GroupHeaderTemplateProperty

Field Value

Identifies the GroupHeaderTemplateSelector dependency property.

Declaration

public static readonly DependencyProperty GroupHeaderTemplateSelectorProperty

Field Value

Identifies the IncrementalLoadingBufferItemsCount dependency property.

Declaration

public static readonly DependencyProperty IncrementalLoadingBufferItemsCountProperty

Field Value

Identifies the IncrementalLoadingMode dependency property.

Declaration

public static readonly DependencyProperty IncrementalLoadingModeProperty

Field Value

Identifies the IsActionOnSwipeEnabled dependency property.

Declaration

public static readonly DependencyProperty IsActionOnSwipeEnabledProperty

Field Value

Identifies the IsBusyIndicatorEnabled dependency property.

Declaration

public static readonly DependencyProperty IsBusyIndicatorEnabledProperty

Field Value

Identifies the IsItemReorderEnabled dependency property.

Declaration

public static readonly DependencyProperty IsItemReorderEnabledProperty

Field Value

Identifies the IsPullToRefreshActive dependency property.

Declaration

public static readonly DependencyProperty IsPullToRefreshActiveProperty

Field Value

Identifies the IsPullToRefreshEnabled dependency property.

Declaration

public static readonly DependencyProperty IsPullToRefreshEnabledProperty

Field Value

Identifies the IsSynchronizedWithCurrentItem dependency property.

Declaration

public static readonly DependencyProperty IsSynchronizedWithCurrentItemProperty

Field Value

Identifies the ItemAddedAnimation dependency property.

Declaration

public static readonly DependencyProperty ItemAddedAnimationProperty

Field Value

Identifies the ItemAnimationMode dependency property.

Declaration

public static readonly DependencyProperty ItemAnimationModeProperty

Field Value

Identifies the ItemRemovedAnimation dependency property.

Declaration

public static readonly DependencyProperty ItemRemovedAnimationProperty

Field Value

Identifies the ItemStyle dependency property.

Declaration

public static readonly DependencyProperty ItemStyleProperty

Field Value

Identifies the ItemStyleSelector dependency property.

Declaration

public static readonly DependencyProperty ItemStyleSelectorProperty

Field Value

Identifies the ItemSwipeDirection dependency property.

Declaration

public static readonly DependencyProperty ItemSwipeDirectionProperty

Field Value

Identifies the ItemTemplate dependency property.

Declaration

public static readonly DependencyProperty ItemTemplateProperty

Field Value

Identifies the ItemTemplateSelector dependency property.

Declaration

public static readonly DependencyProperty ItemTemplateSelectorProperty

Field Value

Identifies the ItemsSource dependency property.

Declaration

public static readonly DependencyProperty ItemsSourceProperty

Field Value

Identifies the LayoutDefinition dependency property.

Declaration

public static readonly DependencyProperty LayoutDefinitionProperty

Field Value

Identifies the ListFooter dependency property.

Declaration

public static readonly DependencyProperty ListFooterProperty

Field Value

Identifies the ListHeader dependency property.

Declaration

public static readonly DependencyProperty ListHeaderProperty

Field Value

Identifies the Orientation dependency property.

Declaration

public static readonly DependencyProperty OrientationProperty

Field Value

Identifies the PullToRefreshScrollMode dependency property.

Declaration

public static readonly DependencyProperty PullToRefreshScrollModeProperty

Field Value

Identifies the RealizedItemsBufferScale dependency property.

Declaration

public static readonly DependencyProperty RealizedItemsBufferScaleProperty

Field Value

Identifies the ReorderMode dependency property.

Declaration

public static readonly DependencyProperty ReorderModeProperty

Field Value

Identifies the SelectedItem dependency property.

Declaration

public static readonly DependencyProperty SelectedItemProperty

Field Value

Identifies the SelectionMode dependency property.

Declaration

public static readonly DependencyProperty SelectionModeProperty

Field Value

Identifies the SwipeActionContent dependency property.

Declaration

public static readonly DependencyProperty SwipeActionContentProperty

Field Value

Gets the collection of AggregateDescriptorBase objects that defines the current aggregate functions to be applied when the data view is computed.

Declaration

public AggregateDescriptorCollection AggregateDescriptors { get; }

Property 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 CommandCollection<RadListView> Commands { get; }

Property Value

Gets the object instance from the ItemsSource that is currently considered as Current.

Declaration

public object CurrentItem { get; }

Property Value

Gets or sets the value of the opacity used when the ListView is disabled.

Declaration

public double DisabledStateOpacity { get; set; }

Property Value

Gets or sets the content that will be displayed when there are no items in the list view.

Declaration

public object EmptyContent { get; set; }

Property Value

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

Declaration

public EmptyContentDisplayMode EmptyContentDisplayMode { get; set; }

Property Value

Gets or sets a value indicating whether the CurrentItem should always be automatically scrolled into view.

Declaration

public bool EnsureCurrentItemIntoView { get; set; }

Property Value

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

Declaration

public FilterDescriptorCollection FilterDescriptors { get; }

Property Value

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

Gets or sets the ListViewGroupHeaderDisplayMode instance.

Declaration

public ListViewGroupHeaderDisplayMode GroupHeaderDisplayMode { get; set; }

Property Value

Gets or sets a Style that is applied to the group headers.

Declaration

public Style GroupHeaderStyle { get; set; }

Property Value

Gets or sets the StyleSelector that provides logic for customizing the appearance for each group header.

Declaration

public StyleSelector GroupHeaderStyleSelector { get; set; }

Property Value

Gets or sets a DataTemplate that represents the template applied to the group headers.

Declaration

public DataTemplate GroupHeaderTemplate { get; set; }

Property Value

Gets or sets the DataTemplateSelector that provides logic for customizing the DataTemplate for each group header.

Declaration

public DataTemplateSelector GroupHeaderTemplateSelector { get; set; }

Property Value

Gets or sets the incremental loading buffer items count.

Declaration

public int IncrementalLoadingBufferItemsCount { get; set; }

Property Value

Gets or sets a value that specifies the incremental loading mode.

Declaration

public BatchLoadingMode IncrementalLoadingMode { get; set; }

Property Value

Gets or sets a value indicating whether swipe gesture will display the item actions.

Declaration

public bool IsActionOnSwipeEnabled { get; set; }

Property Value

Gets or sets a value indicating whether a busy indicator will appear when the data from the source is being loaded.

Declaration

public bool IsBusyIndicatorEnabled { get; set; }

Property Value

Gets or sets a value indicating whether the reorder functionality is enabled.

Declaration

public bool IsItemReorderEnabled { get; set; }

Property Value

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

Declaration

public bool IsPullToRefreshActive { get; set; }

Property Value

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

Declaration

public bool IsPullToRefreshEnabled { get; set; }

Property Value

Gets or sets a value indicating whether the SelectedItem and CurrentItem are synchronized.

Declaration

public bool IsSynchronizedWithCurrentItem { get; set; }

Property Value

Gets or sets an animation that is played when an item is added.

Declaration

public RadAnimation ItemAddedAnimation { get; set; }

Property Value

Gets or sets a value that specifies how the item animations are played.

Declaration

public ItemAnimationMode ItemAnimationMode { get; set; }

Property Value

Gets or sets an animation that is played when an item is removed.

Declaration

public RadAnimation ItemRemovedAnimation { get; set; }

Property Value

Gets or sets a Style that is applied to each visual item in the control.

Declaration

public Style ItemStyle { get; set; }

Property Value

Gets or sets the StyleSelector that provides logic for customizing the appearance for each visual item in the control.

Declaration

public StyleSelector ItemStyleSelector { get; set; }

Property Value

Gets or sets the swipe direction of the item.

Declaration

public ListViewItemSwipeDirection ItemSwipeDirection { get; set; }

Property Value

Gets or sets the item's swipe offset.

Declaration

public Thickness ItemSwipeOffset { get; set; }

Property Value

Gets or sets the item's swipe threshold.

Declaration

public double ItemSwipeThreshold { get; set; }

Property Value

Gets or sets a DataTemplate that represents the template applied to each visual item in the control.

Declaration

public DataTemplate ItemTemplate { get; set; }

Property Value

Gets or sets the DataTemplateSelector that provides logic for customizing the DataTemplate for each visual item in the control.

Declaration

public DataTemplateSelector ItemTemplateSelector { get; set; }

Property Value

Gets or sets the source used to generate the content of the control.

Declaration

public object ItemsSource { get; set; }

Property Value

Gets or sets the the layout definition that specifies how the elements will be rendered.

Declaration

public LayoutDefinitionBase LayoutDefinition { get; set; }

Property Value

Gets or sets the content of the footer element.

Declaration

public object ListFooter { get; set; }

Property Value

Gets or sets the content of the header element.

Declaration

public object ListHeader { get; set; }

Property Value

Gets or sets the orientation of the control.

Declaration

public Orientation Orientation { get; set; }

Property Value

Gets or sets the scroll mode of pull to refresh indicator.

Declaration

public PullToRefreshScrollMode PullToRefreshScrollMode { get; set; }

Property Value

Gets or sets the relative to viewport size buffer scale that will be used to realize items outside viewport. Default value is 1.

Declaration

public double RealizedItemsBufferScale { get; set; }

Property Value

Gets or sets the reorder mode of the RadListView.

Declaration

public ListViewReorderMode ReorderMode { get; set; }

Property Value

Gets the scroll offset of the control.

Declaration

public double ScrollOffset { get; }

Property Value

Gets or sets a value indicating whether if the listView should scroll to the current item on tap.

Declaration

protected bool ScrollToCurrentItemOnTap { get; set; }

Property Value

Gets or sets the selected item of the RadListView.

Declaration

public object SelectedItem { get; set; }

Property Value

Gets the currently selected items within this instance.

Declaration

public BindableCollection<object> SelectedItems { get; }

Property Value

Gets or sets the selection mode of the RadListView. The default value is Single.

Declaration

public DataControlsSelectionMode SelectionMode { get; set; }

Property Value

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

Gets or sets the content of the second item action control.

Declaration

public object SwipeActionContent { get; set; }

Property Value

Called when the Framework is called. Inheritors should override this method should they have some custom template-related logic. This is done to ensure that the property is properly initialized.

Declaration

protected override bool ApplyTemplateCore()

Returns

Overrides RadControl.ApplyTemplateCore()

Undoes the effects of the PrepareContainerForGroupHeader method.

Declaration

protected virtual void ClearContainerForGroupHeader(ListViewGroupHeader item)

Parameters

Undoes the effects of the PrepareContainerForItem method.

Declaration

protected virtual void ClearContainerForItem(RadListViewItem item)

Parameters

Clears the current selection state.

Declaration

public void DeselectAll()

Removes the selection for the specified data item and removes it from the SelectedItems collection.

Declaration

public void DeselectItem(object item)

Parameters

Ends all currently running drag operations.

Declaration

public void EndItemSwipe()

Return the element used to display the group header.

Declaration

protected virtual ListViewGroupHeader GetContainerForGroupHeader()

Returns

Return the element used to display the group header.

Declaration

protected virtual ListViewGroupHeader GetContainerForGroupHeader(bool isFrozen)

Parameters

Returns

Return the element used to display the given item.

Declaration

protected virtual RadListViewItem GetContainerForItem()

Returns

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

Invalidate the ListViewLoadDataControl.

Declaration

protected void InvalidateLoadDataControl()

Recycles all containers and rebuilds the UI.

Declaration

protected virtual void InvalidateUI()

Called in the measure layout pass to determine the desired size.

Declaration

protected override Size MeasureOverride(Size availableSize)

Parameters

Returns

Overrides RadControl.MeasureOverride(Size)

Tries to change the CurrentItem to the specified object. Returns value indicating if the operation is successful.

Declaration

public bool MoveCurrentTo(object item)

Parameters

Returns

Declaration

protected override AutomationPeer OnCreateAutomationPeer()

Returns

Overrides RadControl.OnCreateAutomationPeer()

Throws the command when group header gets tapped.

Declaration

protected virtual void OnGroupHeaderTap(ListViewGroupHeader header)

Parameters

Occurs when the method has been called and the template is already successfully applied.

Declaration

protected override void OnTemplateApplied()

Overrides RadControl.OnTemplateApplied()

Prepare the element to act as the ItemUI for the corresponding group header.

Declaration

protected virtual void PrepareContainerForGroupHeader(ListViewGroupHeader groupHeader, GroupHeaderContext context)

Parameters

Prepare the element to act as the ItemUI for the corresponding item.

Declaration

protected virtual void PrepareContainerForItem(RadListViewItem item, object context)

Parameters

Prepare the ListViewLoadDataControl.

Declaration

protected virtual void PrepareLoadDataControl(ListViewLoadDataControl control)

Parameters

Invalidates the measure of the RadListView content panel.

Declaration

public void RebuildUI()

Attempts to bring the specified index into view asynchronously.

Declaration

public void ScrollIndexIntoView(int index)

Parameters

Attempts to bring the specified index into view asynchronously.

Declaration

public void ScrollIndexIntoView(int index, Action scrollCompletedAction)

Parameters

Attempts to bring the specified data item into view asynchronously.

Declaration

public void ScrollItemIntoView(object item)

Parameters

Attempts to bring the specified data item into view asynchronously.

Declaration

public void ScrollItemIntoView(object item, Action scrollCompletedAction)

Parameters

Scrolls the RadListView to the specified position.

Declaration

public void ScrollToPosition(Point position)

Parameters

Selects all the items as defined by the SelectionMode property.

Declaration

public void SelectAll()

Selects the specified data item and adds it in the SelectedItems collection.

Declaration

public void SelectItem(object item)

Parameters

Removes the current control template. Occurs when a template has already been applied and a new one is applied.

Declaration

protected override void UnapplyTemplateCore()

Overrides RadControl.UnapplyTemplateCore()

Called within the handler of the event. Allows inheritors to provide their specific logic.

Declaration

protected override void UnloadCore()

Overrides RadControl.UnloadCore()

Occurs when the CurrentItem property has changed.

Declaration

public event EventHandler CurrentItemChanged

Event Value

Occurs when the CurrentItem property is about to change. The event may be canceled to prevent the actual change.

Declaration

public event CurrentChangingEventHandler CurrentItemChanging

Event Value

Occurs when Pull to refresh is initiated.

Declaration

public event EventHandler RefreshRequested

Event Value

Declaration

public event EventHandler<ReorderEndedEventArgs> ReorderEnded

Event Value

Declaration

public event EventHandler<ReorderStartingEventArgs> ReorderStarting

Event Value

Occurs when the currently selected items change.

Declaration

public event EventHandler<ListViewSelectionChangedEventArgs> SelectionChanged

Event Value