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
Tizen.NUI.Binding.Element
Tizen.NUI.Components.Control
ScrollableBase
- Derived
-
- Implements
-
System.ComponentModel.INotifyPropertyChanged
System.IDisposable
Constructors
Declaration
Properties
Declaration
public List<View> Children { get; }
Property Value
| Type |
Description |
| System.Collections.Generic.List<T><View> |
|
View Source
ContentContainer
Container which has content of ScrollableBase.
Declaration
public View ContentContainer { get; }
Property Value
View Source
CurrentPage
Get current page.
Working property with SnapToPage property.
Declaration
public int CurrentPage { get; }
Property Value
View Source
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
Declaration
public bool HideScrollbar { get; set; }
Property Value
View Source
Set the layout on this View. Replaces any existing Layout.
Declaration
public LayoutItem Layout { get; set; }
Property Value
View Source
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
Declaration
public Vector2 ScrollAvailableArea { get; set; }
Property Value
Declaration
public ScrollbarBase Scrollbar { get; set; }
Property Value
| Type |
Description |
| Tizen.NUI.Components.ScrollbarBase |
|
View Source
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
View Source
Duration of scroll animation.
Default value is 125ms.
Declaration
public int ScrollDuration { get; set; }
Property Value
Declaration
public bool ScrollEnabled { get; set; }
Property Value
View Source
Scrolling direction mode.
Default is Vertical scrolling.
Declaration
public ScrollableBase.Direction ScrollingDirection { get; set; }
Property Value
View Source
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
View Source
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
Methods
View Source
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 Source
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 Source
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
Scrolls to the item at the specified index.
Declaration
public void ScrollToIndex(int index)
Parameters
| Type |
Name |
Description |
| int |
index |
Index of item.
|
Events
View Source
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
View Source
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
View Source
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
View Source
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
View Source
An event emitted when scrolling, user can subscribe or unsubscribe to this event handler.
Declaration
public event EventHandler<ScrollEventArgs> Scrolling
Event Type
Implements
System.ComponentModel.INotifyPropertyChanged
System.IDisposable