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
-
objectScrollBar
- Implements
-
System.IDisposable
Remarks
Please note that this class will be replaced with Scrollbar class in the near future.
Constructors
View SourceScrollBar()
The constructor of ScrollBar.
Declaration
public ScrollBar()
Remarks
Please note that this class will be replaced with Scrollbar class in the near future.
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.
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 SourceCurrentValueProperty
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.
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.
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.
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.
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.
ThumbColorProperty
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.
ThumbSizeProperty
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.
TrackColorProperty
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.
TrackImageURLProperty
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 SourceCurrentValue
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.
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.
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.
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.
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.
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.
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 SourceApplyStyle(ViewStyle)
Declaration
public override void ApplyStyle(ViewStyle style)
Parameters
Type | Name | Description |
---|---|---|
ViewStyle | style |
Overrides
Remarks
Please note that this class will be replaced with Scrollbar class in the near future.
CreateViewStyle()
Get Scrollbar style.
Declaration
protected override ViewStyle CreateViewStyle()
Returns
Type | Description |
---|---|
ViewStyle | The default scrollbar style. |
Overrides
Remarks
Please note that this class will be replaced with Scrollbar class in the near future.
Dispose(DisposeTypes)
Dispose ScrollBar.
Declaration
protected override void Dispose(DisposeTypes type)
Parameters
Type | Name | Description |
---|---|---|
DisposeTypes | type | The DisposeTypes value. |
Overrides
Remarks
Please note that this class will be replaced with Scrollbar class in the near future.
OnInitialize()
Declaration
public override void OnInitialize()
Overrides
Remarks
Please note that this class will be replaced with Scrollbar class in the near future.
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);
}