Class ScrollbarBase

View Source

Definition

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

The ScrollbarBase is an abstract class that can be linked to the scrollable objects indicating the current scrolled position of the scrollable object. This only contains non-graphical functionalities of basic scrollbar.


                
C#

                

                    
Copy

                    

                

            
public abstract class ScrollbarBase : Control, IDynamicResourceHandler, IElement, INameScope, IElementController, System.IDisposable, IResourcesProvider
Inheritance
Object
BindableObject
Element
BaseHandle
Animatable
Container
View
ViewWrapper
CustomView
VisualView
Control
ScrollbarBase
Derived
Scrollbar
CircularScrollbar
Implements
IDynamicResourceHandler
INameScope
System.IDisposable
IResourcesProvider

Constructors

View Source

ScrollbarBase()

Create an empty ScrollbarBase.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected ScrollbarBase()
View Source

ScrollbarBase(ControlStyle)

Create an empty Scrollbar with a ViewStyle instance to set style properties.

Declaration

                
C#

                

                    
Copy

                    

                

            
protected ScrollbarBase(ControlStyle style)
Parameters
Type Name Description
ControlStyle style

Properties

View Source

ScrollCurrentPosition

Current scroll position in the middle of ScrollTo or Update animation.

Declaration

                
C#

                

                    
Copy

                    

                

            
public abstract float ScrollCurrentPosition { get; }
Property Value
Type Description
Single
View Source

ScrollPosition

Scroll position given to ScrollTo or Update.

Declaration

                
C#

                

                    
Copy

                    

                

            
public abstract float ScrollPosition { get; }
Property Value
Type Description
Single

Methods

View Source

Initialize(Single, Single, Single, Boolean)

Initialize the scroll bar.

Declaration

                
C#

                

                    
Copy

                    

                

            
public abstract void Initialize(float contentLength, float viewportLength, float currentPosition, bool isHorizontal = false)
Parameters
Type Name Description
Single contentLength

The length of the scrollable content area.
Single viewportLength

The length of the viewport representing the amount of visible content.
Single currentPosition

The current position of the viewport in scrollable content area. This is the viewport's top position if the scroller is vertical, otherwise, left.
Boolean isHorizontal

Whether the direction of scrolling is horizontal or not. It is vertical by default.
View Source

ScrollTo(Single, UInt32, AlphaFunction)

Scroll content to a specific position.

Declaration

                
C#

                

                    
Copy

                    

                

            
public abstract void ScrollTo(float position, uint durationMs = null, AlphaFunction alphaFunction = null)
Parameters
Type Name Description
Single position

The destination to scroll.
UInt32 durationMs

The time it takes to scroll in milliseconds.
AlphaFunction alphaFunction

The timing function used in animation. It describes the rate of change of the animation parameter over time. (e.g. EaseOut)
View Source

Unparent()

Removes a view from its parent ScrollableBase. If a view has no parent, this method does nothing.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Unparent()
View Source

Update(Single, Single, Single, UInt32, AlphaFunction)

Update content length and position at once.

Declaration

                
C#

                

                    
Copy

                    

                

            
public abstract void Update(float contentLength, float viewportLength, float position, uint durationMs = null, AlphaFunction alphaFunction = null)
Parameters
Type Name Description
Single contentLength

The total length of the content.
Single viewportLength

The length of the viewport representing the amount of visible content.
Single position

The destination position of the View in content length. This is the View's top position if the scroller is vertical, otherwise, View's left position.
UInt32 durationMs

The time it takes to scroll in milliseconds.
AlphaFunction alphaFunction

The timing function used in animation. It describes the rate of change of the animation parameter over time. (e.g. EaseOut)
View Source

Update(Single, Single, UInt32, AlphaFunction)

Update content length and position at once.

Declaration

                
C#

                

                    
Copy

                    

                

            
public abstract void Update(float contentLength, float position, uint durationMs = null, AlphaFunction alphaFunction = null)
Parameters
Type Name Description
Single contentLength

The total length of the content.
Single position

The destination position of the View in content length. This is the View's top position if the scroller is vertical, otherwise, View's left position.
UInt32 durationMs

The time it takes to scroll in milliseconds.
AlphaFunction alphaFunction

The timing function used in animation. It describes the rate of change of the animation parameter over time. (e.g. EaseOut)

Implements

Extension Methods