Class Slider
Definition
- Namespace:
- Tizen.NUI.Components
- Assembly:
- Tizen.NUI.Components.dll
A slider lets users select a value from a continuous or discrete range of values by moving the slider thumb.
public class Slider : Control, INotifyPropertyChanged, IDisposable
- Inheritance
-
objectTizen.NUI.Binding.BindableObjectTizen.NUI.Binding.ElementTizen.NUI.Components.ControlSlider
- Implements
-
System.ComponentModel.INotifyPropertyChangedSystem.IDisposable
Constructors
View SourceSlider()
The constructor of the Slider class.
Declaration
public Slider()
Slider(string)
The constructor of the Slider class with specific style.
Declaration
public Slider(string style)
Parameters
| Type | Name | Description |
|---|---|---|
| string | style | The string to initialize the Slider |
Slider(SliderStyle)
The constructor of the Slider class with specific style.
Declaration
public Slider(SliderStyle sliderStyle)
Parameters
| Type | Name | Description |
|---|---|---|
| SliderStyle | sliderStyle | The style object to initialize the Slider |
Properties
View SourceBgTrackColor
Gets or sets the color of the background track image object.
Declaration
public Color BgTrackColor { get; set; }
Property Value
| Type | Description |
|---|---|
| Color |
CurrentValue
Gets or sets the current value of slider.
Declaration
public float CurrentValue { get; set; }
Property Value
| Type | Description |
|---|---|
| float |
Direction
Gets or sets the direction type of slider.
Declaration
public Slider.DirectionType Direction { get; set; }
Property Value
| Type | Description |
|---|---|
| Slider.DirectionType |
DiscreteValue
Gets or sets the discrete value of slider.
Declaration
public float DiscreteValue { get; set; }
Property Value
| Type | Description |
|---|---|
| float |
Remarks
The discrete value is evenly spaced between MinValue and MaxValue. For example, MinValue is 0, MaxValue is 100, and DiscreteValue is 20. Then, the thumb can only go to 0, 20, 40, 60, 80, and 100. The default is 0.
HighIndicatorImageURL
Gets or sets the resource url of the high indicator image object.
Declaration
public string HighIndicatorImageURL { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
HighIndicatorSize
Gets or sets the size of the high indicator object(image or text).
Declaration
public Size HighIndicatorSize { get; set; }
Property Value
| Type | Description |
|---|---|
| Size |
HighIndicatorTextContent
Gets or sets the text content of the high indicator text object.
Declaration
public string HighIndicatorTextContent { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Indicator
Gets or sets the indicator type, arrow or sign.
Declaration
public Slider.IndicatorType Indicator { get; set; }
Property Value
| Type | Description |
|---|---|
| Slider.IndicatorType |
IsDiscrete
Flag to decide whether the thumb snaps to the nearest discrete value when the user drags the thumb or taps.
The default value is false.
Declaration
public bool IsDiscrete { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
IsValueShown
Flag to decide whether the value indicator is shown
Declaration
public bool IsValueShown { get; set; }
Property Value
| Type | Description |
|---|---|
| bool |
LowIndicatorImageURL
Gets or sets the resource url of the low indicator image object.
Declaration
public string LowIndicatorImageURL { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
LowIndicatorSize
Gets or sets the size of the low indicator object(image or text).
Declaration
public Size LowIndicatorSize { get; set; }
Property Value
| Type | Description |
|---|---|
| Size |
LowIndicatorTextContent
Gets or sets the text content of the low indicator text object.
Declaration
public string LowIndicatorTextContent { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
MaxValue
Gets or sets the maximum value of slider.
Declaration
public float MaxValue { get; set; }
Property Value
| Type | Description |
|---|---|
| float |
MinValue
Gets or sets the minimum value of slider.
Declaration
public float MinValue { get; set; }
Property Value
| Type | Description |
|---|---|
| float |
SlidedTrackColor
Gets or sets the color of the slided track image object.
Declaration
public Color SlidedTrackColor { get; set; }
Property Value
| Type | Description |
|---|---|
| Color |
SpaceBetweenTrackAndIndicator
Gets or sets the value of the space between track and indicator.
Declaration
public uint SpaceBetweenTrackAndIndicator { get; set; }
Property Value
| Type | Description |
|---|---|
| uint |
Style
Return currently applied style.
Declaration
public SliderStyle Style { get; }
Property Value
| Type | Description |
|---|---|
| SliderStyle |
Remarks
Modifying contents in style may cause unexpected behaviour.
ThumbColor
Gets or sets the color of the thumb image object.
Declaration
public Color ThumbColor { get; set; }
Property Value
| Type | Description |
|---|---|
| Color |
ThumbImageUrl
Gets or sets the Url of the thumb image.
Declaration
public Selector<string> ThumbImageUrl { get; set; }
Property Value
| Type | Description |
|---|---|
| Selector<string> |
Exceptions
| Type | Condition |
|---|---|
| System.NullReferenceException | Thrown when setting null value. |
ThumbImageURL
Gets or sets the resource url of the thumb image object.
Please use ThumbImageUrl property.
Declaration
public string ThumbImageURL { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
ThumbImageURLSelector
Gets or sets the resource url selector of the thumb image object. Getter returns copied selector value if exist, null otherwise.
Please use ThumbImageUrl property.
Declaration
public StringSelector ThumbImageURLSelector { get; set; }
Property Value
| Type | Description |
|---|---|
| Tizen.NUI.Components.StringSelector |
Exceptions
| Type | Condition |
|---|---|
| System.NullReferenceException | Thrown when setting null value. |
ThumbSize
Gets or sets the size of the thumb image object.
Declaration
public Size ThumbSize { get; set; }
Property Value
| Type | Description |
|---|---|
| Size |
TrackThickness
Gets or sets the thickness value of the track.
Declaration
public uint TrackThickness { get; set; }
Property Value
| Type | Description |
|---|---|
| uint |
ValueIndicatorSize
Gets or sets the size of the value indicator image object.
Declaration
public Size ValueIndicatorSize { get; set; }
Property Value
| Type | Description |
|---|---|
| Size |
ValueIndicatorText
Gets or sets the text of value indicator.
Declaration
public string ValueIndicatorText { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
ValueIndicatorUrl
Gets or sets the resource url of the value indicator image object.
Declaration
public string ValueIndicatorUrl { get; set; }
Property Value
| Type | Description |
|---|---|
| string |
Methods
View SourceApplyStyle(ViewStyle)
Apply style to scrollbar.
Declaration
public override void ApplyStyle(ViewStyle viewStyle)
Parameters
| Type | Name | Description |
|---|---|---|
| ViewStyle | viewStyle | The style to apply. |
Overrides
View SourceCreateViewStyle()
Get Slider style.
Declaration
protected override ViewStyle CreateViewStyle()
Returns
| Type | Description |
|---|---|
| ViewStyle | The default slider style. |
Overrides
Dispose(DisposeTypes)
Dispose Slider.
Declaration
protected override void Dispose(DisposeTypes type)
Parameters
| Type | Name | Description |
|---|---|---|
| DisposeTypes | type | Dispose type. |
Overrides
OnFocusGained()
Focus gained callback.
Declaration
public override void OnFocusGained()
Overrides
OnFocusLost()
Focus Lost callback.
Declaration
public override void OnFocusLost()
Overrides
Events
View SourceSlidingFinished
The sliding finished event handler.
Declaration
public event EventHandler<SliderSlidingFinishedEventArgs> SlidingFinished
Event Type
| Type | Description |
|---|---|
| System.EventHandler<TEventArgs><SliderSlidingFinishedEventArgs> |
SlidingStarted
The sliding started event handler.
Declaration
public event EventHandler<SliderSlidingStartedEventArgs> SlidingStarted
Event Type
| Type | Description |
|---|---|
| System.EventHandler<TEventArgs><SliderSlidingStartedEventArgs> |
ValueChanged
The value changed event handler.
Declaration
public event EventHandler<SliderValueChangedEventArgs> ValueChanged
Event Type
| Type | Description |
|---|---|
| System.EventHandler<TEventArgs><SliderValueChangedEventArgs> |