Class CollectionView

Definition

Namespace:
Tizen.NUI.Components
Assembly:
Tizen.NUI.Components.dll
API Level:
9

Selectable RecyclerView that presenting a collection of items with variable layouters.

C#
Copy
public class CollectionView : RecyclerView, INotifyPropertyChanged, IDynamicResourceHandler, IElement, INameScope, IElementController, IDisposable, IResourcesProvider, ICollectionChangedNotifier
Inheritance
System.Object
Tizen.NUI.Binding.Element
Tizen.NUI.Components.Control
CollectionView
Implements
System.ComponentModel.INotifyPropertyChanged
System.IDisposable

Constructors

View Source

CollectionView()

Base constructor.

Declaration
C#
Copy
public CollectionView()
API Level: 9
View Source

CollectionView(IEnumerable)

Base constructor with ItemsSource

Declaration
C#
Copy
public CollectionView(IEnumerable itemsSource)
Parameters
Type Name Description
IEnumerable itemsSource

item's data source

API Level: 9

Fields

View Source

SelectedItemProperty

Binding Property of selected item in single selection.

Declaration
C#
Copy
public static readonly BindableProperty SelectedItemProperty
Field Value
Type Description
Tizen.NUI.Binding.BindableProperty
API Level: 9
View Source

SelectedItemsProperty

Binding Property of selected items list in multiple selection.

Declaration
C#
Copy
public static readonly BindableProperty SelectedItemsProperty
Field Value
Type Description
Tizen.NUI.Binding.BindableProperty
API Level: 9
View Source

SelectionModeProperty

Binding Property of selected items list in multiple selection.

Declaration
C#
Copy
public static readonly BindableProperty SelectionModeProperty
Field Value
Type Description
Tizen.NUI.Binding.BindableProperty
API Level: 9

Properties

View Source

Footer item placed in bottom-most position.

Declaration
C#
Copy
public RecyclerViewItem Footer { get; set; }
Property Value
Type Description
RecyclerViewItem

Please note that, internal index will be increased by footer.

API Level: 9
View Source

Header

Header item placed in top-most position.

Declaration
C#
Copy
public RecyclerViewItem Header { get; set; }
Property Value
Type Description
RecyclerViewItem
Remarks

Please note that, internal index will be increased by header.

API Level: 9
View Source

ItemsLayouter

Items Layouter. Layouting items on the scroll ContentContainer. ItemsLayouter LinearLayouter GridLayouter

Declaration
C#
Copy
public virtual ItemsLayouter ItemsLayouter { get; set; }
Property Value
Type Description
ItemsLayouter
API Level: 9
View Source

ItemsSource

Item's source data in IEnumerable.

Declaration
C#
Copy
public override IEnumerable ItemsSource { get; set; }
Property Value
Type Description
IEnumerable
Overrides
API Level: 9
View Source

ItemTemplate

DataTemplate for items. Create visual contents and binding properties. return object type is restricted RecyclerViewItem. DataTemplate

Declaration
C#
Copy
public override DataTemplate ItemTemplate { get; set; }
Property Value
Type Description
DataTemplate
Overrides
API Level: 9
View Source

ScrollingDirection

Scrolling direction to display items layout.

Declaration
C#
Copy
public ScrollableBase.Direction ScrollingDirection { get; set; }
Property Value
Type Description
ScrollableBase.Direction
API Level: 9
View Source

SelectedItem

Selected item in single selection.

Declaration
C#
Copy
public object SelectedItem { get; set; }
Property Value
Type Description
System.Object
API Level: 9
View Source

SelectedItems

Selected items list in multiple selection.

Declaration
C#
Copy
public IList<object> SelectedItems { get; }
Property Value
Type Description
System.Collections.Generic.IList<System.Object>
API Level: 9
View Source

SelectionMode

Selection mode to handle items selection. See ItemSelectionMode for details.

Declaration
C#
Copy
public ItemSelectionMode SelectionMode { get; set; }
Property Value
Type Description
ItemSelectionMode
API Level: 9

Methods

View Source

Dispose(DisposeTypes)

Dispose ItemsView and all children on it.

Declaration
C#
Copy
protected override void Dispose(DisposeTypes type)
Parameters
Type Name Description
DisposeTypes type

Dispose type.

Overrides
Tizen.NUI.Components.RecyclerView.Dispose(Tizen.NUI.DisposeTypes)
API Level: 9
View Source

OnRelayout(Vector2, RelayoutContainer)

Declaration
C#
Copy
public override void OnRelayout(Vector2 size, RelayoutContainer container)
Parameters
Type Name Description
Vector2 size
RelayoutContainer container
Overrides
API Level: 9
View Source

OnScrolling(Object, ScrollEventArgs)

OnScroll event callback. Requesting layout to the layouter with given scrollPosition.

Declaration
C#
Copy
protected override void OnScrolling(object source, ScrollEventArgs args)
Parameters
Type Name Description
System.Object source

Scroll source object

ScrollEventArgs args

Scroll event argument

Overrides
API Level: 9
View Source

OnSelectionChanged(SelectionChangedEventArgs)

Internal selection callback.

Declaration
C#
Copy
protected virtual void OnSelectionChanged(SelectionChangedEventArgs args)
Parameters
Type Name Description
SelectionChangedEventArgs args
API Level: 9
View Source

ScrollTo(Int32, Boolean, CollectionView.ItemScrollTo)

Scroll to specific item's aligned position with or without animation.

Declaration
C#
Copy
public virtual void ScrollTo(int index, bool animate = false, CollectionView.ItemScrollTo align = CollectionView.ItemScrollTo.Nearest)
Parameters
Type Name Description
Int32 index

Target item index of dataset.

Boolean animate

Boolean flag of animation.

CollectionView.ItemScrollTo align

Align state of item. See details in CollectionView.ItemScrollTo.

API Level: 9
View Source

ScrollTo(Single, Boolean)

Scroll to specific position with or without animation.

Declaration
C#
Copy
public void ScrollTo(float position, bool animate)
Parameters
Type Name Description
System.Single position

Destination.

Boolean animate

Scroll with or without animation

API Level: 9
View Source

UpdateSelectedItems(IList<Object>)

Update selected items list in multiple selection.

Declaration
C#
Copy
public void UpdateSelectedItems(IList<object> newSelection)
Parameters
Type Name Description
System.Collections.Generic.IList<System.Object> newSelection

updated selection list by user

API Level: 9

Events

View Source

SelectionChanged

Event of Selection changed. previous selection list and current selection will be provided.

Declaration
C#
Copy
public event EventHandler<SelectionChangedEventArgs> SelectionChanged
Event Type
Type Description
System.EventHandler<SelectionChangedEventArgs>
API Level: 9

Implements

System.ComponentModel.INotifyPropertyChanged
System.IDisposable