Class ScrollableBase

Definition

Namespace:

Tizen.NUI.Components

Assembly:

Tizen.NUI.Components.dll

This class provides a View that can scroll a single View with a layout. This View can be a nest of Views.

public class ScrollableBase : Control, INotifyPropertyChanged, IDisposable

Inheritance

object

BindableObject

Tizen.NUI.Binding.Element

BaseHandle

Animatable

Container

View

ViewWrapper

CustomView

VisualView

Tizen.NUI.Components.Control

ScrollableBase

Derived

RecyclerView

RecyclerView

Implements

System.ComponentModel.INotifyPropertyChanged

System.IDisposable

Constructors

ScrollableBase()

Default Constructor

Declaration

public ScrollableBase()

Properties

Children

List of children of Container.

Declaration

public List<View> Children { get; }

Property Value

Type	Description
System.Collections.Generic.List<T><View>

ContentContainer

Container which has content of ScrollableBase.

Declaration

public View ContentContainer { get; }

Property Value

Type	Description
View

CurrentPage

Get current page. Working property with SnapToPage property.

Declaration

public int CurrentPage { get; }

Property Value

Type	Description
int

DecelerationRate

Deceleration rate of scrolling by finger. Rate should be bigger than 0 and smaller than 1. Default value is 0.998f;

Declaration

public float DecelerationRate { get; set; }

Property Value

Type	Description
float

HideScrollbar

Always hide Scrollbar.

Declaration

public bool HideScrollbar { get; set; }

Property Value

Type	Description
bool

Layout

Set the layout on this View. Replaces any existing Layout.

Declaration

public LayoutItem Layout { get; set; }

Property Value

Type	Description
LayoutItem

PageFlickThreshold

Page will be changed when velocity of panning is over threshold. The unit of threshold is pixel per millisecond.

Declaration

public float PageFlickThreshold { get; set; }

Property Value

Type	Description
float

ScrollAvailableArea

Scroll Available area.

Declaration

public Vector2 ScrollAvailableArea { get; set; }

Property Value

Type	Description
Vector2

Scrollbar

Scrollbar for ScrollableBase.

Declaration

public ScrollbarBase Scrollbar { get; set; }

Property Value

Type	Description
Tizen.NUI.Components.ScrollbarBase

ScrollCurrentPosition

Current scroll position in the middle of ScrollTo animation. This is the position in the opposite direction to the current position of ContentContainer.

Declaration

public Position ScrollCurrentPosition { get; }

Property Value

Type	Description
Position

ScrollDuration

Duration of scroll animation. Default value is 125ms.

Declaration

public int ScrollDuration { get; set; }

Property Value

Type	Description
int

ScrollEnabled

Enable or disable scrolling.

Declaration

public bool ScrollEnabled { get; set; }

Property Value

Type	Description
bool

ScrollingDirection

Scrolling direction mode. Default is Vertical scrolling.

Declaration

public ScrollableBase.Direction ScrollingDirection { get; set; }

Property Value

Type	Description
ScrollableBase.Direction

ScrollPosition

Scroll position given to ScrollTo. This is the position in the opposite direction to the position of ContentContainer.

Declaration

public Position ScrollPosition { get; }

Property Value

Type	Description
Position

SnapToPage

Pages mode, enables moving to the next or return to current page depending on pan displacement. Default is false.

Declaration

public bool SnapToPage { get; set; }

Property Value

Type	Description
bool

Methods

Add(View)

Called after a child has been added to the owning view.

Declaration

public override void Add(View view)

Parameters

Type	Name	Description
View	view	The child which has been added.

Overrides

View.Add(View)

Remove(View)

Called after a child has been removed from the owning view.

Declaration

public override void Remove(View view)

Parameters

Type	Name	Description
View	view	The child which has been removed.

Overrides

View.Remove(View)

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

ScrollToIndex(int)

Scrolls to the item at the specified index.

Declaration

public void ScrollToIndex(int index)

Parameters

Type	Name	Description
int	index	Index of item.

Events

ScrollAnimationEnded

An event emitted when the scrolling slide animation ends, user can subscribe or unsubscribe to this event handler.

Declaration

public event EventHandler<ScrollEventArgs> ScrollAnimationEnded

Event Type

Type	Description
System.EventHandler<TEventArgs><ScrollEventArgs>

ScrollAnimationStarted

An event emitted when the scrolling slide animation starts, user can subscribe or unsubscribe to this event handler.

Declaration

public event EventHandler<ScrollEventArgs> ScrollAnimationStarted

Event Type

Type	Description
System.EventHandler<TEventArgs><ScrollEventArgs>

ScrollDragEnded

An event emitted when user stops dragging ScrollableBase, user can subscribe or unsubscribe to this event handler.

Declaration

public event EventHandler<ScrollEventArgs> ScrollDragEnded

Event Type

Type	Description
System.EventHandler<TEventArgs><ScrollEventArgs>

ScrollDragStarted

An event emitted when user starts dragging ScrollableBase, user can subscribe or unsubscribe to this event handler.

Declaration

public event EventHandler<ScrollEventArgs> ScrollDragStarted

Event Type

Type	Description
System.EventHandler<TEventArgs><ScrollEventArgs>

Scrolling

An event emitted when scrolling, user can subscribe or unsubscribe to this event handler.

Declaration

public event EventHandler<ScrollEventArgs> Scrolling

Event Type

Type	Description
System.EventHandler<TEventArgs><ScrollEventArgs>

Implements

System.ComponentModel.INotifyPropertyChanged

System.IDisposable