Class ScrollBar

Definition

Namespace:: Tizen.NUI.Components

Assembly:: Tizen.NUI.Components.dll

The ScrollBar class of nui component. It allows users to recognize the direction and the range of lists/content.

public class ScrollBar : Control, IDynamicResourceHandler, INameScope, System.IDisposable, IResourcesProvider

Inheritance: object

BindableObject

Element

BaseHandle

Animatable

Container

View

ViewWrapper

CustomView

VisualView

Control

ScrollBar

Implements: IDynamicResourceHandler

INameScope

System.IDisposable

IResourcesProvider

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

Constructors

View Source

ScrollBar()

The constructor of ScrollBar.

Declaration

public ScrollBar()

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

View Source

ScrollBar(string)

The constructor of ScrollBar with specific style.

Declaration

public ScrollBar(string style)

Parameters

Type	Name	Description
string	style	style name

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

View Source

ScrollBar(ScrollBarStyle)

The constructor of ScrollBar with specific style.

Declaration

public ScrollBar(ScrollBarStyle scrollBarStyle)

Parameters

Type	Name	Description
ScrollBarStyle	scrollBarStyle	The style object to initialize the ScrollBar.

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

Fields

View Source

CurrentValueProperty

Declaration

public static readonly BindableProperty CurrentValueProperty

Field Value

Type	Description
BindableProperty

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

View Source

DirectionProperty

Declaration

public static readonly BindableProperty DirectionProperty

Field Value

Type	Description
BindableProperty

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

View Source

DurationProperty

Declaration

public static readonly BindableProperty DurationProperty

Field Value

Type	Description
BindableProperty

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

View Source

MaxValueProperty

Declaration

public static readonly BindableProperty MaxValueProperty

Field Value

Type	Description
BindableProperty

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

View Source

MinValueProperty

Declaration

public static readonly BindableProperty MinValueProperty

Field Value

Type	Description
BindableProperty

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

View Source

ThumbColorProperty

Declaration

public static readonly BindableProperty ThumbColorProperty

Field Value

Type	Description
BindableProperty

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

View Source

ThumbSizeProperty

Declaration

public static readonly BindableProperty ThumbSizeProperty

Field Value

Type	Description
BindableProperty

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

View Source

TrackColorProperty

Declaration

public static readonly BindableProperty TrackColorProperty

Field Value

Type	Description
BindableProperty

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

View Source

TrackImageURLProperty

Declaration

public static readonly BindableProperty TrackImageURLProperty

Field Value

Type	Description
BindableProperty

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

Properties

View Source

CurrentValue

The property to get/set the current value of the ScrollBar.

Declaration

public int CurrentValue { get; set; }

Property Value

Type	Description
int

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

Examples

ScrollBar scroll;
scroll.MaxValue = 100;
scroll.MinValue = 0;
try
{
    scroll.CurrentValue = 50;
}
catch(ArgumentOutOfRangeException e)
{
    Tizen.Log.Error(LogTag, "Failed to set Current value : " + e.Message);
}

View Source

Direction

The property to get/set the direction of the ScrollBar.

Declaration

public ScrollBar.DirectionType Direction { get; set; }

Property Value

Type	Description
ScrollBar.DirectionType

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

View Source

Duration

Property to set/get animation duration.

Declaration

public uint Duration { get; set; }

Property Value

Type	Description
uint

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

View Source

MaxValue

The property to get/set the max value of the ScrollBar.

Declaration

public int MaxValue { get; set; }

Property Value

Type	Description
int

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

View Source

MinValue

The property to get/set the min value of the ScrollBar.

Declaration

public int MinValue { get; set; }

Property Value

Type	Description
int

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

View Source

ThumbColor

The property to get/set the color of the thumb object.

Declaration

public Color ThumbColor { get; set; }

Property Value

Type	Description
Color

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

View Source

ThumbSize

The property to get/set the size of the thumb object.

Declaration

public Size ThumbSize { get; set; }

Property Value

Type	Description
Size

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

Examples

ScrollBar scroll;
try
{
    scroll.ThumbSize = new Size(500, 10, 0);
}
catch(InvalidOperationException e)
{
    Tizen.Log.Error(LogTag, "Failed to set ThumbSize value : " + e.Message);
}

View Source

TrackColor

The property to get/set the color of the track object.

Declaration

public Color TrackColor { get; set; }

Property Value

Type	Description
Color

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

View Source

TrackImageURL

The property to get/set the image URL of the track object.

Declaration

public string TrackImageURL { get; set; }

Property Value

Type	Description
string

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

Methods

View Source

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 style)

Parameters

Type	Name	Description
ViewStyle	style

Overrides

View.ApplyStyle(ViewStyle)

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

View Source

CreateViewStyle()

Get Scrollbar style.

Declaration

protected override ViewStyle CreateViewStyle()

Returns

Type	Description
ViewStyle	The default scrollbar style.

Overrides

Control.CreateViewStyle()

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

View Source

Dispose(DisposeTypes)

Dispose ScrollBar.

Declaration

protected override void Dispose(DisposeTypes type)

Parameters

Type	Name	Description
DisposeTypes	type	The DisposeTypes value.

Overrides

Control.Dispose(DisposeTypes)

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

View Source

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()

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

View Source

SetCurrentValue(int, bool)

Method to set current value. The thumb object would move to the corresponding position with animation or not.

Declaration

public void SetCurrentValue(int currentValue, bool enableAnimation = true)

Parameters

Type	Name	Description
int	currentValue	The special current value.
bool	enableAnimation	Enable move with animation or not, the default value is true.

Remarks

Please note that this class will be replaced with Scrollbar class in the near future.

Examples

ScrollBar scroll;
scroll.MinValue = 0;
scroll.MaxValue = 100;
try
{
    scroll.SetCurrentValue(50);
}
catch(ArgumentOutOfRangeException e)
{
    Tizen.Log.Error(LogTag, "Failed to set current value : " + e.Message);
}