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
-
- Implements
-
System.IDisposable
Constructors
View Source
Create an empty Scrollbar.
Declaration
View Source
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.
|
View Source
Create an empty Scrollbar with a ScrollbarStyle instance to set style properties.
Declaration
public Scrollbar(ScrollbarStyle style)
Parameters
Fields
View Source
Bindable property of ThumbColor
Declaration
public static readonly BindableProperty ThumbColorProperty
Field Value
View Source
Bindable property of ThumbHorizontalImageUrl
Declaration
public static readonly BindableProperty ThumbHorizontalImageUrlProperty
Field Value
View Source
Bindable property of ThumbThickness
Declaration
public static readonly BindableProperty ThumbThicknessProperty
Field Value
View Source
Bindable property of ThumbVerticalImageUrl
Declaration
public static readonly BindableProperty ThumbVerticalImageUrlProperty
Field Value
View Source
Bindable property of TrackColor
Declaration
public static readonly BindableProperty TrackColorProperty
Field Value
View Source
Bindable property of TrackPadding
Declaration
public static readonly BindableProperty TrackPaddingProperty
Field Value
View Source
Bindable property of TrackThickness
Declaration
public static readonly BindableProperty TrackThicknessProperty
Field Value
Properties
View Source
Declaration
public override float ScrollCurrentPosition { get; }
Property Value
Overrides
View Source
Declaration
public override float ScrollPosition { get; }
Property Value
Overrides
View Source
The color of the thumb part.
Declaration
public Color ThumbColor { get; set; }
Property Value
View Source
The image url of the horizontal thumb.
Declaration
public string ThumbHorizontalImageUrl { get; set; }
Property Value
View Source
The thickness of the thumb.
Declaration
public float ThumbThickness { get; set; }
Property Value
View Source
The image url of the vertical thumb.
Declaration
public string ThumbVerticalImageUrl { get; set; }
Property Value
View Source
The color of the track part.
Declaration
public Color TrackColor { get; set; }
Property Value
View Source
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
View Source
The thickness of the track.
Declaration
public float TrackThickness { get; set; }
Property Value
Methods
View Source
Declaration
public override void ApplyStyle(ViewStyle viewStyle)
Parameters
Overrides
View Source
Declaration
protected override ViewStyle CreateViewStyle()
Returns
Overrides
View Source
Declaration
public override void Initialize(float contentLength, float viewportLength, float currentPosition, bool isHorizontal = false)
Parameters
Type |
Name |
Description |
float |
contentLength |
|
float |
viewportLength |
|
float |
currentPosition |
|
bool |
isHorizontal |
|
Overrides
View Source
Declaration
public override void OnInitialize()
Overrides
View Source
Declaration
public override void OnRelayout(Vector2 size, RelayoutContainer container)
Parameters
Overrides
View Source
Declaration
public override void ScrollTo(float position, uint durationMs = null, AlphaFunction alphaFunction = null)
Parameters
Type |
Name |
Description |
float |
position |
|
uint |
durationMs |
|
AlphaFunction |
alphaFunction |
|
Overrides
View Source
Declaration
public override void Update(float contentLength, float viewportLength, float position, uint durationMs = null, AlphaFunction alphaFunction = null)
Parameters
Type |
Name |
Description |
float |
contentLength |
|
float |
viewportLength |
|
float |
position |
|
uint |
durationMs |
|
AlphaFunction |
alphaFunction |
|
Overrides
View Source
Declaration
public override void Update(float contentLength, float position, uint durationMs = null, AlphaFunction alphaFunction = null)
Parameters
Type |
Name |
Description |
float |
contentLength |
|
float |
position |
|
uint |
durationMs |
|
AlphaFunction |
alphaFunction |
|
Overrides
Implements
System.IDisposable
Extension Methods