Class CollectionView

    Definition

    Namespace:
    Tizen.NUI.Components
    Assembly:
    Tizen.NUI.Components.dll

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

    public class CollectionView : RecyclerView, INotifyPropertyChanged, IDisposable
    Inheritance
    object
    BindableObject
    Tizen.NUI.Binding.Element
    BaseHandle
    Animatable
    Container
    View
    ViewWrapper
    CustomView
    VisualView
    Tizen.NUI.Components.Control
    ScrollableBase
    RecyclerView
    CollectionView
    Implements
    System.ComponentModel.INotifyPropertyChanged
    System.IDisposable

    Constructors

    View Source

    CollectionView()

    Base constructor.

    Declaration
    public CollectionView()
    View Source

    CollectionView(IEnumerable)

    Base constructor with ItemsSource

    Declaration
    public CollectionView(IEnumerable itemsSource)
    Parameters
    Type Name Description
    System.Collections.IEnumerable itemsSource

    item's data source

    Fields

    View Source

    SelectedItemProperty

    Binding Property of selected item in single selection.

    Declaration
    public static readonly BindableProperty SelectedItemProperty
    Field Value
    Type Description
    Tizen.NUI.Binding.BindableProperty
    View Source

    SelectedItemsProperty

    Binding Property of selected items list in multiple selection.

    Declaration
    public static readonly BindableProperty SelectedItemsProperty
    Field Value
    Type Description
    Tizen.NUI.Binding.BindableProperty
    View Source

    SelectionModeProperty

    Binding Property of selected items list in multiple selection.

    Declaration
    public static readonly BindableProperty SelectionModeProperty
    Field Value
    Type Description
    Tizen.NUI.Binding.BindableProperty

    Properties

    View Source

    Footer

    Footer item placed in bottom-most position.

    Declaration
    public RecyclerViewItem Footer { get; set; }
    Property Value
    Type Description
    RecyclerViewItem
    Remarks

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

    View Source

    Header

    Header item placed in top-most position.

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

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

    View Source

    ItemsLayouter

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

    Declaration
    public virtual ItemsLayouter ItemsLayouter { get; set; }
    Property Value
    Type Description
    ItemsLayouter
    View Source

    ItemsSource

    Item's source data in IEnumerable.

    Declaration
    public override IEnumerable ItemsSource { get; set; }
    Property Value
    Type Description
    System.Collections.IEnumerable
    Overrides
    RecyclerView.ItemsSource
    View Source

    ItemTemplate

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

    Declaration
    public override DataTemplate ItemTemplate { get; set; }
    Property Value
    Type Description
    DataTemplate
    Overrides
    RecyclerView.ItemTemplate
    View Source

    ScrollingDirection

    Scrolling direction to display items layout.

    Declaration
    public ScrollableBase.Direction ScrollingDirection { get; set; }
    Property Value
    Type Description
    ScrollableBase.Direction
    View Source

    SelectedItem

    Selected item in single selection.

    Declaration
    public object SelectedItem { get; set; }
    Property Value
    Type Description
    object
    View Source

    SelectedItems

    Selected items list in multiple selection.

    Declaration
    public IList<object> SelectedItems { get; }
    Property Value
    Type Description
    System.Collections.Generic.IList<T><object>
    View Source

    SelectionMode

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

    Declaration
    public ItemSelectionMode SelectionMode { get; set; }
    Property Value
    Type Description
    ItemSelectionMode

    Methods

    View Source

    Dispose(DisposeTypes)

    Dispose ItemsView and all children on it.

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

    Dispose type.

    Overrides
    Tizen.NUI.Components.RecyclerView.Dispose(Tizen.NUI.DisposeTypes)
    View Source

    OnRelayout(Vector2, RelayoutContainer)

    Declaration
    public override void OnRelayout(Vector2 size, RelayoutContainer container)
    Parameters
    Type Name Description
    Vector2 size
    RelayoutContainer container
    Overrides
    RecyclerView.OnRelayout(Vector2, RelayoutContainer)
    View Source

    OnScrolling(object, ScrollEventArgs)

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

    Declaration
    protected override void OnScrolling(object source, ScrollEventArgs args)
    Parameters
    Type Name Description
    object source

    Scroll source object

    ScrollEventArgs args

    Scroll event argument

    Overrides
    RecyclerView.OnScrolling(object, ScrollEventArgs)
    View Source

    OnSelectionChanged(SelectionChangedEventArgs)

    Internal selection callback.

    Declaration
    protected virtual void OnSelectionChanged(SelectionChangedEventArgs args)
    Parameters
    Type Name Description
    SelectionChangedEventArgs args
    View Source

    ScrollTo(int, bool, ItemScrollTo)

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

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

    Target item index of dataset.

    bool animate

    Boolean flag of animation.

    CollectionView.ItemScrollTo align

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

    View Source

    ScrollTo(float, bool)

    Scroll to specific position with or without animation.

    Declaration
    public void ScrollTo(float position, bool animate)
    Parameters
    Type Name Description
    float position

    Destination.

    bool animate

    Scroll with or without animation

    View Source

    UpdateSelectedItems(IList<object>)

    Update selected items list in multiple selection.

    Declaration
    public void UpdateSelectedItems(IList<object> newSelection)
    Parameters
    Type Name Description
    System.Collections.Generic.IList<T><object> newSelection

    updated selection list by user

    Events

    View Source

    SelectionChanged

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

    Declaration
    public event EventHandler<SelectionChangedEventArgs> SelectionChanged
    Event Type
    Type Description
    System.EventHandler<TEventArgs><SelectionChangedEventArgs>

    Implements

    System.ComponentModel.INotifyPropertyChanged
    System.IDisposable
    • View Source
    Back to top Copyright © 2016-2024 Samsung
    Generated by DocFX