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.


                C#
                
                    Copy
                    
                
            
[Obsolete("Deprecated in API8; Will be removed in API10")]
public class ScrollBar : Control, INotifyPropertyChanged, IDisposable

Inheritance: object

BindableObject

Tizen.NUI.Binding.Element

BaseHandle

Animatable

Container

View

ViewWrapper

CustomView

VisualView

Tizen.NUI.Components.Control

ScrollBar

Implements: System.ComponentModel.INotifyPropertyChanged

System.IDisposable

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


                C#
                
                    Copy
                    
                
            
[Obsolete("Deprecated in API8; Will be removed in API10")]
public ScrollBar()

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


                C#
                
                    Copy
                    
                
            
[Obsolete("Deprecated in API8; Will be removed in API10")]
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


                
                
                    Copy
                    
                
            
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);
}

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	Throw when Current value is less than Min value, or greater than Max value.

View Source

Direction

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

Declaration


                C#
                
                    Copy
                    
                
            
[Obsolete("Deprecated in API8; Will be removed in API10")]
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


                C#
                
                    Copy
                    
                
            
[Obsolete("Deprecated in API8; Will be removed in API10")]
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


                C#
                
                    Copy
                    
                
            
[Obsolete("Deprecated in API8; Will be removed in API10")]
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


                C#
                
                    Copy
                    
                
            
[Obsolete("Deprecated in API8; Will be removed in API10")]
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


                C#
                
                    Copy
                    
                
            
[Obsolete("Deprecated in API8; Will be removed in API10")]
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


                C#
                
                    Copy
                    
                
            
[Obsolete("Deprecated in API8; Will be removed in API10")]
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


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

Exceptions

Type	Condition
System.InvalidOperationException	Throw when ThumbSize is null.

View Source

TrackColor

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

Declaration


                C#
                
                    Copy
                    
                
            
[Obsolete("Deprecated in API8; Will be removed in API10")]
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


                C#
                
                    Copy
                    
                
            
[Obsolete("Deprecated in API8; Will be removed in API10")]
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

Dispose(DisposeTypes)

Dispose ScrollBar.

Declaration


                C#
                
                    Copy
                    
                
            
[Obsolete("Deprecated in API8; Will be removed in API10")]
protected override void Dispose(DisposeTypes type)

Parameters

Type	Name	Description
DisposeTypes	type	The DisposeTypes value.

Overrides

Tizen.NUI.Components.Control.Dispose(Tizen.NUI.DisposeTypes)

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


                C#
                
                    Copy
                    
                
            
[Obsolete("Deprecated in API8; Will be removed in API10")]
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


                
                
                    Copy
                    
                
            
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);
}

Exceptions

Type	Condition
System.ArgumentOutOfRangeException	Throw when current size is less than the min value, or greater than the max value.

Implements

System.ComponentModel.INotifyPropertyChanged

System.IDisposable