Class Scrollbar

Definition

Namespace:

Tizen.NUI.Components

Assembly:

Tizen.NUI.Components.dll

The Scrollbar is a component that contains track and thumb to indicate the current scrolled position of a scrollable object.

public class Scrollbar : ScrollbarBase, IDynamicResourceHandler, INameScope, System.IDisposable, IResourcesProvider

Inheritance

object

BindableObject

Element

BaseHandle

Animatable

Container

View

ViewWrapper

CustomView

VisualView

Control

ScrollbarBase

Scrollbar

Implements

IDynamicResourceHandler

INameScope

System.IDisposable

IResourcesProvider

Constructors

Scrollbar()

Create an empty Scrollbar.

Declaration

public Scrollbar()

Scrollbar(float, float, float, bool)

Create a Scrollbar and initialize with properties.

Declaration

public Scrollbar(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.

Scrollbar(ScrollbarStyle)

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

Declaration

public Scrollbar(ScrollbarStyle style)

Parameters

Type	Name	Description
ScrollbarStyle	style

Fields

ThumbColorProperty

Bindable property of ThumbColor

Declaration

public static readonly BindableProperty ThumbColorProperty

Field Value

Type	Description
BindableProperty

ThumbHorizontalImageUrlProperty

Bindable property of ThumbHorizontalImageUrl

Declaration

public static readonly BindableProperty ThumbHorizontalImageUrlProperty

Field Value

Type	Description
BindableProperty

ThumbThicknessProperty

Bindable property of ThumbThickness

Declaration

public static readonly BindableProperty ThumbThicknessProperty

Field Value

Type	Description
BindableProperty

ThumbVerticalImageUrlProperty

Bindable property of ThumbVerticalImageUrl

Declaration

public static readonly BindableProperty ThumbVerticalImageUrlProperty

Field Value

Type	Description
BindableProperty

TrackColorProperty

Bindable property of TrackColor

Declaration

public static readonly BindableProperty TrackColorProperty

Field Value

Type	Description
BindableProperty

TrackPaddingProperty

Bindable property of TrackPadding

Declaration

public static readonly BindableProperty TrackPaddingProperty

Field Value

Type	Description
BindableProperty

TrackThicknessProperty

Bindable property of TrackThickness

Declaration

public static readonly BindableProperty TrackThicknessProperty

Field Value

Type	Description
BindableProperty

Properties

ScrollCurrentPosition

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

Declaration

public override float ScrollCurrentPosition { get; }

Property Value

Type	Description
float

Overrides

ScrollbarBase.ScrollCurrentPosition

ScrollPosition

Scroll position given to ScrollTo or Update.

Declaration

public override float ScrollPosition { get; }

Property Value

Type	Description
float

Overrides

ScrollbarBase.ScrollPosition

ThumbColor

The color of the thumb part.

Declaration

public Color ThumbColor { get; set; }

Property Value

Type	Description
Color

ThumbHorizontalImageUrl

The image url of the horizontal thumb.

Declaration

public string ThumbHorizontalImageUrl { get; set; }

Property Value

Type	Description
string

ThumbThickness

The thickness of the thumb.

Declaration

public float ThumbThickness { get; set; }

Property Value

Type	Description
float

ThumbVerticalImageUrl

The image url of the vertical thumb.

Declaration

public string ThumbVerticalImageUrl { get; set; }

Property Value

Type	Description
string

TrackColor

The color of the track part.

Declaration

public Color TrackColor { get; set; }

Property Value

Type	Description
Color

TrackPadding

The padding value of the track. Note that when the scrollbar is for vertical direction, Start value is ignored. In case of horizontal direction, Top value is ignored.

Declaration

public Extents TrackPadding { get; set; }

Property Value

Type	Description
Extents

TrackThickness

The thickness of the track.

Declaration

public float TrackThickness { get; set; }

Property Value

Type	Description
float

Methods

ApplyStyle(ViewStyle)

Apply style instance to the view. Basically it sets the bindable property to the value of the bindable property with same name in the style.

Declaration

public override void ApplyStyle(ViewStyle viewStyle)

Parameters

Type	Name	Description
ViewStyle	viewStyle

Overrides

View.ApplyStyle(ViewStyle)

CreateViewStyle()

Declaration

protected override ViewStyle CreateViewStyle()

Returns

Type	Description
ViewStyle

Overrides

Control.CreateViewStyle()

Initialize(float, float, float, bool)

Initialize the scroll bar.

Declaration

public override 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.

Overrides

ScrollbarBase.Initialize(float, float, float, bool)

OnInitialize()

Overrides the parent method. This method is called by the framework when the instance is created.

Declaration

public override void OnInitialize()

Overrides

Control.OnInitialize()

OnRelayout(Vector2, RelayoutContainer)

Called after the size negotiation has been finished for this control.
The control is expected to assign this given size to itself or its children.
Should be overridden by derived classes if they need to layout views differently after certain operations like add or remove views, resize, or after changing specific properties.
As this function is called from inside the size negotiation algorithm, you cannot call RequestRelayout (the call would just be ignored).

Declaration

public override void OnRelayout(Vector2 size, RelayoutContainer container)

Parameters

Type	Name	Description
Vector2	size	The allocated size.
RelayoutContainer	container	The control should add views to this container that it is not able to allocate a size for.

Overrides

Control.OnRelayout(Vector2, RelayoutContainer)

ScrollTo(float, uint, AlphaFunction)

Scroll content to a specific position.

Declaration

public override 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)

Overrides

ScrollbarBase.ScrollTo(float, uint, AlphaFunction)

Remarks

Please note that, for now, only alpha functions created with BuiltinFunctions are valid when animating. Otherwise, it will be treated as a linear alpha function.

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

Update content length and position at once.

Declaration

public override 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)

Overrides

ScrollbarBase.Update(float, float, float, uint, AlphaFunction)

Update(float, float, uint, AlphaFunction)

Update content length and position at once.

Declaration

public override 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)

Overrides

ScrollbarBase.Update(float, float, uint, AlphaFunction)

Implements

IDynamicResourceHandler

INameScope

System.IDisposable

IResourcesProvider

Extension Methods

ViewExtensions.BackgroundColor(View)

ViewExtensions.BorderlineColor(View)

ViewExtensions.BoxShadow(View)

ViewExtensions.Color(View)

ViewExtensions.CornerRadius(View)

EXamlExtensions.LoadFromEXamlByRelativePath<T>(T, string)

ViewExtensions.BackgroundColor<T>(T, float, float, float, float)

ViewExtensions.BackgroundColor<T>(T, uint, float)

ViewExtensions.BackgroundColor<T>(T, UIColor)

ViewExtensions.BackgroundImage<T>(T, string)

ViewExtensions.Borderline<T>(T, float, UIColor, float)

ViewExtensions.BorderlineColor<T>(T, float, float, float, float)

ViewExtensions.BorderlineColor<T>(T, uint, float)

ViewExtensions.BorderlineColor<T>(T, UIColor)

ViewExtensions.BorderlineOffset<T>(T, float)

ViewExtensions.BorderlineWidth<T>(T, float)

ViewExtensions.BoxShadow<T>(T, float, float, float)

ViewExtensions.BoxShadow<T>(T, float, UIColor, float, float)

ViewExtensions.BoxShadow<T>(T, UIShadow)

ViewExtensions.ClippingMode<T>(T, ClippingModeType)

ViewExtensions.Color<T>(T, float, float, float, float)

ViewExtensions.Color<T>(T, uint, float)

ViewExtensions.Color<T>(T, UIColor)

ViewExtensions.CornerRadius<T>(T, float, bool)

ViewExtensions.CornerRadius<T>(T, float, float, float, float, bool)

ViewExtensions.CornerRadius<T>(T, UICorner)

ViewExtensions.Focusable<T>(T, bool)

ViewExtensions.FocusableChildren<T>(T, bool)

ViewExtensions.FocusableInTouch<T>(T, bool)

ViewExtensions.ImageShadow<T>(T, ImageShadow)

ViewExtensions.IsEnabled<T>(T, bool)

ViewExtensions.Layout<T>(T, LayoutItem)

ViewExtensions.Opacity<T>(T, float)

ViewExtensions.Position<T>(T, float, float)

ViewExtensions.PositionX<T>(T, float)

ViewExtensions.PositionY<T>(T, float)

ViewExtensions.Scale<T>(T, float, float)

ViewExtensions.ScaleX<T>(T, float)

ViewExtensions.ScaleY<T>(T, float)

ViewExtensions.Sensitive<T>(T, bool)

ViewExtensions.Size<T>(T, float, float)

ViewExtensions.SizeHeight<T>(T, float)

ViewExtensions.SizeWidth<T>(T, float)

ViewExtensions.Visibility<T>(T, bool)

ViewExtensions.VoiceInteractionName<T>(T, string)

Extensions.LoadFromXaml<TXaml>(TXaml, string)

Extensions.LoadFromXaml<TXaml>(TXaml, Type)

Extensions.LoadFromXamlFile<TXaml>(TXaml, string)