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, IDynamicResourceHandler, INameScope, System.IDisposable, IResourcesProvider, IAtspiValue
- Inheritance
-
objectSlider
- Implements
-
System.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 |
Fields
View SourceBgTrackColorProperty
BgTrackColorProperty
Declaration
public static readonly BindableProperty BgTrackColorProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
CurrentValueProperty
Bindable property of CurrentValue
Declaration
public static readonly BindableProperty CurrentValueProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
DirectionProperty
DirectionProperty
Declaration
public static readonly BindableProperty DirectionProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
DiscreteValueProperty
DiscreteValueProperty
Declaration
public static readonly BindableProperty DiscreteValueProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
HighIndicatorImageURLProperty
HighIndicatorImageURLProperty
Declaration
public static readonly BindableProperty HighIndicatorImageURLProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
HighIndicatorSizeProperty
HighIndicatorSizeProperty
Declaration
public static readonly BindableProperty HighIndicatorSizeProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
HighIndicatorTextContentProperty
HighIndicatorTextContentProperty
Declaration
public static readonly BindableProperty HighIndicatorTextContentProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
IndicatorProperty
SpaceBetweenTrackAndIndicatorProperty
Declaration
public static readonly BindableProperty IndicatorProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
IsDiscreteProperty
IsDiscreteProperty
Declaration
public static readonly BindableProperty IsDiscreteProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
IsValueShownProperty
IsValueShownProperty
Declaration
public static readonly BindableProperty IsValueShownProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
LowIndicatorImageURLProperty
LowIndicatorImageURLProperty
Declaration
public static readonly BindableProperty LowIndicatorImageURLProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
LowIndicatorSizeProperty
LowIndicatorSizeProperty
Declaration
public static readonly BindableProperty LowIndicatorSizeProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
LowIndicatorTextContentProperty
LowIndicatorTextContentProperty
Declaration
public static readonly BindableProperty LowIndicatorTextContentProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
MaxValueProperty
MaxValueProperty
Declaration
public static readonly BindableProperty MaxValueProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
MinValueProperty
MinValueProperty
Declaration
public static readonly BindableProperty MinValueProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
SlidedTrackColorProperty
SlidedTrackColorProperty
Declaration
public static readonly BindableProperty SlidedTrackColorProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
SpaceBetweenTrackAndIndicatorProperty
SpaceBetweenTrackAndIndicatorProperty
Declaration
public static readonly BindableProperty SpaceBetweenTrackAndIndicatorProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
ThumbColorProperty
ThumbColorProperty
Declaration
public static readonly BindableProperty ThumbColorProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
ThumbImageUrlProperty
ThumbImageUrlProperty
Declaration
public static readonly BindableProperty ThumbImageUrlProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
ThumbImageURLProperty
ThumbImageURLProperty
Declaration
public static readonly BindableProperty ThumbImageURLProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
ThumbImageURLSelectorProperty
ThumbImageURLSelectorProperty
Declaration
public static readonly BindableProperty ThumbImageURLSelectorProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
ThumbSizeProperty
ThumbSizeProperty
Declaration
public static readonly BindableProperty ThumbSizeProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
TrackThicknessProperty
TrackThicknessProperty
Declaration
public static readonly BindableProperty TrackThicknessProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
ValueIndicatorSizeProperty
ValueIndicatorSizeProperty
Declaration
public static readonly BindableProperty ValueIndicatorSizeProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
ValueIndicatorTextProperty
ValueIndicatorTextProperty
Declaration
public static readonly BindableProperty ValueIndicatorTextProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
ValueIndicatorUrlProperty
ValueIndicatorUrlProperty
Declaration
public static readonly BindableProperty ValueIndicatorUrlProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
WarningSlidedTrackColorProperty
WarningSlidedTrackColorProperty
Declaration
public static readonly BindableProperty WarningSlidedTrackColorProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
WarningStartValueProperty
WarningStartValueProperty
Declaration
public static readonly BindableProperty WarningStartValueProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
WarningThumbColorProperty
WarningThumbColorProperty
Declaration
public static readonly BindableProperty WarningThumbColorProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
WarningThumbImageUrlProperty
WarningThumbImageUrlProperty
Declaration
public static readonly BindableProperty WarningThumbImageUrlProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
WarningTrackColorProperty
WarningTrackColorProperty
Declaration
public static readonly BindableProperty WarningTrackColorProperty
Field Value
| Type | Description |
|---|---|
| BindableProperty |
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> |
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 |
|---|---|
| StringSelector |
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 |
WarningSlidedTrackColor
Gets or sets the color of the warning slided track image object.
Declaration
public Color WarningSlidedTrackColor { get; set; }
Property Value
| Type | Description |
|---|---|
| Color |
WarningStartValue
Gets or sets the warning start value between minimum value and maximum value of slider.
Declaration
public float WarningStartValue { get; set; }
Property Value
| Type | Description |
|---|---|
| float |
WarningThumbColor
Gets or sets the color of the warning thumb image object.
Declaration
public Color WarningThumbColor { get; set; }
Property Value
| Type | Description |
|---|---|
| Color |
WarningThumbImageUrl
Gets or sets the Url of the warning thumb image.
Declaration
public Selector<string> WarningThumbImageUrl { get; set; }
Property Value
| Type | Description |
|---|---|
| Selector<string> |
WarningTrackColor
Gets or sets the color of the warning track image object.
Declaration
public Color WarningTrackColor { get; set; }
Property Value
| Type | Description |
|---|---|
| Color |
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
View SourceDispose(DisposeTypes)
Dispose Slider.
Declaration
protected override void Dispose(DisposeTypes type)
Parameters
| Type | Name | Description |
|---|---|---|
| DisposeTypes | type | Dispose type. |
Overrides
View SourceOnEnabled(bool)
Internal callback of enabled property changes. Inherited view can override this method to implements enabled property changes.
Declaration
protected override void OnEnabled(bool enabled)
Parameters
| Type | Name | Description |
|---|---|---|
| bool | enabled |
Overrides
View SourceOnFocusGained()
Focus gained callback.
Declaration
public override void OnFocusGained()
Overrides
View SourceOnFocusLost()
Focus Lost callback.
Declaration
public override void OnFocusLost()
Overrides
View SourceOnInitialize()
Initialize AT-SPI object.
Declaration
public override void OnInitialize()
Overrides
View SourceOnKey(Key)
Called after a key event is received by the view that has had its focus set.
Declaration
public override bool OnKey(Key key)
Parameters
| Type | Name | Description |
|---|---|---|
| Key | key | The key event. |
Returns
| Type | Description |
|---|---|
| bool | True if the key event should be consumed. |
Overrides
View SourceOnKeyboardEnter()
This method is called when the control has enter pressed on it.
Derived classes should override this to perform custom actions.
Declaration
public override bool OnKeyboardEnter()
Returns
| Type | Description |
|---|---|
| bool | True if this control supported this action. |
Overrides
View SourceOnUpdate()
Update Slider by style.
Declaration
protected override void OnUpdate()
Overrides
Events
View SourceSlidingFinished
The sliding finished event handler.
Declaration
public event EventHandler<SliderSlidingFinishedEventArgs> SlidingFinished
Event Type
| Type | Description |
|---|---|
| EventHandler<><SliderSlidingFinishedEventArgs> |
SlidingStarted
The sliding started event handler.
Declaration
public event EventHandler<SliderSlidingStartedEventArgs> SlidingStarted
Event Type
| Type | Description |
|---|---|
| EventHandler<><SliderSlidingStartedEventArgs> |
ValueChanged
The value changed event handler.
Declaration
public event EventHandler<SliderValueChangedEventArgs> ValueChanged
Event Type
| Type | Description |
|---|---|
| EventHandler<><SliderValueChangedEventArgs> |
Explicit Interface Implementations
View SourceIAtspiValue.AccessibilityGetCurrent()
Gets the current value for Accessibility.
Declaration
double IAtspiValue.AccessibilityGetCurrent()
Returns
| Type | Description |
|---|---|
| double |
IAtspiValue.AccessibilityGetMaximum()
Gets maximum value for Accessibility.
Declaration
double IAtspiValue.AccessibilityGetMaximum()
Returns
| Type | Description |
|---|---|
| double |
IAtspiValue.AccessibilityGetMinimum()
Gets minimum value for Accessibility.
Declaration
double IAtspiValue.AccessibilityGetMinimum()
Returns
| Type | Description |
|---|---|
| double |
IAtspiValue.AccessibilityGetMinimumIncrement()
Gets minimum increment for Accessibility.
Declaration
double IAtspiValue.AccessibilityGetMinimumIncrement()
Returns
| Type | Description |
|---|---|
| double |
IAtspiValue.AccessibilityGetValueText()
Formatted current value.
Declaration
string IAtspiValue.AccessibilityGetValueText()
Returns
| Type | Description |
|---|---|
| string |
IAtspiValue.AccessibilitySetCurrent(double)
Sets the current value using Accessibility.
Declaration
bool IAtspiValue.AccessibilitySetCurrent(double value)
Parameters
| Type | Name | Description |
|---|---|---|
| double | value |
Returns
| Type | Description |
|---|---|
| bool |