Class ScrollableBase

Definition

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

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

C#
Copy
public class ScrollableBase : Control, INotifyPropertyChanged, IDynamicResourceHandler, IElement, INameScope, IElementController, IDisposable, IResourcesProvider
Inheritance
Tizen.NUI.Binding.Element
Tizen.NUI.Components.Control
ScrollableBase
Derived
Implements

Constructors

View Source

ScrollableBase()

Default Constructor

Declaration
C#
Copy
public ScrollableBase()
API Level: 8

Properties

View Source

Children

List of children of Container.

Declaration
C#
Copy
public List<View> Children { get; }
Property Value
Type Description
List<View>
API Level: 8
View Source

ContentContainer

Container which has content of ScrollableBase.

Declaration
C#
Copy
public View ContentContainer { get; }
Property Value
Type Description
View
API Level: 8
View Source

CurrentPage

Get current page. Working property with SnapToPage property.

Declaration
C#
Copy
public int CurrentPage { get; }
Property Value
Type Description
Int32
API Level: 8
View Source

DecelerationRate

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

Declaration
C#
Copy
public float DecelerationRate { get; set; }
Property Value
Type Description
Single
API Level: 8
View Source

HideScrollbar

Always hide Scrollbar.

Declaration
C#
Copy
public bool HideScrollbar { get; set; }
Property Value
Type Description
Boolean
API Level: 8
View Source

Layout

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

Declaration
C#
Copy
public LayoutItem Layout { get; set; }
Property Value
Type Description
LayoutItem
API Level: 8
View Source

PageFlickThreshold

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

Declaration
C#
Copy
public float PageFlickThreshold { get; set; }
Property Value
Type Description
Single
API Level: 8
View Source

ScrollAvailableArea

Scroll Available area.

Declaration
C#
Copy
public Vector2 ScrollAvailableArea { get; set; }
Property Value
Type Description
Vector2
API Level: 8
View Source

Scrollbar

Scrollbar for ScrollableBase.

Declaration
C#
Copy
public ScrollbarBase Scrollbar { get; set; }
Property Value
Type Description
Tizen.NUI.Components.ScrollbarBase
API Level: 8
View Source

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
C#
Copy
public Position ScrollCurrentPosition { get; }
Property Value
Type Description
Position
API Level: 8
View Source

ScrollDuration

Duration of scroll animation. Default value is 125ms.

Declaration
C#
Copy
public int ScrollDuration { get; set; }
Property Value
Type Description
Int32
API Level: 8
View Source

ScrollEnabled

Enable or disable scrolling.

Declaration
C#
Copy
public bool ScrollEnabled { get; set; }
Property Value
Type Description
Boolean
API Level: 8
View Source

ScrollingDirection

Scrolling direction mode. Default is Vertical scrolling.

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

ScrollPosition

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

Declaration
C#
Copy
public Position ScrollPosition { get; }
Property Value
Type Description
Position
API Level: 8
View Source

SnapToPage

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

Declaration
C#
Copy
public bool SnapToPage { get; set; }
Property Value
Type Description
Boolean
API Level: 8

Methods

View Source

Add(View)

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

Declaration
C#
Copy
public override void Add(View view)
Parameters
Type Name Description
View view

The child which has been added.

Overrides
API Level: 8
View Source

Remove(View)

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

Declaration
C#
Copy
public override void Remove(View view)
Parameters
Type Name Description
View view

The child which has been removed.

Overrides
API Level: 8
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
Single position

Destination.

Boolean animate

Scroll with or without animation

API Level: 8
View Source

ScrollToIndex(Int32)

Scrolls to the item at the specified index.

Declaration
C#
Copy
public void ScrollToIndex(int index)
Parameters
Type Name Description
Int32 index

Index of item.

API Level: 8

Events

View Source

ScrollAnimationEnded

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

Declaration
C#
Copy
public event EventHandler<ScrollEventArgs> ScrollAnimationEnded
Event Type
Type Description
EventHandler<ScrollEventArgs>
API Level: 8
View Source

ScrollAnimationStarted

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

Declaration
C#
Copy
public event EventHandler<ScrollEventArgs> ScrollAnimationStarted
Event Type
Type Description
EventHandler<ScrollEventArgs>
API Level: 8
View Source

ScrollDragEnded

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

Declaration
C#
Copy
public event EventHandler<ScrollEventArgs> ScrollDragEnded
Event Type
Type Description
EventHandler<ScrollEventArgs>
API Level: 8
View Source

ScrollDragStarted

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

Declaration
C#
Copy
public event EventHandler<ScrollEventArgs> ScrollDragStarted
Event Type
Type Description
EventHandler<ScrollEventArgs>
API Level: 8
View Source

Scrolling

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

Declaration
C#
Copy
public event EventHandler<ScrollEventArgs> Scrolling
Event Type
Type Description
EventHandler<ScrollEventArgs>
API Level: 8

Implements