Class RecycleItemsView
A ScrollView that efficiently displays a collections of data using DataTemplate
Inheritance
Implements
Inherited Members
Namespace: Tizen.TV.UIControls.Forms
Assembly: Tizen.TV.UIControls.Forms.dll
Syntax
public class RecycleItemsView : ContentView, INotifyPropertyChanged, IDynamicResourceHandler, IElement, INameScope, INavigationProxy, IStyleSelectable, IAnimatable, IResourcesProvider, IStyleElement, IFlowDirectionController, IPropertyPropagationController, IVisualController, ITabStopElement, IStylable, IViewController, IVisualElementController, IElementController, IGestureController, IGestureRecognizers, ILayout, ILayoutController, IPaddingElement, IControlTemplated, IRecycleItemsViewController
Constructors
RecycleItemsView()
Creates and initializes a new instance of the RecycleItemsView class.
Declaration
public RecycleItemsView()
Fields
AllowFocusFooterProperty
Backing store for the AllowFocusFooter property.
Declaration
public static readonly BindableProperty AllowFocusFooterProperty
Field Value
Type | Description |
---|---|
Xamarin.Forms.BindableProperty |
AllowFocusHeaderProperty
Backing store for the AllowFocusHeader property.
Declaration
public static readonly BindableProperty AllowFocusHeaderProperty
Field Value
Type | Description |
---|---|
Xamarin.Forms.BindableProperty |
ColumnCountProperty
Backing store for the ColumnCount property.
Declaration
public static readonly BindableProperty ColumnCountProperty
Field Value
Type | Description |
---|---|
Xamarin.Forms.BindableProperty |
ContentMarginProperty
Backing store for the ContentMargin property.
Declaration
public static readonly BindableProperty ContentMarginProperty
Field Value
Type | Description |
---|---|
Xamarin.Forms.BindableProperty |
FocusedItemProperty
Backing store for the FocusedItem property.
Declaration
public static readonly BindableProperty FocusedItemProperty
Field Value
Type | Description |
---|---|
Xamarin.Forms.BindableProperty |
FooterProperty
Backing store for the Footer property.
Declaration
public static readonly BindableProperty FooterProperty
Field Value
Type | Description |
---|---|
Xamarin.Forms.BindableProperty |
FooterTemplateProperty
Backing store for the FooterTemplate property.
Declaration
public static readonly BindableProperty FooterTemplateProperty
Field Value
Type | Description |
---|---|
Xamarin.Forms.BindableProperty |
HeaderProperty
Backing store for the Header property.
Declaration
public static readonly BindableProperty HeaderProperty
Field Value
Type | Description |
---|---|
Xamarin.Forms.BindableProperty |
HeaderTemplateProperty
Backing store for the HeaderTemplate property.
Declaration
public static readonly BindableProperty HeaderTemplateProperty
Field Value
Type | Description |
---|---|
Xamarin.Forms.BindableProperty |
ItemHeightProperty
Backing store for the ItemHeight property.
Declaration
public static readonly BindableProperty ItemHeightProperty
Field Value
Type | Description |
---|---|
Xamarin.Forms.BindableProperty |
ItemsSourceProperty
Backing store for the ItemsSource property.
Declaration
public static readonly BindableProperty ItemsSourceProperty
Field Value
Type | Description |
---|---|
Xamarin.Forms.BindableProperty |
ItemTemplateProperty
Backing store for the ItemTemplate property.
Declaration
public static readonly BindableProperty ItemTemplateProperty
Field Value
Type | Description |
---|---|
Xamarin.Forms.BindableProperty |
ItemWidthProperty
Backing store for the ItemWidth property.
Declaration
public static readonly BindableProperty ItemWidthProperty
Field Value
Type | Description |
---|---|
Xamarin.Forms.BindableProperty |
OrientationProperty
Backing store for the Orientation property.
Declaration
public static readonly BindableProperty OrientationProperty
Field Value
Type | Description |
---|---|
Xamarin.Forms.BindableProperty |
ScrollBarVisibilityProperty
Backing store for the ScrollBarVisibility property.
Declaration
public static readonly BindableProperty ScrollBarVisibilityProperty
Field Value
Type | Description |
---|---|
Xamarin.Forms.BindableProperty |
ScrollPolicyProperty
Backing store for the ScrollPolicy property.
Declaration
public static readonly BindableProperty ScrollPolicyProperty
Field Value
Type | Description |
---|---|
Xamarin.Forms.BindableProperty |
SelectedItemProperty
Backing store for the SelectedItem property.
Declaration
public static readonly BindableProperty SelectedItemProperty
Field Value
Type | Description |
---|---|
Xamarin.Forms.BindableProperty |
SpacingProperty
Backing store for the Spacing property.
Declaration
public static readonly BindableProperty SpacingProperty
Field Value
Type | Description |
---|---|
Xamarin.Forms.BindableProperty |
Properties
AllowFocusFooter
Gets or sets the focusable on footer
Declaration
public bool AllowFocusFooter { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
AllowFocusHeader
Gets or sets the focusable on header
Declaration
public bool AllowFocusHeader { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
ColumnCount
Gets or sets the count of columns.
Declaration
public int ColumnCount { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
ContentMargin
Gets or sets the margin for the content.
Declaration
public Thickness ContentMargin { get; set; }
Property Value
Type | Description |
---|---|
Xamarin.Forms.Thickness |
FocusedItem
Gets or sets the currently focused item from the ItemsSource.
Declaration
public object FocusedItem { get; set; }
Property Value
Type | Description |
---|---|
System.Object |
Footer
Gets or sets the binding, or view that will be displayed at the last of the items.
Declaration
public object Footer { get; set; }
Property Value
Type | Description |
---|---|
System.Object |
FooterElement
Gets instantiated Footer view
Declaration
public View FooterElement { get; protected set; }
Property Value
Type | Description |
---|---|
Xamarin.Forms.View |
FooterTemplate
Gets or sets a data template to use to format a data object for display Footer.
Declaration
public DataTemplate FooterTemplate { get; set; }
Property Value
Type | Description |
---|---|
Xamarin.Forms.DataTemplate |
Header
Gets or sets the binding, or view that will be displayed at the first of the items.
Declaration
public object Header { get; set; }
Property Value
Type | Description |
---|---|
System.Object |
HeaderElement
Gets instantiated Header view
Declaration
public View HeaderElement { get; protected set; }
Property Value
Type | Description |
---|---|
Xamarin.Forms.View |
HeaderTemplate
Gets or sets a data template to use to format a data object for display Header.
Declaration
public DataTemplate HeaderTemplate { get; set; }
Property Value
Type | Description |
---|---|
Xamarin.Forms.DataTemplate |
ItemHeight
Gets or sets a value that represents the height of an item.
Declaration
public double ItemHeight { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
ItemsSource
Gets or sets the source of items to template and display.
Declaration
public IEnumerable ItemsSource { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.IEnumerable |
ItemTemplate
Gets or sets the DataTemplate to apply to the ItemsSource.
Declaration
public DataTemplate ItemTemplate { get; set; }
Property Value
Type | Description |
---|---|
Xamarin.Forms.DataTemplate |
ItemWidth
Gets or sets a value that represents the width of an item.
Declaration
public double ItemWidth { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
Orientation
Gets or sets the value which indicates the direction which items are positioned.
Declaration
public RecycleItemsViewOrientation Orientation { get; set; }
Property Value
Type | Description |
---|---|
RecycleItemsViewOrientation |
RedundantItemCount
declare the number of items to make redundant.
Declaration
protected virtual int RedundantItemCount { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
ScrollBarVisibility
Gets or sets the scroll bar visibility.
Declaration
public ScrollBarVisibility ScrollBarVisibility { get; set; }
Property Value
Type | Description |
---|---|
Xamarin.Forms.ScrollBarVisibility |
ScrollPolicy
Gets or sets the scroll position policy.
Declaration
public ScrollToPosition ScrollPolicy { get; set; }
Property Value
Type | Description |
---|---|
Xamarin.Forms.ScrollToPosition |
ScrollView
Gets the ScrollView internally created.
Declaration
protected ScrollView ScrollView { get; }
Property Value
Type | Description |
---|---|
Xamarin.Forms.ScrollView |
SelectedItem
Gets or sets the currently selected item from the ItemsSource.
Declaration
public object SelectedItem { get; set; }
Property Value
Type | Description |
---|---|
System.Object |
Spacing
Gets or sets a value which indicates the amount of space between each item.
Declaration
public double Spacing { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
Methods
CreateScrollView()
Create a ScrollView that used in RecycleItemsView.
Declaration
protected virtual ScrollView CreateScrollView()
Returns
Type | Description |
---|---|
Xamarin.Forms.ScrollView | ScrollView |
InitializeComponent()
Declaration
protected void InitializeComponent()
LayoutChildren(Double, Double, Double, Double)
Declaration
protected override void LayoutChildren(double x, double y, double width, double height)
Parameters
Type | Name | Description |
---|---|---|
System.Double | x | |
System.Double | y | |
System.Double | width | |
System.Double | height |
Overrides
OnItemFocused(Object, View, Boolean)
Called when Item is focused
Declaration
protected virtual void OnItemFocused(object data, View targetView, bool isFocused)
Parameters
Type | Name | Description |
---|---|---|
System.Object | data | The focused item from the ItemsSource. |
Xamarin.Forms.View | targetView | Instantiated View |
System.Boolean | isFocused | Whether or not focused |
OnMeasure(Double, Double)
Declaration
protected override SizeRequest OnMeasure(double widthConstraint, double heightConstraint)
Parameters
Type | Name | Description |
---|---|---|
System.Double | widthConstraint | |
System.Double | heightConstraint |
Returns
Type | Description |
---|---|
Xamarin.Forms.SizeRequest |
Overrides
OnSizeAllocated(Double, Double)
Declaration
protected override void OnSizeAllocated(double width, double height)
Parameters
Type | Name | Description |
---|---|---|
System.Double | width | |
System.Double | height |
Overrides
ScrollToAsync(Double, Double, Boolean)
Returns a task that scrolls the scroll view to a position asynchronously.
Declaration
public Task ScrollToAsync(double x, double y, bool animation)
Parameters
Type | Name | Description |
---|---|---|
System.Double | x | The X position of the finished scroll. |
System.Double | y | The Y position of the finished scroll. |
System.Boolean | animation | Whether or not to animate the scroll. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Task |
ScrollToAsync(Object, ScrollToPosition, Boolean)
Returns a task that scrolls the scroll view to an item asynchronously.
Declaration
public Task ScrollToAsync(object item, ScrollToPosition position, bool animation)
Parameters
Type | Name | Description |
---|---|---|
System.Object | item | The item to scroll. |
Xamarin.Forms.ScrollToPosition | position | The scroll position. |
System.Boolean | animation | Whether or not to animate the scroll. |
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | Task |
Events
ItemFocused
Event that is raised when a new item is focused.
Declaration
public event EventHandler<FocusedItemChangedEventArgs> ItemFocused
Event Type
Type | Description |
---|---|
System.EventHandler<FocusedItemChangedEventArgs> |
ItemRealized
Event that is raised when a item's view is attached the RecycleItemsView.
Declaration
public event EventHandler<ItemRealizedEventArgs> ItemRealized
Event Type
Type | Description |
---|---|
System.EventHandler<ItemRealizedEventArgs> |
ItemSelected
Event that is raised when a new item is selected.
Declaration
public event EventHandler<SelectedItemChangedEventArgs> ItemSelected
Event Type
Type | Description |
---|---|
System.EventHandler<Xamarin.Forms.SelectedItemChangedEventArgs> |
ItemUnrealized
Event that is raised when a item's view is detached the RecycleItemsView.
Declaration
public event EventHandler<ItemUnrealizedEventArgs> ItemUnrealized
Event Type
Type | Description |
---|---|
System.EventHandler<ItemUnrealizedEventArgs> |
Explicit Interface Implementations
IRecycleItemsViewController.FocusedView
Declaration
View IRecycleItemsViewController.FocusedView { get; }
Returns
Type | Description |
---|---|
Xamarin.Forms.View |
IRecycleItemsViewController.ScrollBounds
Declaration
Rectangle IRecycleItemsViewController.ScrollBounds { get; }
Returns
Type | Description |
---|---|
Xamarin.Forms.Rectangle |
IRecycleItemsViewController.SendKeyDown(String)
Declaration
bool IRecycleItemsViewController.SendKeyDown(string keyname)
Parameters
Type | Name | Description |
---|---|---|
System.String | keyname |
Returns
Type | Description |
---|---|
System.Boolean |