Class ScrollbarBase

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.

public abstract class ScrollbarBase : Control, IDynamicResourceHandler, INameScope, System.IDisposable, IResourcesProvider

Inheritance: object

BindableObject

Element

BaseHandle

Animatable

Container

View

ViewWrapper

CustomView

VisualView

Control

ScrollbarBase

Derived: Scrollbar

Scrollbar

CircularScrollbar

CircularScrollbar

Implements: IDynamicResourceHandler

INameScope

System.IDisposable

IResourcesProvider

Constructors

View Source

ScrollbarBase()

Create an empty ScrollbarBase.

Declaration

protected ScrollbarBase()

View Source

ScrollbarBase(ControlStyle)

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

Declaration

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

public abstract float ScrollCurrentPosition { get; }

Property Value

Type	Description
float

View Source

ScrollPosition

Scroll position given to ScrollTo or Update.

Declaration

public abstract float ScrollPosition { get; }

Property Value

Type	Description
float

Methods

View Source

Initialize(float, float, float, bool)

Initialize the scroll bar.

Declaration

public abstract void Initialize(float contentLength, float viewportLength, float currentPosition, bool isHorizontal = false)

Parameters

Type	Name	Description
float	contentLength	The length of the scrollable content area.
float	viewportLength	The length of the viewport representing the amount of visible content.
float	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.
bool	isHorizontal	Whether the direction of scrolling is horizontal or not. It is vertical by default.

View Source

ScrollTo(float, uint, AlphaFunction)

Scroll content to a specific position.

Declaration

public abstract void ScrollTo(float position, uint durationMs = null, AlphaFunction alphaFunction = null)

Parameters

Type	Name	Description
float	position	The destination to scroll.
uint	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

public void Unparent()

View Source

Update(float, float, float, uint, AlphaFunction)

Update content length and position at once.

Declaration

public abstract void Update(float contentLength, float viewportLength, float position, uint durationMs = null, AlphaFunction alphaFunction = null)

Parameters

Type	Name	Description
float	contentLength	The total length of the content.
float	viewportLength	The length of the viewport representing the amount of visible content.
float	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.
uint	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(float, float, uint, AlphaFunction)

Update content length and position at once.

Declaration

public abstract void Update(float contentLength, float position, uint durationMs = null, AlphaFunction alphaFunction = null)

Parameters

Type	Name	Description
float	contentLength	The total length of the content.
float	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.
uint	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)